Page MenuHomeFreeBSD

rk_grf_gpio.4: Minor polish
ClosedPublic

Authored by ziaee on Tue, Mar 18, 10:13 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mon, Mar 24, 12:40 PM
Unknown Object (File)
Sun, Mar 23, 4:38 AM
Unknown Object (File)
Fri, Mar 21, 9:09 AM
Unknown Object (File)
Thu, Mar 20, 7:48 PM
Unknown Object (File)
Thu, Mar 20, 7:32 PM
Unknown Object (File)
Wed, Mar 19, 8:25 AM

Details

Summary
Normalize copyright, date, and, wrapping, and document description

Fixes:                  0832a409c (add driver for the RK3328 GPIO_MUTE)
(not yet) Approved by:          shurd

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

  • Document descriptions are part of titles and should not have crossreferences, this breaks with a wontfix in many implementations, like apropos
  • We almost always put "driver" at the end throughout the entire kernel interfaces manual, and consistent apropos results are a big fit and finish polish
  • Gpio is already in there from GPIO_MUTE
  • The date format is standard and errors on the linter
  • The copyright line comes before the SPDX tag per style(9), it's really hard to fix this stuff later and I have to do it often because $dayjob says that I can work on foss but it has to have a standard, valid foss license. Which is also why I love spdx tags because I can't get in trouble over a typo.
  • The Roff language asks one sentence per line
This revision is now accepted and ready to land.Wed, Mar 19, 5:56 AM

I ask once again to be mindful of your use of the commit trailers here... The commit does not require "approval" from @shurd, but as the author of the man page (its de-facto maintainer), his "Reviewed by" is meaningful.

Please consult the Committers' Guide to understand when "Approved by" is used. Contrast against the MAINTAINERS file in the root of the src tree.

The use of Fixes: seems good and correct!

From me (assuming the above is fixed):

Reviewed by: mhorne
Approved by: mhorne (mentor)

Thank you, I thought it does need it because I'm proposing changing the copyright header?

It may be worth noting that the only example of SPDX in style(9) that I see has SPDX before the copyright.

Thank you, I thought it does need it because I'm proposing changing the copyright header?

Fair point, if you were changing the copyright itself (either the chosen license or copyright holders) this would require approval. Here, you are changing only the position of the SPDX tag, and it does not require approval in the same way that adding an SPDX tag where one was missing would not.

It may be worth noting that the only example of SPDX in style(9) that I see has SPDX before the copyright.

It was a great honor to have the privilege of fixing it in recent CURRENT!

This revision was automatically updated to reflect the committed changes.