Page MenuHomeFreeBSD

Initial clean up the language in the manual pages.
ClosedPublic

Authored by gnn on Nov 12 2021, 9:12 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Apr 11, 1:47 PM
Unknown Object (File)
Thu, Apr 11, 12:43 PM
Unknown Object (File)
Fri, Mar 22, 3:16 PM
Unknown Object (File)
Fri, Mar 22, 3:16 PM
Unknown Object (File)
Mar 13 2024, 2:43 AM
Unknown Object (File)
Feb 19 2024, 1:39 AM
Unknown Object (File)
Jan 14 2024, 4:41 PM
Unknown Object (File)
Dec 22 2023, 11:09 PM
Subscribers

Details

Summary

The manual pages need a bit of editing for language and clarity.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

gnn requested review of this revision.Nov 12 2021, 9:12 PM
0mp requested changes to this revision.Nov 12 2021, 11:04 PM
0mp added a subscriber: 0mp.
0mp added inline comments.
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.

This revision now requires changes to proceed.Nov 12 2021, 11:04 PM

Also, to channel bcr:
Remember to bump .Dd :)

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 Casper daemon may create a socket using cap_init and you also can obtain this descriptor.
Maybe something like:

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.

gnn marked 8 inline comments as done.Nov 15 2021, 5:32 PM
gnn marked an inline comment as done.
  • Address review comments from 0mp, debdrup and oshogbo
0mp requested changes to this revision.Nov 16 2021, 8:49 AM
0mp added inline comments.
lib/libcasper/libcasper/libcasper.3
118

The word *uses* disappeared in the process.

147
lib/libcasper/libcasper/libcasper_service.3
63–64

How about?

where the first argument of the function contains an 
.Xr nvlist 9
of old service limits
and the second argument contains the new limits
This revision now requires changes to proceed.Nov 16 2021, 8:49 AM
gnn marked 3 inline comments as done.Nov 16 2021, 1:42 PM
  • Fix two more nits from 0mp

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.

This revision was not accepted when it landed; it landed in state Needs Review.Nov 16 2021, 2:01 PM
This revision was automatically updated to reflect the committed changes.