Date: Mon, 29 Jun 1998 09:16:02 +0100 (BST) From: Doug Rabson <dfr@nlsystems.com> To: Thomas Dean <tomdean@ix.netcom.com> Cc: current@FreeBSD.ORG Subject: Re: Draft manpages available for review Message-ID: <Pine.BSF.3.95q.980629091055.1385I-100000@herring.nlsystems.com> In-Reply-To: <199806281836.LAA20728@ix.netcom.com>
next in thread | previous in thread | raw e-mail | index | archive | help
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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?Pine.BSF.3.95q.980629091055.1385I-100000>