Fixes: c14b016242613 (importing if_mtw from OpenBSD)
Diff Detail
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Skipped - Unit
Tests Skipped - Build Status
Buildable 62322 Build 59206: arc lint + arc unit
Event Timeline
Comment Actions
capitalized t in MediaTek, added "IEEE 802.11n" to Dd to match other
wireless network drivers.
Comment Actions
Add synopsis and sysctl variables, markup station and monitor as command
modifiers like in other manuals, add USB to document description, add
Reported by: adrian on Community Discord to commit message for
teaching me more about reading source to write the synopsis.
| share/man/man4/mtw.4 | ||
|---|---|---|
| 38–40 | The most beautiful case is vt(4), and a similar one is in safe(4). We use many styles, but I think this is the most useful and consistent implementation for section four for the notion of what a synopsis is in other sections of the manual. Synopsis does not describe what the stuff does or how to use it, it just shows the knobs. When you already know, you can just briefly glance at the synopsis. I think this syntax as used in vt(4) is perfect. | |
| share/man/man4/mtw.4 | ||
|---|---|---|
| 33–36 | I'm still learning more about this, but my understanding is that we're no longer recommending explicitly loading wifi drivers at early boot with loader.conf. Iiuc, only if driver autoloading is explicitly disabled, then it is recommended to put it in kld_list in rc.conf. See rtw88, rtw89, and iwlwifi. This recommendation seems very sensible to me, however I do not like how the concept of a synopsis is changing and so I have elected to not do that here. Synopsis is not meant to be paragraphs, it's a quick listing of what all the options are to just peek at quickly while you're typing. | |
Comment Actions
address reviewer feedback. In addition, I have taken the new
advice starting in newer wifi drivers, and integrated it with
my ideal of the optimum synopsis style for the Kernel Interfaces
Manual in consideration of the meaning of synopsis in the General
Commands Manual and the System Manager's Manual. Cc'ing bz for critique since he iiuc invented the new idea about loading with devmatch or rc.conf
| share/man/man4/mtw.4 | ||
|---|---|---|
| 33–36 | You are right, kld_list should be preferred here, and achieves the intended result. Thanks! I do not disagree with you about what SYNOPSIS means in the ideal sense, but there is a practical precedent within the section 4 drivers. In this scope, SYNOPSIS must answer the question: "how does one enable this driver?". Whether the boilerplate text is clumsy or not, it is widespread in these manuals. | |
| 38–40 | Very good, I agree! | |