Re: [HACKERS] Last call for docs - Mailing list pgsql-docs

From Thomas Lockhart
Subject Re: [HACKERS] Last call for docs
Date
Msg-id 37439BCF.AF1D5863@alumni.caltech.edu
Whole thread Raw
Responses Re: [HACKERS] Last call for docs
List pgsql-docs
> > I can freeze docs in stages; which docs are
> > you planning on touching?
> I have committed all the SGML files I plan to touch except for
> xoper.sgml, libpq.sgml, and possibly start-ag.sgml.
> I had intended to try to write some things about troubleshooting
> postmaster startup failures (out of semaphores, etc) --- there is some
> material in the FAQ but almost none in the SGML files.  I could expand
> the very small "troubleshooting" chapter in start-ag.sgml, but I wonder
> whether you have a better idea.

Uh, sounds like I'd better have an idea, huh? :)

Hold off for an hour or so while I commit my current changes, which
include a bit of a reorg on the Admin Guide. There will be a separate
file, trouble.sgml, which is the troubleshooting chapter. A bit more
info in it (mostly about pg_options and log messages).

> I also want to make some improvements in the main FAQ document and
> in FAQ_HPUX, but I fear I am *still* confused about exactly which
> files represent the master copies.  Bruce?
> Finally, the plain-text FAQ_CVS document is now sadly behind
> cvs.sgml, and needs to be updated.  Is there a better way to
> update it than manually extracting and reformatting plain text
> from cvs.sgml?

istm that there is not need for a flat file FAQ_CVS, and that our web
site and our html and hardcopy docs can do a better job of showing
that info. I had started cvs.sgml from FAQ_CVS, adding some info about
CVSup culled from mailing list messages. Not done yet, but if FAQ_CVS
has not been updated recently it is bound to be more complete since
afaik FAQ_CVS did not even mention CVSup.

I'm planning on cleaning up some of the markup in cvs.sgml and
deep-sixing the CVS_FAQ.
                    - Thomas

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


pgsql-docs by date:

Previous
From: bbaale
Date:
Subject: New user ...
Next
From: Tom Lane
Date:
Subject: Re: [HACKERS] Last call for docs