Date: Tue, 18 Jul 2000 15:52:36 +0100 From: Ben Smithurst <ben@FreeBSD.org> To: Garrett Wollman <wollman@khavrinen.lcs.mit.edu> Cc: Sheldon Hearn <sheldonh@uunet.co.za>, cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org Subject: Re: cvs commit: src/share/man/man9 style.9 Message-ID: <20000718155236.V4668@strontium.scientia.demon.co.uk> In-Reply-To: <200007181420.KAA07426@khavrinen.lcs.mit.edu> References: <20000718014644.F4668@strontium.scientia.demon.co.uk> <43113.963902882@axl.ops.uunet.co.za> <200007181420.KAA07426@khavrinen.lcs.mit.edu>
next in thread | previous in thread | raw e-mail | index | archive | help
--Ln+iIw7POnzHEEo5
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
Garrett Wollman wrote:
> <<On Tue, 18 Jul 2000 08:48:02 +0200, Sheldon Hearn <sheldonh@uunet.co.za=
> said:
>=20
>> On Tue, 18 Jul 2000 01:46:44 +0100, Ben Smithurst wrote:
>=20
>>> (Is it possible to get each of those on one line, using .Pq somehow, or
>>> not, because there are two separate bits which need .Sq ?)
>=20
>> Probably, but there's nothing wrong with using lots of lines in mdoc.
>> :-)
>=20
> I've seen a number of bogus changes lately which turn explicit
> parentheses into invocations of the .Po/.Pc/.Pq requests. This is
> erroneous. The only circumstances in which the .Pq (or .Bq) requests
> should be used are those in which the punctuation in question
> interacts with another markup element. For ordinary parentheticals,
> use ordinary parentheses.
ok, I'll remember that for next time, thanks. If only this was
explained in mdoc(7) or mdoc.samples(7)...
But in this case, the parentheses would interact with the .Sq markup,
wouldn't they, so is it ok in this case? I hope so, because I just
committed it before I read your message. :-> If it's not ok, how should
it be done? Here's that diff again...
--- style.9 2000/07/17 19:05:57 1.35
+++ style.9 2000/07/18 13:28:56
@@ -91,7 +91,13 @@
and the macro name. =20
If they are an inline expansion of a function, the function is defined
all in lowercase, the macro has the same name all in uppercase. If the
-macro needs more than a single line, use braces. Right-justify the
+macro needs more than a single line, use braces
+.Po
+.Sq \&{
+and
+.Sq \&}
+.Pc .
+Right-justify the
backslashes; it makes it easier to read.
If the macro encapsulates a compound statement, enclose it in a
.Dq Li do
@@ -477,7 +483,12 @@
.It
Options without operands come first,
in alphabetical order,
-inside a single set of brackets.
+inside a single set of brackets
+.Po
+.Sq \&[
+and
+.Sq \&]
+.Pc .
.It
Options with operands come next,
also in alphabetical order,
thanks,
--=20
Ben Smithurst / ben@FreeBSD.org / PGP: 0x99392F7D
FreeBSD Documentation Project /
--Ln+iIw7POnzHEEo5
Content-Type: application/pgp-signature
Content-Disposition: inline
-----BEGIN PGP SIGNATURE-----
Version: PGPfreeware 5.0i for non-commercial use
MessageID: TysQdUYFWxf3zjC/N6zmfQel7rNq4Vd1
iQCVAwUBOXRvMysPVtiZOS99AQFXlQP9HZYYSn4VgCzvT8lkyafEXnfJe3xuxo++
lnv0kwGHl/bgmPHgl2yLiC1o4JQw21FTHWsp37tJmbSGpax60zp6V8rxFgXNF/co
Relgiq3JZu/+ftItGFX+CO4Unpdh0lQizE4UZHLW213vP3ntqwItZI4VslnasMLF
QJz8t9cz0vM=
=HY75
-----END PGP SIGNATURE-----
--Ln+iIw7POnzHEEo5--
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?20000718155236.V4668>