freebsd-src icon indicating copy to clipboard operation
freebsd-src copied to clipboard

wifi manuals: polish

Open concussious opened this issue 1 year ago • 6 comments

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.~~

concussious avatar Oct 12 '24 16:10 concussious

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

bzfbd avatar Oct 12 '24 17:10 bzfbd

Happily! Thanks!

concussious avatar Oct 12 '24 20:10 concussious

~~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.

concussious avatar Oct 12 '24 22:10 concussious

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.

bzfbd avatar Oct 16 '24 14:10 bzfbd

Thank you!

I have no idea how to approve things here on github.

console: % gh pr checkout 1462 % gh pr review --approve

webapp: Click "files changed" tab in same row as "conversation" tab => green "review changes" box => approve

concussious avatar Oct 16 '24 14:10 concussious

Thanks!

bzfbd avatar Oct 16 '24 14:10 bzfbd

Sorry to push after approval, I had a typo (no space in "802.11$spec").

concussious avatar Oct 27 '24 22:10 concussious

I tried to merge this today, but I think it needs a rebase on top of some recent change to rtw89.4.

mhorne avatar Oct 28 '24 15:10 mhorne

Is this the last reivew here on github? I also have others open in Phabricator currently...

bzfbd avatar Oct 30 '24 01:10 bzfbd

Is this the last review here on github?

Yes.

concussious avatar Oct 30 '24 18:10 concussious

Mitchell is very busy, and bz prefers one review on phab, so I'm going to close this and put them all together over there.

concussious avatar Nov 10 '24 14:11 concussious