Thread: Merging old man pages

Merging old man pages

From
Thomas Lockhart
Date:
We've now got a viable mechanism for generating man pages from sgml
sources. So, I'm starting to go through the old man pages (those in
src/man/) to verify that all information in them is available
somewhere in the new docs.

>From here on, there is no need to update the src/man/ man pages when
updating docs. Please do all updates in doc/src/sgml/{.,/ref}/*.sgml.
I'll be removing the old man pages from the cvs tree, but not until
I've got the new man page generating mechanism installed at
postgresql.org. This should all be completed well in advance of a v6.6
release.

TIA
                  - Thomas

-- 
Thomas Lockhart                lockhart@alumni.caltech.edu
South Pasadena, California


Re: [HACKERS] Merging old man pages

From
Tom Lane
Date:
Thomas Lockhart <lockhart@alumni.caltech.edu> writes:
> We've now got a viable mechanism for generating man pages from sgml
> sources.

Excellent!

> From here on, there is no need to update the src/man/ man pages when
> updating docs. Please do all updates in doc/src/sgml/{.,/ref}/*.sgml.
> I'll be removing the old man pages from the cvs tree,

OK, let me get this straight: man pages will no longer be in the CVS
tree because they will no longer be original files, but they will be
part of the standard distribution as derived files, right?
        regards, tom lane


Re: [HACKERS] Merging old man pages

From
Thomas Lockhart
Date:
> OK, let me get this straight: man pages will no longer be in the CVS
> tree because they will no longer be original files, but they will be
> part of the standard distribution as derived files, right?

Yes. Well, at least, maybe, sort of...

As is the case with the other (html) docs, I'm planning on putting a
man tarball into the distribution. Up to now, the easiest way to do
that is to put the tarball into cvs, but I'm open to other
suggestions.

Do I guess correctly that we currently generate our production
releases by actually doing a cvs checkout and then a "mini-build" of
the system to generate the yacc/bison derived files? If so, we could
consider doing the same sort of thing for the html and man products,
but it (probably) makes this packaging process more fragile.
                 - Thomas

-- 
Thomas Lockhart                lockhart@alumni.caltech.edu
South Pasadena, California


Re: [HACKERS] Merging old man pages

From
Tom Lane
Date:
Thomas Lockhart <lockhart@alumni.caltech.edu> writes:
> Do I guess correctly that we currently generate our production
> releases by actually doing a cvs checkout and then a "mini-build" of
> the system to generate the yacc/bison derived files?

Right.

> If so, we could
> consider doing the same sort of thing for the html and man products,
> but it (probably) makes this packaging process more fragile.

Less fragile than doing it by hand ;-).  I'd say that's exactly the
way to proceed.

The shell script src/tools/release_prep contains the commands that
are executed (at hub.org) to prepare derived files for release.
Add whatever is needed to build the derived doc files, and we should
be set.
        regards, tom lane