Date: 01 Feb 2002 12:58:17 -0800 From: swear@blarg.net (Gary W. Swearingen) To: David "=?iso-8859-1?q?Sieb=F6rger?=" <drs@rucus.ru.ac.za> Cc: FreeBSD-doc@FreeBSD.ORG Subject: Re: docs/34529: [patch] Grammar nits in usbd.conf(5) and usbd(8) Message-ID: <zod6zokjh2.6zo@localhost.localdomain> In-Reply-To: <20020201141529.50693.qmail@foundation.org.za> References: <20020201141529.50693.qmail@foundation.org.za>
next in thread | previous in thread | raw e-mail | index | archive | help
David "Siebörger" <drs@rucus.ru.ac.za> 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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?zod6zokjh2.6zo>