Page MenuHomeFreeBSD

Move the possible event types into a column table to make it easier to read.

Authored by imp on Aug 18 2020, 5:00 PM.

Diff Detail

rS FreeBSD src repository - subversion
Automatic diff as part of commit; lint not applicable.
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

imp requested review of this revision.Aug 18 2020, 5:00 PM
jhb added inline comments.
329 ↗(On Diff #75952)

It seems like '-compact' needs to come before the columns from mdoc(7)? For whatever reason, the pattern in siginfo.3 and sigevent.3 is also to omit the final column.

330 ↗(On Diff #75952)

siginfo(3)/sigevent(3) use Sy (bold) rather than Em (italic) for column headings FWIW.

0mp added a subscriber: 0mp.

Formatting seems good to me :) I've checked both mdoc and HTML outputs.

509 ↗(On Diff #75952)

This is a bug fix, right?

This revision is now accepted and ready to land.Aug 18 2020, 5:39 PM
330 ↗(On Diff #75952)

+1, this might further improve navigating around the manual page.

This revision now requires review to proceed.Aug 18 2020, 6:53 PM
329 ↗(On Diff #75952)

The manual list -type first (-column is the type) and -compact last in the synopsis. It gives no admonition that it must be first. A quick google search doesn't turn it up either. And none of the man pages in the source tree do that either. I don't see that either siginfo.3 or sigevent.3 use -compact... I'll keep it last...

But I can get 2 more characters from Description if I remove trailing white space in System and Subsystem headings. I can get away w/o having the final column arg, so I'll do that.

330 ↗(On Diff #75952)

Sure. Easy enough.

imp marked 4 inline comments as done.Aug 18 2020, 6:59 PM
imp added inline comments.
509 ↗(On Diff #75952)

Yes. Added a comment to the commit message.

This revision was not accepted when it landed; it landed in state Needs Review.Aug 18 2020, 9:27 PM
This revision was automatically updated to reflect the committed changes.
imp marked an inline comment as done.
329 ↗(On Diff #75952)

I was referring to this part of the mdoc(7) manual:

Bl -type [-width val] [-offset val] [-compact] [col ...]
     Begin a list.  Lists consist of items specified using the It macro,
     containing a head or a body or both.

Clearly, the optional list of columns [col ...] comes after the optional -compact. I was worried that If the parser was like getopt(3) it would assuming all tokens after the first one that doesn't start with - are column widths, thus treating -compact as a column width. However, it seems like the parser doesn't work like that since it does seem to render the same both ways.