From owner-freebsd-doc@FreeBSD.ORG Tue Dec 6 14:34:31 2011 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 902C6106564A for ; Tue, 6 Dec 2011 14:34:31 +0000 (UTC) (envelope-from stb@lassitu.de) Received: from gilb.zs64.net (gilb.zs64.net [IPv6:2001:470:1f0b:105e::1ea]) by mx1.freebsd.org (Postfix) with ESMTP id 5C29C8FC0A for ; Tue, 6 Dec 2011 14:34:31 +0000 (UTC) Received: by gilb.zs64.net (Postfix, from stb@lassitu.de) id 4CBF31143FF for ; Tue, 6 Dec 2011 15:34:30 +0100 (CET) From: Stefan Bethke Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable Date: Tue, 6 Dec 2011 15:34:29 +0100 Message-Id: <77AB0982-9E21-4BB3-8CE5-E390112E27B8@lassitu.de> To: freebsd-doc Mime-Version: 1.0 (Apple Message framework v1084) X-Mailer: Apple Mail (2.1084) Subject: Documenting device driver methods X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 06 Dec 2011 14:34:31 -0000 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 --=20 Stefan Bethke Fon +49 151 14070811