Page MenuHomeFreeBSD
Differential D55298

style.mdoc: Remove synopsis formatting advice
ClosedPublic
Actions

Authored by ziaee on Feb 16 2026, 6:41 AM.
Tags
None
Referenced Files
F161597053: D55298.diff
Sun, Jul 5, 5:30 AM
F161517917: D55298.diff
Sat, Jul 4, 11:50 AM
Unknown Object (File)
Mon, Jun 29, 11:19 AM
Unknown Object (File)
Sat, Jun 27, 11:09 AM
Unknown Object (File)
Fri, Jun 26, 7:19 AM
Unknown Object (File)
Thu, Jun 25, 11:26 AM
Unknown Object (File)
Tue, Jun 23, 9:25 AM
Unknown Object (File)
Sun, Jun 21, 3:11 AM
View All 59 Files
Subscribers
imp

Details

Reviewers
0mp
Group Reviewers
manpages
Commits
rG7f30d5cd3373: style.mdoc: Remove synopsis formatting advice
rG47326cb47027: style.mdoc: Remove synopsis formatting advice
Summary
  • We use a space between pipes, as even restaurant menus do.
  • The advice on using Cm is in conflict with the Cm examples in mdoc(7).

MFC after: 3 days

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 70685
Build 67568: arc lint + arc unit

Event Timeline

ziaee created this revision.Feb 16 2026, 6:41 AM
Herald added a subscriber: imp. · View Herald TranscriptFeb 16 2026, 6:41 AM
ziaee requested review of this revision.Feb 16 2026, 6:41 AM
Harbormaster completed remote builds in B70685: Diff 171951.Feb 16 2026, 6:41 AM
ziaee added a parent revision: D55297: style.mdoc: Li macro is undeprecated for some time.Feb 16 2026, 6:46 AM
ziaee added a child revision: D55299: style.mdoc: Explain why not to abuse Nm.
ziaee edited the summary of this revision. (Show Details)Feb 16 2026, 6:55 AM
ziaee added reviewers: 0mp, manpages.
ziaee added a comment.Feb 27 2026, 12:26 AM

The reason it's a problem to have this text which is in conflict with the language reference is because then people both have to read more and will be confused because we have two concurrent docs saying conflicting things.

This revision was not accepted when it landed; it landed in state Needs Review.Mar 2 2026, 11:15 AM
Closed by commit rG47326cb47027: style.mdoc: Remove synopsis formatting advice (authored by ziaee). · Explain Why
This revision was automatically updated to reflect the committed changes.
ziaee added a commit: rG47326cb47027: style.mdoc: Remove synopsis formatting advice.
ziaee added a commit: rG7f30d5cd3373: style.mdoc: Remove synopsis formatting advice.Apr 10 2026, 6:32 PM

Revision Contents
Changeset List

PathSize
share/
man/
man5/
67 lines

Diff 171951

View Options

share/man/man5/style.mdoc.5

Loading...