Page MenuHomeFreeBSD
Differential D33394

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

Authored by 0mp on Dec 12 2021, 10:44 PM.
Tags
None
Referenced Files
Unknown Object (File)
Wed, Dec 4, 8:24 PM
Unknown Object (File)
Wed, Dec 4, 8:24 PM
Unknown Object (File)
Wed, Dec 4, 8:24 PM
Unknown Object (File)
Wed, Dec 4, 8:00 PM
Unknown Object (File)
Nov 15 2024, 1:25 AM
Unknown Object (File)
Nov 14 2024, 10:11 PM
Unknown Object (File)
Oct 23 2024, 9:27 PM
Unknown Object (File)
Sep 16 2024, 12:17 PM
View All 52 Files
Subscribers
bjk
imp

Details

Reviewers
debdrup
Group Reviewers
manpages
Commits
rG5ae48f972aa6: style.mdoc.5: Document the conventions for -width
rG79afae3b3f24: style.mdoc.5: Document the conventions for -width
Summary

MFC after: 1 week

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 43299
Build 40187: arc lint + arc unit

Event Timeline

0mp created this revision.Dec 12 2021, 10:44 PM
Herald added a reviewer: manpages. · View Herald TranscriptDec 12 2021, 10:44 PM
Herald added a subscriber: imp. · View Herald Transcript
0mp requested review of this revision.Dec 12 2021, 10:44 PM
Harbormaster completed remote builds in B43299: Diff 99890.Dec 12 2021, 10:45 PM
0mp mentioned this in D33385: intro(3): Fix formatting.Dec 12 2021, 10:45 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?).

debdrup accepted this revision.Dec 12 2021, 11:39 PM
This revision is now accepted and ready to land.Dec 12 2021, 11:39 PM
debdrup added a comment.Dec 12 2021, 11:40 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 a subscriber: bjk.Dec 13 2021, 2:50 AM
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?

Closed by commit rG79afae3b3f24: style.mdoc.5: Document the conventions for -width (authored by 0mp). · Explain WhyJan 29 2022, 9:25 PM
This revision was automatically updated to reflect the committed changes.
0mp added a commit: rG79afae3b3f24: style.mdoc.5: Document the conventions for -width.
0mp added a comment.Jan 29 2022, 9:25 PM
In D33394#755041, @debdrup wrote:
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...

0mp added inline comments.Jan 29 2022, 9:27 PM
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.

0mp added a comment.Jan 29 2022, 9:27 PM

Thanks a lot for reviewing the change!

0mp added a commit: rG5ae48f972aa6: style.mdoc.5: Document the conventions for -width.Feb 12 2022, 4:07 PM

Revision Contents
Changeset List

PathSize
share/
man/
man5/
38 lines

Diff 99890

View Options

share/man/man5/style.mdoc.5

Loading...