Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 19 Oct 2002 11:43:49 +0200
From:      Marc Fonvieille <blackend@FreeBSD.org>
To:        Tom Rhodes <trhodes@FreeBSD.org>
Cc:        freebsd-doc@FreeBSD.org
Subject:   Re: *New* HEADS UP: Use of -CURRENT manual pages in our docs
Message-ID:  <20021019114349.A59783@abigail.blackend.org>
In-Reply-To: <20021018183602.4eb79109.trhodes@FreeBSD.org>; from trhodes@FreeBSD.org on Fri, Oct 18, 2002 at 06:36:02PM -0400
References:  <20021018233906.H50649@abigail.blackend.org> <20021018183602.4eb79109.trhodes@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On Fri, Oct 18, 2002 at 06:36:02PM -0400, Tom Rhodes wrote:
> On Fri, 18 Oct 2002 23:39:06 +0200
> Marc Fonvieille <blackend@FreeBSD.ORG> wrote:
> 
> > This HEADS UP replaces the previous one :)
> > 
> > We need to talk more about manual page entities convention, so I chose
> > to use the same way I used for ports:
> > 
> > <!ENTITY man.devfs.5 "<citerefentry
> > vendor='current'/<refentrytitle/devfs/<manvolnum/5//">
> > 
> > will allow the use of -CURRENT manual page.
> > There is nothing to change in the sgml files, localized freebsd.dsl
> > files have to be upgraded to support the 'current' attribute.
> > 
> > Sorry for the *noise* :)
> > 
> > Marc
> 
> And who moves all current to stable when current actually becomes
> stable?  I'm not following...
>

It was covered in previous thread and in my previous message:

Problem: there is no easy way to use -CURRENT and -STABLE/-RELEASE
manual pages in a same document.

Solutions:

1st: use &man.current.foo.x;, but when the -CURRENT becomes -STABLE, the
entities have to be changed in the document. However it's easy to know
if the entity is for -CURRENT or not, and this allows the use of
-CURRETN *and* -STABLE version of one manual page in a document.

2nd: use "common" &man.foo.x; with the right attribute in entity
definition, when the -CURRENT becomes -STABLE, the docs don't have to be
patched, just the man-refs.ent. However, it's less easy to know if the
manual page is for ports, XFree86, etc. and it's impossible to use the
the -CURRENT *and* -STABLE version of a manual page in a doc.
For the moment that problem does not exist, but who knows...

I *reverted* to the second to avoid multiple commits

So I launched the question: What convention to use?
According to the choice we will make, I will proceed to the man-refs.ent
split (ports, xfree86, base...).

I have my opinion on the question, and I want yours guys :)

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?20021019114349.A59783>