Page MenuHomeFreeBSD

wifi manuals: Mlink + document description consistency
ClosedPublic

Authored by ziaee on Feb 19 2025, 4:00 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, May 21, 8:28 AM
Unknown Object (File)
Tue, May 19, 9:52 PM
Unknown Object (File)
Wed, May 13, 4:20 PM
Unknown Object (File)
Tue, May 12, 5:42 PM
Unknown Object (File)
Tue, May 12, 2:47 PM
Unknown Object (File)
Apr 15 2026, 8:10 PM
Unknown Object (File)
Apr 14 2026, 2:44 AM
Unknown Object (File)
Apr 13 2026, 11:51 PM
Subscribers

Details

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 Not Applicable
Unit
Tests Not Applicable

Event Timeline

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

Do we update .Dd for these changes as well?

share/man/man4/uath.4
1–3

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.

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 added inline comments.
share/man/man4/uath.4
1–3

Overcome by events.

This revision is now accepted and ready to land.Feb 22 2025, 10:27 PM
emaste added inline comments.
share/man/man4/Makefile
767