From owner-freebsd-current Mon Jun 29 01:11:31 1998 Return-Path: Received: (from majordom@localhost) by hub.freebsd.org (8.8.8/8.8.8) id BAA27649 for freebsd-current-outgoing; Mon, 29 Jun 1998 01:11:31 -0700 (PDT) (envelope-from owner-freebsd-current@FreeBSD.ORG) Received: from nlsystems.com (nlsys.demon.co.uk [158.152.125.33]) by hub.freebsd.org (8.8.8/8.8.8) with ESMTP id BAA27624 for ; Mon, 29 Jun 1998 01:11:04 -0700 (PDT) (envelope-from dfr@nlsystems.com) Received: from herring.nlsystems.com (herring.nlsystems.com [10.0.0.2]) by nlsystems.com (8.8.8/8.8.5) with SMTP id JAA18585; Mon, 29 Jun 1998 09:16:02 +0100 (BST) Date: Mon, 29 Jun 1998 09:16:02 +0100 (BST) From: Doug Rabson To: Thomas Dean cc: current@FreeBSD.ORG Subject: Re: Draft manpages available for review In-Reply-To: <199806281836.LAA20728@ix.netcom.com> Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: owner-freebsd-current@FreeBSD.ORG Precedence: bulk X-Loop: FreeBSD.ORG On Sun, 28 Jun 1998, Thomas Dean wrote: > Hi Doug, > > I looked at the changed man pages. All I noticed was some structure > differences and maybe some grammar differences. There was one > possible name conflict. > > Some man pages do not have 'Return Values' sections. > BUS_PRINT_CHILD > bus_generic_read_ivar > devclass_add_driver > devclass_get_maxunit > devclass_get_name > device_enable for device_is_enabled > device_get_devclass > device_get_driver > device_get_ivars > device_get_state > device_get_unit > device_set_desc for device_get_desc I didn't bother with a 'Return Values' section for functions which were void or where the return value was described in the 'Description' section. > > DEVICE_ATTACH - Description uses future tense, 'should'. Was this intended? > DEVICE_PROBE - Description uses future tense, 'should'. Was this intended? Not sure about this. These manpages describe the requirements for a driver's implementation of these methods which accounts for the different language. > devclass - /usr/include/sys/device.h contains enum devclass { ... } What I really want to to is 'cvs rm -f sys/device.h' :-). The concepts there are not compatible with the new framework. > devclass_add_driver - ispell says 'initialisation' should be 'initialization' Do we have any convention in our manpages for which dialect of English spelling to use? > device_find_child - 'child of dev. with the' - period intended? I'll check this, thanks. > > Hope this helps, Thanks for spending the time, its very helpful. -- Doug Rabson Mail: dfr@nlsystems.com Nonlinear Systems Ltd. Phone: +44 181 951 1891 Fax: +44 181 381 1039 To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-current" in the body of the message