mdoc.7: Cannonicalize configurations in SYNOPSIS
AbandonedPublic
Actions

Authored by ziaee on Nov 13 2025, 5:51 PM.

Details

Reviewers

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 created this revision.Nov 13 2025, 5:51 PM

Herald added a subscriber: imp. · View Herald TranscriptNov 13 2025, 5:51 PM

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

Harbormaster completed remote builds in B68614: Diff 166382.Nov 13 2025, 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.

Des says I need to change everything all at once. It will take a while, but I think this is the correct direction to move in, so I will do this.

Revision Contents
Changeset List

Path

Size

contrib/

mandoc/

mdoc.7

4 lines

Diff 166382

View Options

mdoc.7: Cannonicalize configurations in SYNOPSISAbandonedPublicActions