From owner-freebsd-doc@FreeBSD.ORG  Wed Jun 16 14:24:12 2004
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP
	id 9B58216A4CE; Wed, 16 Jun 2004 14:24:12 +0000 (GMT)
Received: from pittgoth.com (14.zlnp1.xdsl.nauticom.net [209.195.149.111])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id 4615443D31; Wed, 16 Jun 2004 14:24:12 +0000 (GMT)
	(envelope-from trhodes@FreeBSD.org)
Received: from localhost.pittgoth.com (acs-24-154-235-189.zoominternet.net
	[24.154.235.189])	(authenticated bits=0)
	by pittgoth.com (8.12.11/8.12.11) with ESMTP id i5GENvgd071889
	(version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT);
	Wed, 16 Jun 2004 10:23:58 -0400 (EDT)
	(envelope-from trhodes@FreeBSD.org)
Date: Wed, 16 Jun 2004 10:24:27 -0400
From: Tom Rhodes <trhodes@FreeBSD.org>
To: Ruslan Ermilov <ru@FreeBSD.org>
Message-Id: <20040616102427.05544d9b@localhost.pittgoth.com>
In-Reply-To: <20040616115143.GA23524@ip.net.ua>
References: <200406150124.i5F1Ofp9084012@repoman.freebsd.org>
	<200406151522.i5FFMeIc001885@khavrinen.lcs.mit.edu>
	<20040616062409.GC20866@ip.net.ua>
	<xzpzn73oim8.fsf@dwp.des.no>
	<20040616115143.GA23524@ip.net.ua>
X-Mailer: Sylpheed version 0.9.11claws (GTK+ 1.2.10; i386-portbld-freebsd5.2)
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
cc: doc@FreeBSD.org
cc: Garrett Wollman <wollman@khavrinen.lcs.mit.edu>
Subject: Re: Marking up POSIX symbolic limits
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Wed, 16 Jun 2004 14:24:12 -0000

On Wed, 16 Jun 2004 14:51:43 +0300
Ruslan Ermilov <ru@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@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