Page MenuHomeFreeBSD

membarrier: Add initial manual page
ClosedPublic

Authored by emaste on Oct 6 2024, 5:48 PM.
Tags
None
Referenced Files
F107623461: D46967.diff
Thu, Jan 16, 7:52 PM
Unknown Object (File)
Fri, Jan 10, 7:37 AM
Unknown Object (File)
Wed, Jan 8, 6:53 PM
Unknown Object (File)
Sun, Jan 5, 10:25 AM
Unknown Object (File)
Mon, Dec 30, 9:02 PM
Unknown Object (File)
Dec 14 2024, 2:16 AM
Unknown Object (File)
Dec 10 2024, 11:55 PM
Unknown Object (File)
Dec 4 2024, 1:27 AM

Diff Detail

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

Event Timeline

emaste requested review of this revision.Oct 6 2024, 5:48 PM
emaste created this revision.

Structure based on @markj's kcmp man page

lib/libsys/membarrier.2
52

The table renders pretty poorly because of this, will need to make it instead

MEMBARRIER_CMD_QUERY
        Query supported commands. ...

MEMBARRIER_CMD_GLOBAL
        Alias for ...
lib/libsys/membarrier.2
81
This revision is now accepted and ready to land.Oct 6 2024, 10:42 PM

mdoc fixup. I'll commit this and iterate on it in the tree if necessary.

This revision now requires review to proceed.Oct 6 2024, 11:10 PM
This revision was not accepted when it landed; it landed in state Needs Review.Oct 6 2024, 11:45 PM
This revision was automatically updated to reflect the committed changes.

Would it be possible to have all the cmds sorted alphabetically?
Only MEMBARRIER_CMD_SHARED references another cmd, but that one (MEMBARRIER_CMD_GLOBAL) will be presented earlier if cmds are sorted.

lib/libsys/membarrier.2
63

Missing final period (".") at the end of the paragraph

105

Maybe .Fa cmd since cmd is an actual argument?

Would it be possible to have all the cmds sorted alphabetically?

They're currently in order of their bit position, but they could be alphabetical instead. I'll take a look,

lib/libsys/membarrier.2
105

Yes and presumably a Dv to follow

.Fa cmd
is
.Dv MEMBARRIER_CMD_QUERY
a bitmask...

Would it be possible to have all the cmds sorted alphabetically?

I decided not to do this, because they're in a somewhat logical order now. It would be odd to put MEMBARRIER_CMD_QUERY between other commands, it should be either first or last. Then there are a number of them that are paired, the CMD_REGISTER_foo and CMD_foo.