Date: Wed, 16 Jun 2004 14:51:43 +0300 From: Ruslan Ermilov <ru@freebsd.org> To: Dag-Erling Sm?rgrav <des@des.no> Cc: Garrett Wollman <wollman@khavrinen.lcs.mit.edu> Subject: Marking up POSIX symbolic limits Message-ID: <20040616115143.GA23524@ip.net.ua> In-Reply-To: <xzpzn73oim8.fsf@dwp.des.no> References: <200406150124.i5F1Ofp9084012@repoman.freebsd.org> <200406151522.i5FFMeIc001885@khavrinen.lcs.mit.edu> <20040616062409.GC20866@ip.net.ua> <xzpzn73oim8.fsf@dwp.des.no>
next in thread | previous in thread | raw e-mail | index | archive | help
--/9DWx/yDrRhgMJTb
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
[ Moved to -doc, please keep me Cc:ed. ]
On Wed, Jun 16, 2004 at 01:19:27PM +0200, Dag-Erling Sm?rgrav wrote:
> Ruslan Ermilov <ru@FreeBSD.org> writes:
> > On Tue, Jun 15, 2004 at 11:22:40AM -0400, Garrett Wollman wrote:
> > > Actually, it's {IOV_MAX}.
> > You mean you want it marked up like in POSIX, with curlies?
> > We still use guidelines from mdoc(7) (where is talks about
> > "Defined Variables"), and there are no curlies here, but we
> > can change the practice if strongly necessary. I failed to
> > find a definition of using curlies in this case in the POSIX
> > spec, can you point me into the right direction?
>=20
> Note 4 in the _Typographical Conventions_ section in the frontmatter:
>=20
> "Names surrounded by braces represent symbolic limits or configuration
> values which may be declared in appropriate headers by means of the C
> #define construct."
>=20
> Note that POSIX does not require IOV_MAX to be defined in <limits.h>;
> if it isn't, the value of sysconf(_SC_IOV_MAX) should be used instead.
>=20
OK, so POSIX makes a distinction between a "symbolic constant" and a
"symbolic limit, configuration value". The question is: do we want
such a distinction in FreeBSD manpages?
If necessary, ``.Brq Dv IOV_MAX'' should do just fine.
Cheers,
--=20
Ruslan Ermilov
ru@FreeBSD.org
FreeBSD committer
--/9DWx/yDrRhgMJTb
Content-Type: application/pgp-signature
Content-Disposition: inline
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (FreeBSD)
iD8DBQFA0DRPqRfpzJluFF4RAkh5AJsH93ThutmwoXBkzrAEyrphaxM5GACfVcNk
E17d55pL+XaBl4RN5GSeJ4U=
=IHEv
-----END PGP SIGNATURE-----
--/9DWx/yDrRhgMJTb--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20040616115143.GA23524>