Date: Wed, 7 Dec 2011 00:56:28 -0500 (EST) From: Benjamin Kaduk <kaduk@MIT.EDU> To: Stefan Bethke <stb@lassitu.de> Cc: freebsd-doc <freebsd-doc@freebsd.org> Subject: Re: Documenting device driver methods Message-ID: <alpine.GSO.1.10.1112070051430.882@multics.mit.edu> In-Reply-To: <176FCC23-A2BB-4C51-8219-A3D06515A30C@lassitu.de> References: <77AB0982-9E21-4BB3-8CE5-E390112E27B8@lassitu.de> <176FCC23-A2BB-4C51-8219-A3D06515A30C@lassitu.de>
next in thread | previous in thread | raw e-mail | index | archive | help
On Tue, 6 Dec 2011, Stefan Bethke wrote: > > Am 06.12.2011 um 15:34 schrieb Stefan Bethke: > >> I noticed that very few (if any) device drivers have their interface >> methods documented (e.g. iicbus, iicbb, gpiobus, gpio). >> >> Where should such documentation go? In the driver specific man page, in >> a separate section 9 page per method, or a single section 9 man page? >> >> Is there a preferred style for these? > > Would it make sense to document device classes in the device section > with the class name in all capitals, e.g. foo_if.m as FOO.4? My 0.02 would be a single section 4 page per driver, but with a bunch of MLINKS for the methods, and cross-ref'd from the driver page. The driver page seems to be more of an overview of the thing as a whole and not really a programming guide. Though, that might lead one to put it in section 9 ... -Ben Kaduk
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?alpine.GSO.1.10.1112070051430.882>