wifi manuals: Mlink + document description consistency
ClosedPublic
Actions

Authored by ziaee on Feb 19 2025, 4:00 PM.

Details

Reviewers

carlavilla
mhorne
bz

Group Reviewers

manpages
wireless

Commits

rG970d9b5d304c: wifi manuals: Mlink + document description consistency
rG4262dbc57982: wifi manuals: Mlink + document description consistency

Summary

Interfaces all have an mlink to if_$foo. Add these for the missing ones
and remove an incorrect one from rtwn_pci. Wireless network drivers are
all accessible via `apropos -s4 "wireless network driver", except two
which are "wireless network device". I actually prefer the latter, but
make them all consistent upon the more common parlance. Tag SPDX on one
of the files I touched, while here.

MFC after: 3 days

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 62522
Build 59406: arc lint + arc unit

Event Timeline

ziaee created this revision.Feb 19 2025, 4:00 PM

Herald added a subscriber: imp. · View Herald TranscriptFeb 19 2025, 4:00 PM

ziaee requested review of this revision.Feb 19 2025, 4:00 PM

Harbormaster completed remote builds in B62522: Diff 151198.Feb 19 2025, 4:00 PM

Do we update .Dd for these changes as well?

share/man/man4/uath.4
1	First line gets a - `.\"-` I believe while you are one it. See man 9 style.

Normally a document description change does bump the Nd, but I didn't because it was just a few letters to make it more consistent. This might be wrong though.

The - in the first line was something Warner did for a project that he abandoned, so lately we haven't been using them. I have some revisions open to fix the recommendations, but then need a few more OKs to merge:

https://reviews.freebsd.org/D48345 (license article)
https://reviews.freebsd.org/D49051 (style.9)

And I believe there's something in the handbook I have to find and update as well.

In D49063#1119855, @ziaee wrote:

Normally a document description change does bump the Nd, but I didn't because it was just a few letters to make it more consistent. This might be wrong though.

.Dd in the past was bumped so that people translating man pages would know there is a newer version. I have no clue how much of that still is a thing?

bz accepted this revision.Feb 22 2025, 10:27 PM

bz added inline comments.