From owner-freebsd-doc Fri Feb 1 12:57:44 2002 Delivered-To: freebsd-doc@freebsd.org Received: from lists.blarg.net (lists.blarg.net [206.124.128.17]) by hub.freebsd.org (Postfix) with ESMTP id C55E537B402 for ; Fri, 1 Feb 2002 12:57:40 -0800 (PST) Received: from thig.blarg.net (thig.blarg.net [206.124.128.18]) by lists.blarg.net (Postfix) with ESMTP id 6914CBD3D; Fri, 1 Feb 2002 12:57:40 -0800 (PST) Received: from localhost.localdomain ([206.124.139.115]) by thig.blarg.net (8.9.3/8.9.3) with ESMTP id MAA12104; Fri, 1 Feb 2002 12:57:39 -0800 Received: (from jojo@localhost) by localhost.localdomain (8.11.6/8.11.3) id g11KwHq03987; Fri, 1 Feb 2002 12:58:17 -0800 (PST) (envelope-from swear@blarg.net) To: David "=?iso-8859-1?q?Sieb=F6rger?=" Cc: FreeBSD-doc@FreeBSD.ORG Subject: Re: docs/34529: [patch] Grammar nits in usbd.conf(5) and usbd(8) References: <20020201141529.50693.qmail@foundation.org.za> From: swear@blarg.net (Gary W. Swearingen) Date: 01 Feb 2002 12:58:17 -0800 In-Reply-To: <20020201141529.50693.qmail@foundation.org.za> Message-ID: Lines: 43 User-Agent: Gnus/5.0808 (Gnus v5.8.8) XEmacs/21.1 (Cuyahoga Valley) MIME-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: 8bit Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org David "Siebörger" writes: > @@ -64,7 +64,7 @@ > There are 3 types of fields: > descriptive fields, selection criteria and commands to execute on > events. > -The field name is case sensitive and should be all lower case. > +The field names are case sensitive and should be all lower case. > Each field can have one or more arguments. This msg isn't so much a comment on these patches as on the man page itself, in case someone has any interest in improving it. I think the original (singular case) is better above, but either will do. Entries have only one "field name" and IT IS case sensitive. But the plural sounds OK too. I don't KNOW for sure which is correct. I find the page's use of "field" erroneous; "entry" (which it uses earlier) is probably more appropriate everywhere. "Field" seems to better connotate each non-delimiter between delimiters. The first field of an entry is the entry name (or identifier or ...). I don't know why it bothers so say that fields can be descriptive fields or selections criteria, as I don't see that it explains the difference or which entries are which. > -Product Id > +Product ID Is this a standard, or something? I've been on projects that preferred "Id" (but I like "ID"). Presuming there are no written standards to cover such things, would having one reduce patching and/or discussion? > -Release Id, also called revision Id sometimes. > +Release ID, also called revision ID sometimes. Or +Release ID, also called revision ID. (If "sometimes" is supposed to imply low frequency, "occasionally called..." would be better.) > -The man page for the usbd configuration file was written by > +The manual page for the usbd configuration file was written by OK, but is there a standard on this. Isn't "man page" VERY common? To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message