Paths

Table of Contentst

Differential D54586

mdoc: Standardize SYNOPISIS section for drivers
Needs ReviewPublic
Actions

Authored by ziaee on Jan 7 2026, 8:42 PM.

Tags

None

Referenced Files

	F152930561: D54586.diff
	Sat, Apr 18, 3:41 AM

	Unknown Object (File)
	Thu, Apr 16, 5:18 AM

	Unknown Object (File)
	Wed, Apr 15, 1:54 PM

	Unknown Object (File)
	Tue, Apr 14, 10:31 PM

	Unknown Object (File)
	Sun, Apr 5, 3:33 PM

	Unknown Object (File)
	Sat, Apr 4, 3:10 PM

	Unknown Object (File)
	Sat, Apr 4, 12:02 AM

	Unknown Object (File)
	Thu, Mar 26, 10:34 AM

View All 25 Files

Subscribers

This revision needs review, but there are no reviewers specified.

Details

Reviewers: None

Summary

Standardize driver manuals on the style used for 12 years in vt(4).
This brings SYNOPSIS across all FreeBSD manual sections into harmony
of meaning where where SYNOPSIS lists available options, and does not
contain prose. Adjust mdoc(7) to reflect the established convention.

https://marc.info/?l=freebsd-arch&m=176782215606871

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 70431
Build 67314: arc lint + arc unit

Event Timeline

ziaee created this revision.Jan 7 2026, 8:42 PM

Herald added a subscriber: imp. · View Herald TranscriptJan 7 2026, 8:42 PM

ziaee requested review of this revision.Jan 7 2026, 8:42 PM

Harbormaster completed remote builds in B69699: Diff 169270.Jan 7 2026, 8:42 PM

make mdoc(7) a bit clearer

Harbormaster completed remote builds in B69700: Diff 169271.Jan 7 2026, 8:50 PM

jlduran added a subscriber: jlduran.Jan 8 2026, 6:24 AM

jlduran added inline comments.

contrib/mandoc/mdoc.7
1187	FreeBSD -> `.Fx`

+ demonstrate some pages use optional values in synopsis
+ use the freebsd macro instead of typing freebsd

Harbormaster completed remote builds in B70431: Diff 171224.Feb 5 2026, 2:58 PM

ziaee retitled this revision from mdoc: SYNOPISIS should not have prose to mdoc: Standardize SYNOPISIS section for drivers.Tue, Apr 14, 7:09 PM

ziaee edited the summary of this revision. (Show Details)

update to incorporate device.hints

Harbormaster completed remote builds in B72207: Diff 175520.Tue, Apr 14, 7:11 PM

ziaee edited the summary of this revision. (Show Details)Tue, Apr 14, 7:13 PM

Revision Contents
Changeset List

Path

Size

contrib/

mandoc/

6 lines

share/

examples/

mdoc/

20 lines

Diff 171224

contrib/mandoc/mdoc.7

Loading...

share/examples/mdoc/example.4

Loading...