Differential D58479

mt76: mt7921: update man page
ClosedPublic
Actions

Authored by bz on Mon, Jul 27, 2:36 PM.

Details

Reviewers

ziaee

Group Reviewers

manpages

Commits

rG7bea49bd865d: mt76: mt7921: update man page
rG3afa2628ccd2: mt76: mt7921: update man page

Summary

Adjust the man page to what other LinuxKPI wlan man pages say and look
like as it has been a while since I wrote it. The man page is not yet
hooked up to the build on purpose as the driver is not yet enabled in
the tree.

Sponsored by: The FreeBSD Foundation
MFC after: 3 days

Test Plan

In case someone hase time to review this quickly that would be
appreciated. It does not yet have to be perfect but I need to
get it in.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

bz created this revision.Mon, Jul 27, 2:36 PM

Herald added a subscriber: imp. · View Herald TranscriptMon, Jul 27, 2:36 PM

bz requested review of this revision.Mon, Jul 27, 2:36 PM

Harbormaster completed remote builds in B75163: Diff 182787.Mon, Jul 27, 2:36 PM

bz retitled this revision from mt67: mt7921: update man page to mt76: mt7921: update man page.Mon, Jul 27, 2:38 PM

bz added a parent revision: D58320: LinuxKPI: Add PAGE_IS_LKPI_PAGE for Linux struct page instead of vm_page.Mon, Jul 27, 10:50 PM

bz edited parent revisions, added: D58498: LinuxKPI: turn on PAGE_IS_LKPI_PAGE; removed: D58320: LinuxKPI: Add PAGE_IS_LKPI_PAGE for Linux struct page instead of vm_page.Mon, Jul 27, 11:52 PM

bz added a child revision: D58499: mt76: hook up to the build, for now only compile core and mt7921 modules.Mon, Jul 27, 11:56 PM

Hey bz! Thanks for tagging me! Accepted with or without my suggestions.

share/man/man4/mt7921.4
8	this is a wonderful change, thanks for doing it.
30	This is a prose description of functionality and thus clearly belongs in DESCRIPTION, but I think you and I do not have a consensus about that, so I can not insist on it... buuuut I did give a talk about this last year and manpage tooling upstream said they agreed with me in the comments on youtube...
35–36	I don't think the extra specifier here increases the clarity, so the text might read easier without it.

This revision is now accepted and ready to land.Tue, Jul 28, 5:05 AM

bz marked 2 inline comments as done.Tue, Jul 28, 3:16 PM

bz added inline comments.

share/man/man4/mt7921.4
30	If we move this, we should do a pass over all LinuxKPI wifi man pages. I'll have a look in the aftermath and open a review for all of them then. That okay?
35–36	I agree. I added it for "correctness". Maybe just leaving that to the .Bl below. I'll remove it again. Thanks!

ziaee added inline comments.Tue, Jul 28, 8:17 PM

share/man/man4/mt7921.4
30	If you wanted to do that, honestly bz, that would be a dream come true. I think the best formatted example is vt.4, but we have around 200 manuals that are this way currently. Here's what I've got so far to try to get the format written down -- https://reviews.freebsd.org/D54586