Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 9 Apr 2001 10:34:47 +0300
From:      Ruslan Ermilov <ru@FreeBSD.org>
To:        Bruce Evans <bde@zeta.org.au>
Cc:        doc@FreeBSD.org, Bruce Evans <bde@FreeBSD.org>, Sheldon Hearn <sheldonh@FreeBSD.org>, Mike Pritchard <mpp@FreeBSD.org>, Jeroen Ruigrok van der Werven <asmodai@FreeBSD.org>
Subject:   Re: Please review: latest mdoc(7) fixes from CSRG
Message-ID:  <20010409103447.C80923@sunbay.com>
In-Reply-To: <Pine.BSF.4.21.0104080220480.65588-100000@besplex.bde.org>; from bde@zeta.org.au on Sun, Apr 08, 2001 at 02:29:44AM %2B1000
References:  <20010407153431.A65093@sunbay.com> <Pine.BSF.4.21.0104080220480.65588-100000@besplex.bde.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On Sun, Apr 08, 2001 at 02:29:44AM +1000, Bruce Evans wrote:
> On Sat, 7 Apr 2001, Ruslan Ermilov wrote:
> 
> > I am about to bring in the latest CSRG revisions to -mdoc.
> > The only reason I am asking for a review here is that the
> > .Fn (and friends) macros were modified by CSRG to assert a
> > final semicolon (`;') after a function declaration in the
> > SYNOPSIS section.
> 
> Does "assert" mean that they add this semicolon or check for it?  From
> your later mail, I think it means that they add it.
> 
Yup.

> > If you have any ideas of why this should not be imported,
> > let me know now (I know some manpages abuse the .Fn macro
> > for cpp(1) macros declarations, but they basically need
> > this final `;' too).
> 
> I'm not sure about that.  The semicolon is a syntax error for a few
> (broken) declaration-like macros e.g., SYSINIT().
> 
I found no actual example of incorrect usage in our src/ manpages.

> I think the change for actual functions is no worse than (ab)using
> .Fn for prototypes generally.  If we ever have special markup for
> prototypes, it would be even more correct for it to add the semicolon
> than for .Fn.
> 
What kind of special markup would you like to see?
A few examples would be nice.


Cheers,
-- 
Ruslan Ermilov		Oracle Developer/DBA,
ru@sunbay.com		Sunbay Software AG,
ru@FreeBSD.org		FreeBSD committer,
+380.652.512.251	Simferopol, Ukraine

http://www.FreeBSD.org	The Power To Serve
http://www.oracle.com	Enabling The Information Age

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010409103447.C80923>