The Release Hardware Notes are generated from hardware sections in the manual pages. Create or organize these sections in Wi-Fi driver manuals for information flow, and perform minor maintenance on them while here. After some testing, we have determined that a compact column list is the best for a single column listing in the hardware release notes. This makes very clean subsections and is for some reason denser than using a tagged list. This adds the long requested conversion from netmask to cidr examples. These examples probably shouldn't even be here, but that is a discussion for another day. MFC after: 3 days (to BETA2, I know, sorry I didn't do it sooner) Reported by: bz (relnotes generation, cidr, test-net-1 ip4addr) Reported by: grahamperrin (HARDWARE order mentioned in fdp-primer) Reported by: Graham Percival <gperciva@tarsnap.com> (don't prompt)
Details
Details
Evaluate very carefully.
One could mandoc -Tlint (I have done this everywhere)
View the pages in man(1) and more(1)
Consider https://www.freebsd.org/releases/14.2R/hardware/
Sure hope I didn't miss any spots.
Diff Detail
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Skipped - Unit
Tests Skipped
Event Timeline
Comment Actions
Once this is settled, I'll begin writing a section in style.mdoc(5) describing preferred style for hardware section in manuals, so we can make it more consistent going forward.
Comment Actions
I did miss a spot.
The table in urtw looked ever so slightly off, turns out the syntax was completely wrong (e.g. mdoc(7) says mdoc files should never have a tab for any reason, but the linter didn't see that.
Also, every network device driver manual afaik uses driver in the title, except a few, so fix those.
Comment Actions
If you do not use arc diff --create/--update please upload a diff -U9999 so that there is context to be displayed.
I went through once; minor adjustments I've done (sorry if I screwed something up) for the sake of getting this in (they are all marked in the review).
| share/man/man4/iwlwifi.4 | ||
|---|---|---|
| 167 | Why are we losing this line? I'll re-add it before committing. If there is a good reason I need to adjust the scripts (which I should do anyway). | |
| share/man/man4/mt7915.4 | ||
| 62 | No context; check if it has the derived text as well and adjust accordingly (see mt7921). | |
| 107 | XXX-BZ I should write the linuxkpi_wlan man page and we summarize this all there instead of replicating it in every driver. | |
| share/man/man4/rtwn.4 | ||
| 225 | This is history and should stay. | |
| share/man/man4/rtwn_pci.4 | ||
| 72 | The PCI part only seems to support: The last two need to go. | |
| share/man/man4/rtwn_usb.4 | ||
| 61–62 | based on certain | |