Page MenuHomeFreeBSD
Differential D48343

style.mdoc: HARDWARE generates Release Notes
ClosedPublic
Actions

Authored by ziaee on Jan 6 2025, 8:52 PM.
Tags
None
Referenced Files
F133200240: D48343.id152546.diff
Thu, Oct 23, 10:08 PM
Unknown Object (File)
Sun, Oct 19, 12:19 AM
Unknown Object (File)
Sat, Oct 18, 1:44 AM
Unknown Object (File)
Fri, Oct 17, 12:04 AM
Unknown Object (File)
Thu, Sep 25, 2:42 AM
Unknown Object (File)
Wed, Sep 24, 8:55 AM
Unknown Object (File)
Sep 13 2025, 11:28 PM
Unknown Object (File)
Sep 12 2025, 8:46 PM
View All 97 Files
Subscribers
bz
pauamma_gundo.com
rpokala

Details

Reviewers
mhorne
carlavilla
imp
0mp
Group Reviewers
manpages
doceng
docs
Commits
rGb0d6aa07c193: style.mdoc: HARDWARE generates Release Notes
rG29eb4de61a4c: style.mdoc: HARDWARE generates Release Notes
Summary

FreeBSD Release Infrastructure has been building the Hardware
Release Notes from these subsections in the Kernel Interfaces Manual.
Standardize this behavior in the FreeBSD Manual page style guide with
everything we learned in the 14.2-RELEASE.

To me, this is an enormously exciting discovery, and I believe that
over the next 5 years, this can transform the supported hardware UX,
without reinventing the wheel, by doubling down on our ways instead
of reinventing them.

Reported by: bz (special thanks)
MFC after: 3 days

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ziaee created this revision.Jan 6 2025, 8:52 PM
Herald added a subscriber: imp. · View Herald TranscriptJan 6 2025, 8:52 PM
ziaee requested review of this revision.Jan 6 2025, 8:52 PM
Harbormaster completed remote builds in B61525: Diff 148832.Jan 6 2025, 8:52 PM
rpokala added a subscriber: rpokala.Jan 6 2025, 9:05 PM
rpokala added inline comments.
share/man/man5/style.mdoc.5
85
ziaee updated this revision to Diff 148836.Jan 6 2025, 9:10 PM

Fix sentence typo, thanks @rpokala!

Harbormaster completed remote builds in B61528: Diff 148836.Jan 6 2025, 9:10 PM
ziaee marked an inline comment as done.Jan 6 2025, 9:11 PM
pauamma_gundo.com added a subscriber: pauamma_gundo.com.Jan 6 2025, 9:16 PM
pauamma_gundo.com added inline comments.
share/man/man5/style.mdoc.5
97
ziaee updated this revision to Diff 148837.Jan 6 2025, 9:19 PM

Fix acquire typo, thanks @pauamma!

Harbormaster completed remote builds in B61529: Diff 148837.Jan 6 2025, 9:19 PM
ziaee marked an inline comment as done.Jan 6 2025, 9:20 PM
ziaee edited subscribers, added: bz; removed: imp.

Also cc'ing bz

imp accepted this revision.Jan 6 2025, 10:53 PM
This revision is now accepted and ready to land.Jan 6 2025, 10:53 PM
imp added a comment.Jan 6 2025, 10:53 PM

We need a new driver integration checklist. And this item in the man page section should be on it.

ziaee mentioned this in D48167: Introduce the USB umb(4) network driver.Jan 8 2025, 9:20 PM
ziaee added a comment.Mar 1 2025, 2:33 AM

Mew

mhorne accepted this revision as: mhorne.Mar 21 2025, 2:57 PM
mhorne added a reviewer: 0mp.

LGTM, and Approved.

Closed by commit rG29eb4de61a4c: style.mdoc: HARDWARE generates Release Notes (authored by ziaee). · Explain WhyMar 23 2025, 4:58 AM
This revision was automatically updated to reflect the committed changes.
ziaee added a commit: rG29eb4de61a4c: style.mdoc: HARDWARE generates Release Notes.
ziaee added a commit: rGb0d6aa07c193: style.mdoc: HARDWARE generates Release Notes.Mar 26 2025, 5:43 AM

Revision Contents
Changeset List

PathSize
share/
man/
man5/
31 lines

Diff 152546

View Options

share/man/man5/style.mdoc.5

Loading...