Date: Fri, 31 May 2002 15:35:30 +0300 From: Ruslan Ermilov <ru@FreeBSD.org> To: Bruce Evans <bde@zeta.org.au> Cc: Giorgos Keramidas <keramida@FreeBSD.org>, cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org Subject: Re: cvs commit: src/sbin/ffsinfo ffsinfo.8 Message-ID: <20020531123530.GA52992@sunbay.com> In-Reply-To: <20020531191722.D32208-100000@gamplex.bde.org> References: <20020531060844.GB6953@sunbay.com> <20020531191722.D32208-100000@gamplex.bde.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--lrZ03NoBR/3+SXJZ Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Fri, May 31, 2002 at 07:38:40PM +1000, Bruce Evans wrote: > On Fri, 31 May 2002, Ruslan Ermilov wrote: >=20 > > On Fri, May 31, 2002 at 03:11:13AM +0300, Giorgos Keramidas wrote: > > > On 2002-05-29 09:39 -0700, Ruslan Ermilov wrote: > > > > ru 2002/05/29 09:39:40 PDT > > > > > > > > Revision Changes Path > > > > 1.11 +4 -2 src/sbin/ffsinfo/ffsinfo.8 > > > > > > -.Nd "dump all meta information of an existing ufs filesystem > > > +.Nd "dump all meta information of an existing ufs filesystem" > > > > > > <ignorant question> > > > Are the quotes really necessary? > > > > > info --file=3Dgroff --node=3D'Request Arguments' > > > > Also, from the groff(7) manpage: > > > > : REQUESTS > > [...] > > : Most requests take one or more arguments. The arguments > > : are separated by space characters (no tabs!); there is no > > : inherent limit for their length or number. An argument >=20 > There used to be an inherent limit of 9 arguments. >=20 Yes, in the old version of mdoc(7) package, not in groff(1). > > : can be enclosed by a pair of double quotes: This is very > > : handy if an argument contains space characters, e.g., > > : "arg with space" denotes a single argument. > > > > Although in groff(1) the closing double quote is not necessary for > > request (macro) arguments, it's still a good idea to supply one, > > at least to make the input look "canonical". >=20 > I've noticed strange quoting for .Cd more than for .Nd. Most .Cd's > for device lines in section 4 man pages have quoted args. This because > most device lines used to have more than 9 args, and no one removed > the quotes when compl^Wsimplification of device configuration using > the hints mechanism moved most of the configuration from the device > lines to undocumented places. >=20 > I think we don't really care how the spaces are formatted for .Nd or > .Cd, so quoting of args for .Nd and .Cd is unimportant. The quotes > just make the source code uglier, and makes one wonder why quotes are > used :-). >=20 Err. I encourage people to use quotes where applicable. Not only this makes source code nicer (where applicable), but this also speeds up the processing significantly. In some cases, like the .Fa example below, it is also necessary. One should not use quotes for arguments that denote different things in the manpage's context. For example, using =2EAr "source_file target_file" is incorrect. On the other hand, these are all eligible: =2EAn "Bruce Evans" Aq bde@FreeBSD.org =2ECd "device ar0 at isa? port 0x300 irq 10 iomem 0xd0000" =2ECd "options SOFTUPDATES" =2EDl "burncd -f /dev/acd0c data file1 audio file2 file3 fixate" =2EDq "end of file" =2EFa "FILE *stream" "size_t *len" "size_t *lineno" =2ENd "mount a loopback filesystem sub-tree; demonstrate the use of a null = filesystem layer" =2ESh "FORMATTING WITH GROFF, TROFF, AND NROFF" =2EVt "long long int" Of course, using quotes below is unproven: =2EAr "output-file" =2EDt "PIANO" 6 =2EFt "int" =2ENm "" (this one is the NetBSD'ism we don't even support) =2ESs "Arguments" Cheers, --=20 Ruslan Ermilov Sysadmin and DBA, ru@sunbay.com Sunbay Software AG, ru@FreeBSD.org FreeBSD committer, +380.652.512.251 Simferopol, Ukraine http://www.FreeBSD.org The Power To Serve http://www.oracle.com Enabling The Information Age --lrZ03NoBR/3+SXJZ Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.0.7 (FreeBSD) iD8DBQE8924SUkv4P6juNwoRAiWVAJ0Vtzj9VDtn77x+otG/ECluyWqdFACcDEBL mQVYDc8i2CCcR8bJGaKwQng= =v3dN -----END PGP SIGNATURE----- --lrZ03NoBR/3+SXJZ-- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20020531123530.GA52992>