Provide more useful explanation of features and quirks.
The BUGS section is removed, I cannot get any sense of the sentence.
Details
Details
- Reviewers
emaste vangyzen - Group Reviewers
manpages - Commits
- rS312648: Editing and clarifications for tmpfs(5).
rS312423: Refresh tmpfs(5) man page.
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
Comment Actions
I guess the BUGS section means that many common -o options are unimplemented or do not work correctly?
| share/man/man5/tmpfs.5 | ||
|---|---|---|
| 83 ↗ | (On Diff #24111) | "in main memory" |
| 84 ↗ | (On Diff #24111) | Would split into separate sentences. Something along the lines of "the data. The data is volatile. An umount or system reboot invalidates it." |
| 87 ↗ | (On Diff #24111) | These properties |
| 91–92 ↗ | (On Diff #24111) | This seems awkward to me - I would say "on memory and swap is configured (see .Xr swapin 8)", but I'm not sure if that's canonical in our man pages. Maybe @wblock has a suggestion. |
| 93 ↗ | (On Diff #24111) | here just "written to swap" or "written to the swap space" or partition etc. |
| 95 ↗ | (On Diff #24111) | The current implementation |
| 96 ↗ | (On Diff #24111) | This can be a separate sentence. "content. Keep this" |
| 99 ↗ | (On Diff #24111) | "When a file from a tmpfs mount" perhaps |
| 104 ↗ | (On Diff #24111) | pages is used |
Comment Actions
I think this is good (with a few additional comments), but probably allow the manpages group a short while to comment.
| share/man/man5/tmpfs.5 | ||
|---|---|---|
| 98 ↗ | (On Diff #24116) | 'a' still missing (a lot), but probably "place many small files" is better. |
| 165 ↗ | (On Diff #24116) | we should expand this SoC too, "Summer of Code" |
| head/share/man/man5/tmpfs.5 | ||
|---|---|---|
| 80 | Needs an article: s/implements/implements an/ | |
| 86 | s/An/A/ | |
| 88 | Unless other parts of the document are in Latin also, avoid Latin abbreviations: scratch storage, like | |
| 93 | The "may" here is ambiguous. Does it mean I have permission to do it? Yet "might" is not right either. Probably better to make the sentence more specific: the system can transfer file data to swap space, freeing memory | |
| 95 | Rearrange for clarity: Metadata, including the directory content, is never swapped out by the current implementation. "directory content" can be read several ways. Surely directory metadata, but a reader could take that to mean "files in a directory". | |
| 98 | Maybe s/on/in/, although it's arguable. | |
| 104 | This is a long and complex sentence. Eliminating the aside helps a bit: When .Xr mmap 2 is used on a file from a tmpfs mount, the swap VM object managing the file pages is used to implement mapping and avoid double-copying of the file data. | |
| head/share/man/man5/tmpfs.5 | ||
|---|---|---|
| 86 | Oh, I read this as "An unmount," not a reference to umount(8). | |