Page MenuHomeFreeBSD

style.mdoc.5: Document the conventions for -width
ClosedPublic

Authored by 0mp on Dec 12 2021, 10:44 PM.
Tags
None
Referenced Files
Unknown Object (File)
Jun 18 2024, 4:01 PM
Unknown Object (File)
Jun 3 2024, 3:57 PM
Unknown Object (File)
Apr 6 2024, 5:55 PM
Unknown Object (File)
Feb 3 2024, 7:58 PM
Unknown Object (File)
Jan 17 2024, 8:35 PM
Unknown Object (File)
Dec 25 2023, 5:49 PM
Unknown Object (File)
Dec 20 2023, 8:03 AM
Unknown Object (File)
Nov 23 2023, 5:23 PM
Subscribers

Diff Detail

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

Event Timeline

0mp requested review of this revision.Dec 12 2021, 10:44 PM

Perhaps it would be nice to mention that sometimes the best idea is to set -width to the longest item "of reasonable length" (less than 10 characters?).

This revision is now accepted and ready to land.Dec 12 2021, 11:39 PM
In D33394#755020, @0mp wrote:

Perhaps it would be nice to mention that sometimes the best idea is to set -width to the longest item "of reasonable length" (less than 10 characters?).

Isn't there also an intersection regarding the 80 columns thing, since manual pages live in the src tree?

bjk added inline comments.
share/man/man5/style.mdoc.5
131

Should we note that when replicating the "longest item in the list" as the -width argument, macros should be excluded?

In D33394#755020, @0mp wrote:

Perhaps it would be nice to mention that sometimes the best idea is to set -width to the longest item "of reasonable length" (less than 10 characters?).

Isn't there also an intersection regarding the 80 columns thing, since manual pages live in the src tree?

Potentially. I'm not sure how to make this connection though in the manual page...

share/man/man5/style.mdoc.5
131

This is a nice idea. In a way, it's implicitly suggested in line 133 \&.Bl -tag -width "-a address". But perhaps we can add an explicit note about this convention.

Thanks a lot for reviewing the change!