Bug 261228 - rtwnfw(4) number agreement in last sentence of first DESCRIPTION paragraph
Summary: rtwnfw(4) number agreement in last sentence of first DESCRIPTION paragraph
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-bugs (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-01-15 13:48 UTC by Pau Amma
Modified: 2025-01-30 18:11 UTC (History)
4 users (show)

See Also:


Attachments
Proposed rtwnfw(4) modification: fixes plural, removes license acknowledgement requirement (1.80 KB, patch)
2025-01-30 18:07 UTC, Eygene Ryabinkin
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Pau Amma 2022-01-15 13:48:46 UTC
"They may be statically linked into the kernel, or loaded as a modules."

Context suggests this should read "as modules", not "as a module".

Spotted while looking at https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261227.
Comment 1 Bjoern A. Zeeb freebsd_committer freebsd_triage 2022-01-15 13:53:48 UTC
For a couple of wifi drivers rtwn, iwn, iwm, ...

If you compile the driver into the kernel it's rtwn  if you compile the firmware into the kernel too it is device rtwnfw   (see sys/conf/files) and it will compile all firmware images in based on that single line.

If you compile them as modules you get one kernel object (module) per firmware image instead of one for all.

You would probably load only one module of all the firmware once in addition to the driver one.

Hope that clarifies the technicallity;  I'll leave the language to you.
Comment 2 Pau Amma 2022-01-15 23:37:55 UTC
(In reply to Bjoern A. Zeeb from comment #1)
Would "They may be statically linked into the kernel as a single unit with both the driver code and all firmware variants, or used as modules (one per firmware variant plus the driver proper) in which case only one firmware module would normally need to be loaded." work for you? I think this is what you meant, but it may be too much detail.
Comment 3 Bjoern A. Zeeb freebsd_committer freebsd_triage 2022-01-16 17:01:16 UTC
(In reply to PauAmma from comment #2)

Do we need that sentence at all given the SYNOPSIS?

Also In the synopsis or description I'd suggest when it comes to loading modules that it gets at least hinted that normally one only needs one of these firmware modules and not all (or only the ones for the chipset one has).


Lastly given I scrolled through the man page, the license ACK got disabled in 2016 by avos in 7453645f2a .
Comment 4 Graham Perrin freebsd_committer freebsd_triage 2022-01-16 17:54:36 UTC
(In reply to Bjoern A. Zeeb from comment #3)

> … normally one only needs one of these firmware modules and 
> not all (or only the ones for the chipset one has). …

+1 to hints such as this. 

(For a different driver, I confess to mistakenly (?) loading _all_ modules, for years. Synopses misunderstood. Oops.)
Comment 5 Pau Amma 2022-01-17 15:56:33 UTC
(In reply to Bjoern A. Zeeb from comment #3)

I'll leave it to you whether my suggested elaboration is needed, but either way, the number agreement should get fixed.
Comment 6 Eygene Ryabinkin freebsd_committer freebsd_triage 2025-01-30 18:07:12 UTC
Created attachment 257133 [details]
Proposed rtwnfw(4) modification: fixes plural, removes license acknowledgement requirement

Will this patch be fine for all involved parties?  I had also removed commented entry for FIRMWARE_LICENSE in /sys/modules/rtwnfw/Makefile.inc: it serves no visible purpose, but may consume people.
Comment 7 Eygene Ryabinkin freebsd_committer freebsd_triage 2025-01-30 18:11:23 UTC
s/consume/confuse/