Documenting device driver methods

Stefan Bethke stb at lassitu.de
Tue Dec 6 14:34:31 UTC 2011


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?


Thanks,
Stefan

-- 
Stefan Bethke <stb at lassitu.de>   Fon +49 151 14070811




More information about the freebsd-doc mailing list