Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wifi manuals: polish #1462

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

wifi manuals: polish #1462

wants to merge 1 commit into from

Conversation

concussious
Copy link
Contributor

@concussious concussious commented Oct 12, 2024

Polish for iwlwifi.4, mt7915.4, mt7921.4, rtw88.4, and rtw89.4:

  • consolidate bugs to bugs section and move bugs section last to enhance flow of information
  • move hardware immediately after description, in line with fdp-primer and proposed future mdoc(7) spec so that compatible hardware is immediately noticeable
  • link fwget(8) firmware autodownloader and networking(7) quick start guide to show how easy and well integrated the process is
  • use consistent language explaining compatible and incompatible modes to demonstrate our cathedral design philosophy

I think bz needs to review this, but I can't find him on github, I'm going to send him a mail.

@bzfbd
Copy link

bzfbd commented Oct 12, 2024

Can you add at least rtw89 as well now that it is in the tree?

@concussious
Copy link
Contributor Author

Happily! Thanks!

@concussious
Copy link
Contributor Author

concussious commented Oct 12, 2024

I think HARDWARE should come immediately after DESCRIPTION because LOADER TUNABLES aren't relevant unless HARDWARE is important for the reader. Thoughts? Order is clear in fdp-primer/manual pages, thanks to @grahamperrin for pointing that out.

Latest push addresses rtw89 and hardware order.

Organize sections in wifi driver manuals for information flow.
Thus, for iwlwifi.4, mt7915.4, mt7921.4, rtw88.4, and rtw89.4:

+ order HARDWARE immediately after DESCIRPTION
+ consolidate bugs in BUGS, and move BUGS last
+ xref fwget(8) firmware autodownloader and networking(7) quick start
+ use consistent language explaining compatible wifi modes
+ zap a stray $FreeBSD$ + tag spdx

MFC after:	3 days
Reported by:	grahamperrin (HARDWARE order mentioned in fdp-primer)
@concussious concussious changed the title wifi manuals: nit order + tag spdx + grammar wifi manuals: polish Oct 14, 2024
Copy link
Contributor

@mhorne mhorne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good. I'll wait for @bzfbd to approve.

@bzfbd
Copy link

bzfbd commented Oct 16, 2024

I have no idea how to approve things here on github. Who's going to push this? @mhorne will you? I am fine with it.

@concussious
Copy link
Contributor Author

concussious commented Oct 16, 2024 via email

@bzfbd
Copy link

bzfbd commented Oct 16, 2024

Thanks!

@mhorne mhorne self-assigned this Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants