Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 1 Jun 2000 20:16:46 -0400
From:      Tim Vanderhoek <vanderh@ecf.utoronto.ca>
To:        Alexander Langer <alex@big.endian.de>
Cc:        FreeBSD-GNATS-submit@freebsd.org, freebsd-doc@freebsd.org
Subject:   Re: docs/18918: add bus_alloc_resource.9 and bus_release_resource.9
Message-ID:  <20000601201645.A18461@orange>
In-Reply-To: <20000601144703.A8285@cichlids.cichlids.com>; from Alexander Langer on Thu, Jun 01, 2000 at 02:47:03PM %2B0200
References:  <200005311510.IAA34279@freefall.freebsd.org> <20000601144703.A8285@cichlids.cichlids.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Jun 01, 2000 at 02:47:03PM +0200, Alexander Langer wrote:
> 
> The bus methods are free to change the RIDs that are passed to it -
> that's why it is a pointer.

grammar gnit: I think your subject(s) might be having trouble deciding whether
              it's plural or singular here.


> on PCI and device-dependent on ISA and PCCARD). If you specified the default

Either add a newline after the period or use two spaces after the
period.  Preferrably the former.  :)


> sets the flags for the resource. You can set one or more of these flags:

[...]  same comment

> .Bl -tag -width RF_SHAREABLE
> .It Dv RF_ALLOCATED
> resource has been reserved.
> Resource still needs to be activated with

I think that capitalising ``Resource'' here might be confusing.

You've chosen to avoid capitalisation when referring to identifiers,
which, although it breaks BSD tradition, is ok since it has entered
into vogue in the last couple years.  Here, although ``resource''
isn't formally an identifier, you've turned it almost into one by
saying "resource has been reserved."

> This is some example code. The values of

[...] spacing

Have you had sheldonh@FreeBSD.org review the manpage for its mdoc
formatting?  I seem to remember he had a standing offer to review all
manpages, and a promise to write a list of "common mdoc do's and
dont's" which I have yet to see fulfilled.  :-)


-- 
Signature withheld by request of author.


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20000601201645.A18461>