Re: [DOCS] TODO list - Mailing list pgsql-docs

From Bruce Momjian
Subject Re: [DOCS] TODO list
Date
Msg-id 199901050401.XAA01880@candle.pha.pa.us
Whole thread Raw
In response to Re: [DOCS] TODO list  ("Thomas G. Lockhart" <lockhart@alumni.caltech.edu>)
List pgsql-docs
> > I don't see the TODO list in sgml anywhere.
> > What I could do is to keep maintaining it in ASCII, and generate html
> > and sgml from that ASCII file.  If you can mark up the todo list in
> > sgml, I will map the html tags to sgml, and auto-convert to html and
> > sgml when I change the file.
> 
> I must be confusing the ToDo list with the one-liner release notes,
> which have a similar format? The info I'm looking for is the stuff in
> current.sgml and release.sgml

Current.sgml is the list of changes that appear in the HISTORY file. 
They used to appear at the bottom of the TODO list, so it makes sense
you had them confused.  It is gone from the TODO as of today.

It is now only at the top of the HISTORY file.  You had a narrative at
the top to highlight the new items in current.sgml too.  Because people
are upgrading by often jumping several releases, from 6.3.1 to 6.4.2 for
example, giving a list of the new features JUST in the current release is
not really a good idea anymore.

Pointing them to the entire HISTORY file allows them to go backwards
until they hit the release they are currently running.

As I remember, you just include the HISTORY files's changes in the sgml
output, without any formatting, so it appears we don't have to make any
changes.  You just grab the current HISTORY contents when you package
the docs for the release.  Because the docs typically arn't updated
during minor releases, they should be looking at the HISTORY file
anyway.  In fact, that give a good argument not to include the HISTORY
file in the docs at all.

--  Bruce Momjian                        |  http://www.op.net/~candle maillist@candle.pha.pa.us            |  (610)
853-3000+  If your life is a hard drive,     |  830 Blythe Avenue +  Christ can be your backup.        |  Drexel Hill,
Pennsylvania19026
 


pgsql-docs by date:

Previous
From: "Thomas G. Lockhart"
Date:
Subject: Re: [DOCS] lyx and sgml
Next
From: Bruce Momjian
Date:
Subject: Re: [DOCS] lyx and sgml