Date: Mon, 25 Dec 2017 22:38:58 +0100 From: Emmanuel Vadot <manu@bidouilliste.com> To: "freebsd-arm@freebsd.org" <arm@freebsd.org> Subject: Man page mandatory for new arm/arm64 drivers Message-ID: <20171225223858.d82e0c795b878f12807787de@bidouilliste.com>
next in thread | raw e-mail | index | archive | help
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@bidouilliste.com> <manu@freebsd.org>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20171225223858.d82e0c795b878f12807787de>