cap_fileargs.3: Comprehensive rewrite for improved clarity and accuracy #1551
Conversation
|
Cc: @oshogbo |
kfv
force-pushed
the
kfv/docs/cap_fileargs.3
branch
2 times, most recently
from
a3caefb to
2dae25d
Compare
|
I don't think this was the commit you intended to push? |
|
How come? |
|
By the way, I’m sorry if I forgot to thank you. It’s been a tough day, and I can’t even remember how I managed to handle the changes you requested. |
The commits appear to be unchanged.
Hey, likewise. Improvements to the manual excite me. |
|
Whoops! I'll take a look in an hour. I might have missed something. |
Extensively revised the manual page with clearer phrasing, better structure, and corrected grammar throughout. Also fixed multiple typos and improved overall readability of the documentation. Signed-off-by: Faraz Vahedi <[email protected]>
kfv
force-pushed
the
kfv/docs/cap_fileargs.3
branch
from
2dae25d to
9f5a2c5
Compare
|
You were right, mate. Requested changes are now pushed. Please take a look and let me know if anything else is necessary to consider and apply. |
| argument specifies whether files can be opened for execution, or for reading | ||
| and/or writing. |
There was a problem hiding this comment.
| argument specifies whether files can be opened for execution, or for reading | |
| and/or writing. | |
| argument specifies whether files can be opened for execution, for reading, | |
| and/or for writing. |
| .Dv O_CREATE | ||
| flag is present . | ||
| For more details of the | ||
| argument specifies the permissions to use when creating a new file if the |
There was a problem hiding this comment.
There might be more than one new file.
| argument specifies the permissions to use when creating a new file if the | |
| argument specifies the permissions to use when creating new files if the |
| .Sx LIMITS . | ||
| respectively, but take their arguments in the form of an | ||
| .Xr nvlist 9 | ||
| structure instead of individual parameters. |
There was a problem hiding this comment.
It's jarring to refer to the same things as both "arguments" and "parameters" in the same sentence. Also, I think the final clause is unnecessary.
| structure instead of individual parameters. | |
| structure. |
| .Va fileargs_t | ||
| structure. | ||
| structure rather than taking them directly. |
There was a problem hiding this comment.
As above, I think the extra clause is unnecessary.
| structure rather than taking them directly. | |
| structure. |
| Specifies access permissions for opened files, controlling whether they | ||
| can be either executed, or read and/or written from/to. |
There was a problem hiding this comment.
I think we can rely on the user knowing what "access permissions" are, especially because we already linked to open(2) above.
| Specifies access permissions for opened files, controlling whether they | |
| can be either executed, or read and/or written from/to. | |
| Specifies access permissions for opened files. |
| .Va operations | ||
| argument with | ||
| .Fn fileargs_init . | ||
| parameter in |
There was a problem hiding this comment.
For consistency:
| parameter in | |
| argument in |
Extensively revised the manual page with clearer phrasing, better structure, and corrected grammar throughout. Also fixed multiple typos and improved overall readability of the documentation.