Marking up POSIX symbolic limits

[Ruslan Ermilov]

[ 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 at 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?
> 
> Note 4 in the _Typographical Conventions_ section in the frontmatter:
> 
> "Names surrounded by braces represent symbolic limits or configuration
> values which may be declared in appropriate headers by means of the C
> #define construct."
> 
> 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.
> 
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,
-- 
Ruslan Ermilov
ru at FreeBSD.org
FreeBSD committer
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20040616/9fa42d56/attachment.sig>