Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 18 Oct 2002 23:29:24 +0200
From:      Marc Fonvieille <blackend@freebsd.org>
To:        Giorgos Keramidas <keramida@freebsd.org>
Cc:        freebsd-doc@freebsd.org
Subject:   Re: HEADS UP: Use of -CURRENT manual pages in our docs
Message-ID:  <20021018232924.G50649@abigail.blackend.org>
In-Reply-To: <20021018211726.GA2822@hades.hell.gr>; from keramida@freebsd.org on Sat, Oct 19, 2002 at 12:17:26AM %2B0300
References:  <20021018212220.B50649@abigail.blackend.org> <20021018194751.GG16196@hades.hell.gr> <20021018223014.E50649@abigail.blackend.org> <20021018224804.F50649@abigail.blackend.org> <20021018211726.GA2822@hades.hell.gr>

next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, Oct 19, 2002 at 12:17:26AM +0300, Giorgos Keramidas wrote:
> On 2002-10-18 22:48, Marc Fonvieille <blackend@FreeBSD.ORG> wrote:
> > On Fri, Oct 18, 2002 at 10:47:51PM +0300, Giorgos Keramidas wrote:
> > > So what happens when today's current becomes tomorrow's stable?
> > > I hope we won't have to rename all the &man.current.foo.X; entities to
> > > &man.stable.foo.X; :-(
> >
> > However, indeed, we should avoid &man.current etc. for base system
> > manpages. Tell me what you think about it, since it's easy to fix
> > man-refs in that way...
> 
> That's what I originally meant.  We shouldn't overuse &man.current.*;
> entities.  I'm ok with that, if it's also added explicitly as a
> comment to the file.  Something similar to the following should be
> more than enough:
> 
> 	Whenever the need arises for a manpage reference that is only
> 	meaningful for FreeBSD-current, the convention is to add an
> 	entity to this file of the form &man.current.foo.1;.  After a
> 	while, when all required parts have been MFCed, you are
> 	expected to change the documents to use &man.foo.1; and update
> 	this file removing &man.current.foo.1;.
> 
> I would even go as far as making the &man.current.*; entities a
> separate file, at this point.  But this is your call, and still just
> an opinion.
>

I just reverted a part of the changes, the -CURRENT manual pages are
"now" used in the same way I did for ports ones.
Only the attribute 'current' is added in man-refs.ent, and nothing to
change in sgml files.

For the moment, it's the best solution in waiting for a convention on
the manual page entities.  And the convention should lead to a split of
the man-refs.ent, but as I said in a previous mail, I prefer to wait and
see... :)

Marc

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?20021018232924.G50649>