Page MenuHomeFreeBSD

mdoc.7: Cannonicalize configurations in SYNOPSIS
Needs ReviewPublic

Authored by ziaee on Thu, Nov 13, 5:51 PM.
Tags
None
Referenced Files
F136858546: D53741.id166382.diff
Thu, Nov 20, 4:13 AM
F136846168: D53741.id.diff
Thu, Nov 20, 1:28 AM
F136845596: D53741.diff
Thu, Nov 20, 1:20 AM
Unknown Object (File)
Mon, Nov 17, 5:53 PM
Unknown Object (File)
Mon, Nov 17, 5:53 PM
Unknown Object (File)
Mon, Nov 17, 5:43 PM
Unknown Object (File)
Sun, Nov 16, 6:57 AM
Unknown Object (File)
Fri, Nov 14, 1:45 AM
Subscribers

Details

Reviewers
0mp
Summary

This matches what has been recommended in the FDP primer, and is the
style I recommened in my talk at BSDCan '25. I have deliberately made
this minimal to preserve nuance and avoid bloating the doc, since we
already have a lot of trouble getting people to read all the different
style guides on commit messages, the language itself, the style in the
fdp primer, and the freebsd manpages style manual.

MFC after: 3 days

Diff Detail

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

Event Timeline

ziaee requested review of this revision.Thu, Nov 13, 5:51 PM

@0mp this is how I was thinking we can solve this problem without boxing ourselves into a corner.

Seems fine but would upstream accept it? What do you think?

In D53741#1227292, @0mp wrote:

Seems fine but would upstream accept it? What do you think?

Probably not like this, they might if we specify "On FreeBSD" or "not on OpenBSD". Although we are carrying patches against this file already, see the HARDWARE section.