Man page mandatory for new arm/arm64 drivers

Emmanuel Vadot manu at bidouilliste.com
Mon Dec 25 21:39:02 UTC 2017


 Hello arm people,

 Since I was bored during christmas I've used some of my time to write
a few manual pages for arm device driver. This is something that was
asked by a lot of people and that we should have done a long time ago.
 I know that writing documentation is somewhat tedious and sometime
hard for non native-english person like me but if I could do it you can
too.
 I'm not proposing that we *should* provide a man page for each new arm
driver but that we *must*. I will personnaly track down commiters that
don't provide man page and possibly revert their commit if they are not
responsive.

 Here is a list of what information a manual page for arm drivers
should provide :

 - Hardware supported
 - FDT compatible strings
 - sysctls

 And of course the usual BUGS/CAVEATS etc ...

 Cheers,

-- 
Emmanuel Vadot <manu at bidouilliste.com> <manu at freebsd.org>


More information about the freebsd-arm mailing list