Marking up POSIX symbolic limits
Tom Rhodes
trhodes at FreeBSD.org
Wed Jun 16 14:24:12 UTC 2004
On Wed, 16 Jun 2004 14:51:43 +0300
Ruslan Ermilov <ru at freebsd.org> wrote:
> [ 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.
If it is more correct, then yes please.
--
Tom Rhodes
More information about the freebsd-doc
mailing list