The manual pages need a bit of editing for language and clarity.
Details
- Reviewers
oshogbo 0mp debdrup - Group Reviewers
manpages - Commits
- rG406feaa862d7: Initial clean up the language in the manual pages.
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
lib/libcasper/libcasper/libcasper.3 | ||
---|---|---|
89–90 | acacce looks like a typo | |
lib/libcasper/libcasper/libcasper_service.3 | ||
50 | In the other manual page, the name of the service seems to be consistently lowercase "casper". I'm not sure if we need to make it consistent across all manual pages. | |
61 | This sentence does not read well. "containing" does not seem to fit at all, does it? | |
64 | I think that mandoc -Tlint recommends to avoid contractions in manual pages. |
Wow, thank you, @gnn, for looking at this. I appreciate that!
lib/libcasper/libcasper/libcasper.3 | ||
---|---|---|
81 | This line is longer then 80 lines. | |
110 | and? | |
118 | This line is longer then 80, I'm not sure if this is a bug anymore. | |
126–127 | The domain socket may or may not be provided in cap_wrap. The .Fn cap_unwrap function returns the .Xr unix 4 domain socket used by the daemon service, and frees the .Vt cap_channel_t structure. | |
194 | I'm not sure what the convention is but in other cases after Oxford Comma you put a new line. |
There's only one minor nit, but otherwise it looks good to me.
lib/libcasper/libcasper/libcasper_service.3 | ||
---|---|---|
60–61 | There's a period missing at the end of this sentence. |