Details
- Reviewers
ziaee - Commits
- rGfb1994e03c88: aq(4): Add man page
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
| share/man/man4/aq.4 | ||
|---|---|---|
| 4 | SPDX tag applied in local copy | |
| share/man/man4/aq.4 | ||
|---|---|---|
| 10 | This doesn't need to be quoted. | |
| share/man/man4/aq.4 | ||
|---|---|---|
| 33 | Or similar. The reasoning is then people can search through the hardware release notes to see what kind of hardware they need, if they want say, a 10g Ethernet card. I also wrote this in style.mdoc(7). | |
| share/man/man4/aq.4 | ||
|---|---|---|
| 33 | No objection, but that information is in the Nd -- aq – Aquantia / Marvell AQ1xx 10 Gigabit Ethernet driver | |
| share/man/man4/aq.4 | ||
|---|---|---|
| 33 | Yeah, it's not for the manual, it's for the HW Relnotes. The entire HARDWARE section appears verbatim in the HW Relnotes. When it has no context, then the document becomes only useful for a very narrow use case of "Find in Page"ing your specific hardware you already have. And, I know, but if we do it this way, we can maintain it. Otherwise the HW Relnotes becomes full of dead links that someone has to actually line by line investigate the history of what it's talking about, which is a colossal effort. | |
I see this formulation in share/man/man4/mgb.4 and share/man/man4/muge.4 and I probably looked at one of those as a template. I'll take a look at updating those first. mgb(4) is a driver for PCIe GigE hw, muge(4) USB GigE.
Are there kernconfs to compile the module? We also usually put that in synopsis.
There isn't yet.
| share/man/man4/aq.4 | ||
|---|---|---|
| 14 | ||
| share/man/man4/aq.4 | ||
|---|---|---|
| 25 | This is important information, but I think it's a confusing introductory sentence. | |
Move caveat to end of description, and remove comment about only being a kernel module
| share/man/man4/aq.4 | ||
|---|---|---|
| 14 | Does it have any dependencies? Like does it also need device pci? | |
Oh I forgot, CAVEATS is a standard section at the bottom. You could use that too. That's usually where we put that kinda thing, there's even a macro for it, .Ud
CAVEATS is a standard section at the bottom.
I thought about that, but I think this sort of general statement fits better with the main description. If/when we have a list of specific issues I'd put them in CAVEATS (e.g. if VLANs don't work or TSO or LRO or certain speeds or such).
| share/man/man4/aq.4 | ||
|---|---|---|
| 3 | Please consider using the format from the Preferred License for New Files for consistency. | |