Page MenuHomeFreeBSD

linuxkpi_wlan.4: migrate more details into the common man page
Needs ReviewPublic

Authored by bz on Fri, Oct 2, 7:38 PM.

Details

Reviewers
ziaee
Summary

All the LinuxKPI base wireless drivers had the same texts in each
man page only with the driver name changed.
Try to migrate most of the common texts into linuxkpi_wlan.4 leaving
only a minimalistic paragraph pointing there.

This also moves descriptive texts out of the SYNOPSIS section [1],
which has now become entirely removed for the drivers.

Add .Lk to the bug hierarchies we are trying to keep for all of the
drivers, as we did for iwlwifi.4 before.

iwlwififw.4 is now orphaned and removed (as indicated before given
automatic generation of the file is no longer possible or hightly
inaccurate).

Suggested by: ziaee (in D58479)
MFC after: 3 days

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 77660
Build 74543: arc lint + arc unit

Event Timeline

bz requested review of this revision.Fri, Oct 2, 7:38 PM

This is not ideal yet and I hope you can help me to get it polished and move things in the right place but it feels a lot better (at least to me) having one source of truth rather than (n+1) man pages with a copy of the (longer) text.

share/man/man4/linuxkpi_wlan.4
27

Probably shouldn't be an Xr

81

Not sure how to better express this.