Page MenuHomeFreeBSD

iwx.4: Initial manual page
Needs ReviewPublic

Authored by ziaee on Sun, Apr 6, 6:16 PM.

Details

Reviewers
carlavilla
mhorne
bz
thj
Group Reviewers
wireless
manpages
Summary

Import manual from OpenBSD, tweaked for our system.

Please look over this very carefully!

Obtained from: OpenBSD

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 63363
Build 60247: arc lint + arc unit

Event Timeline

ziaee requested review of this revision.Sun, Apr 6, 6:16 PM
share/man/man4/Makefile
717

This needs to be in the commit message

share/man/man4/iwx.4
26
bz requested changes to this revision.Sun, Apr 6, 6:42 PM
bz added a reviewer: thj.
bz added a subscriber: bz.
bz added inline comments.
share/man/man4/Makefile
717

unrelated

share/man/man4/iwx.4
34

Is this kld_list needed? devmatch should auto-load it -- unless there are no PNP entries in the driver -- then that should be fixed in iwx(4)

133

We normally don't list the firmware files anymore.
It would also for most need two of these files: a ucode and a pnvm file.

139

Please fix this paragraph.

It really should just point people at fwget(8) which will install the wifi-firmware-iwlwifi flavored packages automatically. The above is OpenBSD language; FreeBSD does/did (beofre fgwet) ship the firmware in base.

This revision now requires changes to proceed.Sun, Apr 6, 6:42 PM
ziaee marked an inline comment as done.

+ remove unrelated sorting fix, I just wanted to fix it without churn.
+ increase document description consistency
+ explain how the driver loads automatically immediately
+ explain how the firmware is obtained in files
+ remove crypto offload mentions, the import review said that's TODO
+ mention Haiku in history
+ improve see also
+ improve background mode structure

is this kld_list needed?

Not normally, but normally nothing is needed. I attempted to explain
that better in the description, while preserving traditional synopsis
showing that how you can load it manually. If compiling a non-generic
kernel, the synopsis shows how you can compile it in, or load it with
rc.conf manually, maybe because they aren't using devmatch.

Thank you so much for helping!

emaste added inline comments.
share/man/man4/Makefile
268

where is _iwx.4 getting set?

Thanks emaste! I don't actually know, but I thought that's the syntax for "include this manual only if this driver is compiled".

@ziaee ok, look at the existing examples then, further down in this file - e.g.:

.if ${MACHINE_CPUARCH} == "amd64" || ${MACHINE_CPUARCH} == "i386"
_acpi_asus.4=   acpi_asus.4

Attempt to fix iwx.4 Makefile based on this appears to be only for amd64 in sys/modules/Makefile

Remove one of the newlines in description,
I decided I don't really like it.