Page MenuHomeFreeBSD

Improve sndstat man page
ClosedPublic

Authored by meka_tilda.center on Apr 28 2021, 1:53 PM.

Details

Summary

Just better wording.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

meka_tilda.center created this revision.
share/man/man4/sndstat.4
54

Since some of the ioctl calls do not take arguments, I suggests "for ioctl calls that takes an argument, the following structure is used:"

62–63
The
.Fa buf
field points to a buffer containing a packed nvlist. The
.Fa nbytes
field indicates the size of the packed nvlist if a packed nvlist is to be submitted to the subsystem, or the size of the buffer if a packed nvlist is to be retrieved from the subsystem.

And for explaining what nvlist is we should leave that to nv(9).

Update the patch with suggestions by Ka Ho Ng. Sorry it took so much time (vaccine problems), and forgive me if I do something wrong on reviews as it is the first time I'm using it.

bjk added inline comments.
share/man/man4/sndstat.4
50

Start the new sentence on a new line.

62

I think "objects" plural (though there's not quite enough context posted to be sure). There's a singular/plural mismatch -- we want either "an nvlist object" of "nvlist objects"

meka_tilda.center marked 2 inline comments as done.

As only one object from nvlist is explained, I decided to go with "an nvlist object".

Other than this small nit, I'm fine with the change.

share/man/man4/sndstat.4
50

Seems like an extra whitespace was added after the sentence stop here.

meka_tilda.center marked 2 inline comments as done.

Nitpicking is good, it keeps docs perfect.

This revision is now accepted and ready to land.May 5 2021, 2:24 PM
This revision was automatically updated to reflect the committed changes.