man.4: Add .Sh HARDWARE for some wireless drivers for release notes
Needs ReviewPublic
Actions

Authored by bz on Mon, Sep 30, 8:09 PM.

Details

Reviewers

Group Reviewers

Summary

iwlwifi.4 and rtw88.4 did not show up in the hardware list in the
release notes for 13.4.
The doc/website/tools/hardware-notes-processor.rb script parses
the .Sh HARDWARE section to automagically create a note once the
manual page is listed in the website/archetypes/release/hardware.adoc
file.

While here update the other committed man pages not yet connected
to the build.

Reported by: re (cperciva), grahamperrin
Sponsored by: The FreeBSD Foundation
MFC after: 3 days

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 59660
Build 56547: arc lint + arc unit

Event Timeline

bz created this revision.Mon, Sep 30, 8:09 PM

Herald added a subscriber: imp. · View Herald TranscriptMon, Sep 30, 8:09 PM

bz requested review of this revision.Mon, Sep 30, 8:09 PM

Harbormaster completed remote builds in B59660: Diff 144059.Mon, Sep 30, 8:09 PM

The doc/website/tools/hardware-notes-processor.rb script parses the .Sh HARDWARE section to automagically create a note once the manual page is listed in the website/archetypes/release/hardware.adoc file.

This is extremely significant news to me. HARDWARE is not a standard section in mdoc(7) or mentioned in style.mdoc(5). The linter (at least used to) complains about non-standard sections. I will work on this.

In D46851#1068386, @concussious.bugzilla_runbox.com wrote:

The doc/website/tools/hardware-notes-processor.rb script parses the .Sh HARDWARE section to automagically create a note once the manual page is listed in the website/archetypes/release/hardware.adoc file.

This is extremely significant news to me. HARDWARE is not a standard section in mdoc(7) or mentioned in style.mdoc(5). The linter (at least used to) complains about non-standard sections. I will work on this.

That is something I had mentioned to Colin and grahamperrin as well (lack of documentation in mdoc(7)).
I'll be more than happy if this and whatever tools people use for man pages grow knowledge of it after about 20 years.

I haven;t dug into it but I wonder what the old scripts in the doc/website repo did to extract the changes as there would likely have been the history of a lot of this. @brueffer @simon @trhodes are the people I have on my mind when it comes to this. Maybe someone is reading here still and can shed some light.

I'll be more than happy if this and whatever tools people use for man pages grow knowledge of it after about 20 years.

I am working on manual pages every week for the past year and have no intentions to stop. I will ask on mandoc-tech and see if the mandoc lead is willing to accept this into the standard and mdoc(7). If not, I will submit a github PR to style.mdoc(5) and cc everyone ITT, unless there are any objections. Thank you so much.

In D46851#1068386, @concussious.bugzilla_runbox.com wrote:

The doc/website/tools/hardware-notes-processor.rb script parses the .Sh HARDWARE section to automagically create a note once the manual page is listed in the website/archetypes/release/hardware.adoc file.

This is extremely significant news to me. HARDWARE is not a standard section in mdoc(7) or mentioned in style.mdoc(5). The linter (at least used to) complains about non-standard sections. I will work on this.

Thank you! I only became aware of this recently when I started doing releases and had to put the website bits together. This particular ruby script was committed by @carlavilla in 2021 but it's entirely possible that it replaced an older script -- it arrived as part of a commit "Use Hugo Archetype to generate new releases".