pgsql-server/doc/src/sgml Makefile

Started by Bruce Momjianabout 22 years ago43 messagesdocs
Jump to latest
#1Bruce Momjian
bruce@momjian.us

CVSROOT: /cvsroot
Module name: pgsql-server
Changes by: momjian@svr1.postgresql.org 04/03/05 15:48:03

Modified files:
doc/src/sgml : Makefile

Log message:
Use '-' for stdin on lynx, my lynx version doesn't support -stdin.

#2Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#1)
Re: pgsql-server/doc/src/sgml Makefile

momjian@svr1.postgresql.org (Bruce Momjian) writes:

Use '-' for stdin on lynx, my lynx version doesn't support -stdin.

How old is your lynx? I checked before making that patch, and -stdin
seemed to be in the oldest lynx I had handy (RHL 8.0).

BTW, I recently installed 2.8.5rel.1 here, and it generates very clean
text output --- no weird trailing spaces, proper justification of
headings, etc. I'd suggest standardizing on that for building the
HISTORY file.

regards, tom lane

#3Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#2)
Re: pgsql-server/doc/src/sgml Makefile

Tom Lane wrote:

momjian@svr1.postgresql.org (Bruce Momjian) writes:

Use '-' for stdin on lynx, my lynx version doesn't support -stdin.

How old is your lynx? I checked before making that patch, and -stdin
seemed to be in the oldest lynx I had handy (RHL 8.0).

I am using:

Lynx Version 2.8.3rel.1 (23 Apr 2000)

I assume bsdi kept that version perhaps because newer versions had
troubles with some things.

In the old days, only I did HISTORY. Now that others are doing it,
which is good, we should standardize to prevent CVS from recording
massive changes to HISTORY for different versions of lynx.

BTW, I recently installed 2.8.5rel.1 here, and it generates very clean
text output --- no weird trailing spaces, proper justification of
headings, etc. I'd suggest standardizing on that for building the
HISTORY file.

I see on postgresql.org:

Lynx Version 2.8.5dev.16 (01 Jun 2003)

I used that to generate HISTORY, and I did a diff against the HISTORY I
generated, and the only difference is that it doesn't have spaces on
blank lines, which is even better output than mine.

In the future, I will use postgresql.org lynx. If you find yours
generates similar output to that, you can keep using your local one.

I have changed the lynx flag back to -stdin, and regenerated HISTORY, so
you can run a comparison with CVS to see if yours is similar.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073
#4Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#3)
Re: pgsql-server/doc/src/sgml Makefile

Bruce Momjian <pgman@candle.pha.pa.us> writes:

I see on postgresql.org:
Lynx Version 2.8.5dev.16 (01 Jun 2003)

I used that to generate HISTORY, and I did a diff against the HISTORY I
generated, and the only difference is that it doesn't have spaces on
blank lines, which is even better output than mine.

In the future, I will use postgresql.org lynx. If you find yours
generates similar output to that, you can keep using your local one.

Actually, mine generates better output than that one --- it aligns
headings better. I'd suggest updating to the 2.8.5 release.

The HISTORY versions that I just committed were made with 2.8.5rel1
... feel free to compare.

regards, tom lane

#5Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#4)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Tom Lane wrote:

Bruce Momjian <pgman@candle.pha.pa.us> writes:

I see on postgresql.org:
Lynx Version 2.8.5dev.16 (01 Jun 2003)

I used that to generate HISTORY, and I did a diff against the HISTORY I
generated, and the only difference is that it doesn't have spaces on
blank lines, which is even better output than mine.

In the future, I will use postgresql.org lynx. If you find yours
generates similar output to that, you can keep using your local one.

Actually, mine generates better output than that one --- it aligns
headings better. I'd suggest updating to the 2.8.5 release.

The HISTORY versions that I just committed were made with 2.8.5rel1
... feel free to compare.

I updated to that version of lynx but am still seeing the Migration
headings left-aligned, rather than centered.

I wonder if the cause is my version of the sgml tools, rather than lynx.

What do you see in your HISTORY.htlm file for "Migration":

<DIV

CLASS="SECT2"

<HR><H3

CLASS="SECT2"

<A

NAME="AEN9"

Migration to version 7.4.2</A

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073
#6Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#5)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Bruce Momjian <pgman@candle.pha.pa.us> writes:

I wonder if the cause is my version of the sgml tools, rather than lynx.

What do you see in your HISTORY.htlm file for "Migration":

<DIV

CLASS="SECT2"

<HR><H3

CLASS="SECT2"

<A

NAME="AEN9"

Migration to version 7.4.2</A

Hmm, I get

<DIV

CLASS="SECT2"

<HR><H2

CLASS="SECT2"

<A

NAME="AEN9"

Migration to version 7.4.2</A
</H2

so the discrepancy is evidently <H2> vs <H3>. In my HISTORY.html,
"Release Notes" and "Release 7.4.2" are both <H1> and then the
Migration heading is <H2>.

So indeed it looks like the discrepancy is in the SGML stylesheet.
I'm not real sure whether the <H3> interpretation should be preferred
--- Peter, any comments?

regards, tom lane

#7Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#6)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Tom Lane wrote:

Bruce Momjian <pgman@candle.pha.pa.us> writes:

I wonder if the cause is my version of the sgml tools, rather than lynx.

What do you see in your HISTORY.htlm file for "Migration":

<DIV

CLASS="SECT2"

<HR><H3

CLASS="SECT2"

<A

NAME="AEN9"

Migration to version 7.4.2</A

Hmm, I get

<DIV

CLASS="SECT2"

<HR><H2

CLASS="SECT2"

<A

NAME="AEN9"

Migration to version 7.4.2</A
</H2

so the discrepancy is evidently <H2> vs <H3>. In my HISTORY.html,
"Release Notes" and "Release 7.4.2" are both <H1> and then the
Migration heading is <H2>.

So indeed it looks like the discrepancy is in the SGML stylesheet.
I'm not real sure whether the <H3> interpretation should be preferred
--- Peter, any comments?

Looking at the SGML, it seems the H3 interpretation is correct. SGML
has:

<appendix id="release">
<title>Release Notes</title>

<sect1 id="release-7-4-2">
<title>Release 7.4.2</title>

<note>
<title>Release date</title>
<simpara>2004-03-08</simpara>
</note>

<para>
This release contains a variety of fixes from 7.4.1.
</para>

<sect2>
<title>Migration to version 7.4.2</title>

Appendix/release should be H1, release-7-4-2 should be H2, and migration
H3. I don't see any logic for appendix and sect1 be the same HTML
heading level because they don't seem to be the same level in SGML.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073
#8Peter Eisentraut
peter_e@gmx.net
In reply to: Bruce Momjian (#3)
Re: pgsql-server/doc/src/sgml Makefile

Bruce Momjian wrote:

In the old days, only I did HISTORY. Now that others are doing it,
which is good, we should standardize to prevent CVS from recording
massive changes to HISTORY for different versions of lynx.

A better approach for that would be to remove HISTORY from CVS and build
it only when the release tarball is made.

#9Peter Eisentraut
peter_e@gmx.net
In reply to: Tom Lane (#6)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Tom Lane wrote:

So indeed it looks like the discrepancy is in the SGML stylesheet.
I'm not real sure whether the <H3> interpretation should be preferred
--- Peter, any comments?

Check the version of your stylesheet. It should be visible in the
<META> headers of the generated HTML somewhere.

#10Tom Lane
tgl@sss.pgh.pa.us
In reply to: Peter Eisentraut (#8)
Re: pgsql-server/doc/src/sgml Makefile

Peter Eisentraut <peter_e@gmx.net> writes:

A better approach for that would be to remove HISTORY from CVS and build
it only when the release tarball is made.

Given some standardization of the toolchain, that would be the way to
go. Right now, though, we seem to have some doubts at both the SGML
and lynx levels. Can we clear these up so people know what they will
get?

regards, tom lane

#11Tom Lane
tgl@sss.pgh.pa.us
In reply to: Peter Eisentraut (#9)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Peter Eisentraut <peter_e@gmx.net> writes:

Tom Lane wrote:

So indeed it looks like the discrepancy is in the SGML stylesheet.
I'm not real sure whether the <H3> interpretation should be preferred
--- Peter, any comments?

Check the version of your stylesheet. It should be visible in the
<META> headers of the generated HTML somewhere.

Is this what you're looking for?

<TITLE

Release Notes</TITLE
<META

NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.59"></HEAD

<BODY

regards, tom lane

#12Peter Eisentraut
peter_e@gmx.net
In reply to: Tom Lane (#11)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Tom Lane wrote:

<META

NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.59"></HEAD

This qualifies as ancient. Newer versions are available from

http://docbook.sourceforge.net/projects/dsssl/index.html

#13Tom Lane
tgl@sss.pgh.pa.us
In reply to: Peter Eisentraut (#12)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Peter Eisentraut <peter_e@gmx.net> writes:

Tom Lane wrote:

CONTENT="Modular DocBook HTML Stylesheet Version 1.59"></HEAD

This qualifies as ancient. Newer versions are available from
http://docbook.sourceforge.net/projects/dsssl/index.html

Okay. I see that both postgresql.org and Bruce are generating the docs
with
Modular DocBook HTML Stylesheet Version 1.7
Shall we standardize on that and lynx 2.8.5 as the current "official"
versions to use for building the docs?

Also, I'm running openjade 1.3 on this machine, and as I recall it was
a serious pain in the arse to build. Is it worth worrying about a newer
version of that?

regards, tom lane

#14Peter Eisentraut
peter_e@gmx.net
In reply to: Tom Lane (#13)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Tom Lane wrote:

Okay. I see that both postgresql.org and Bruce are generating the
docs with
Modular DocBook HTML Stylesheet Version 1.7

There is no version "1.7". This is in fact a bug; the correct version
number of the latest version (which is in use at postgresql.org) is
1.78.

Shall we standardize on that and lynx 2.8.5 as the current "official"
versions to use for building the docs?

Works for me.

Also, I'm running openjade 1.3 on this machine, and as I recall it
was a serious pain in the arse to build. Is it worth worrying about
a newer version of that?

Well, there is 1.3.2 now, but I can't tell you how easy or hard to build
that one is. There is also a 1.4 in the making, but the whole DSSSL
toolchain is sort of dying.

#15Tom Lane
tgl@sss.pgh.pa.us
In reply to: Peter Eisentraut (#14)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Peter Eisentraut <peter_e@gmx.net> writes:

Tom Lane wrote:

Also, I'm running openjade 1.3 on this machine, and as I recall it
was a serious pain in the arse to build. Is it worth worrying about
a newer version of that?

Well, there is 1.3.2 now, but I can't tell you how easy or hard to build
that one is. There is also a 1.4 in the making, but the whole DSSSL
toolchain is sort of dying.

Having re-read my notes about installing 1.3 from source, I won't shed a
tear if it dies. Should I be thinking of installing something else
instead, and if so what?

regards, tom lane

#16Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#13)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Tom Lane wrote:

Peter Eisentraut <peter_e@gmx.net> writes:

Tom Lane wrote:

CONTENT="Modular DocBook HTML Stylesheet Version 1.59"></HEAD

This qualifies as ancient. Newer versions are available from
http://docbook.sourceforge.net/projects/dsssl/index.html

Okay. I see that both postgresql.org and Bruce are generating the docs
with
Modular DocBook HTML Stylesheet Version 1.7
Shall we standardize on that and lynx 2.8.5 as the current "official"
versions to use for building the docs?

2.8.5 is a development release of lynx, not a stable one:

Lynx Version 2.8.5dev.16 (01 Jun 2003)

Do we want to standardize on a development version of some tools? It is
only converting to text, so I guess it is OK.

I downloaded the version of lynx Tom has just so I can generate the
newer output. The only difference between my 2.8.3 lynx and 2.8.5 is
that 2.8.5 trips spaces on blank lines used between headings, which is
good.

I have also rebuilt the HISTORY file in CVS to match our official style
sheets.

Also, I'm running openjade 1.3 on this machine, and as I recall it was
a serious pain in the arse to build. Is it worth worrying about a newer
version of that?

I can help you because I just installed new tools a few months ago. I
will phone you.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073
#17Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#10)
Re: pgsql-server/doc/src/sgml Makefile

Tom Lane wrote:

Peter Eisentraut <peter_e@gmx.net> writes:

A better approach for that would be to remove HISTORY from CVS and build
it only when the release tarball is made.

Given some standardization of the toolchain, that would be the way to
go. Right now, though, we seem to have some doubts at both the SGML
and lynx levels. Can we clear these up so people know what they will
get?

I think the only reason HISTORY and INSTALL are in CVS is because we
want people running CVS during beta to have changes docs and install
instructions that don't require them to pull down a new tarball each
time or read the docs via a web site.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073
#18Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#16)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Bruce Momjian <pgman@candle.pha.pa.us> writes:

2.8.5 is a development release of lynx, not a stable one:
Lynx Version 2.8.5dev.16 (01 Jun 2003)

2.8.5rel1 is a release version that has been out for some time.
If you're running a development version, that's not my problem.

#19Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#17)
Re: pgsql-server/doc/src/sgml Makefile

Bruce Momjian <pgman@candle.pha.pa.us> writes:

Peter Eisentraut <peter_e@gmx.net> writes:

A better approach for that would be to remove HISTORY from CVS and build
it only when the release tarball is made.

I think the only reason HISTORY and INSTALL are in CVS is because we
want people running CVS during beta to have changes docs and install
instructions that don't require them to pull down a new tarball each
time or read the docs via a web site.

That argument seems a bit silly for HISTORY, seeing that it's generally
not up-to-date during beta testing. As for INSTALL, those instructions
don't change fast enough to surprise beta testers, so I'm not convinced
about it either.

regards, tom lane

#20Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#19)
Re: [COMMITTERS] pgsql-server/doc/src/sgml Makefile

Tom Lane wrote:

Bruce Momjian <pgman@candle.pha.pa.us> writes:

Peter Eisentraut <peter_e@gmx.net> writes:

A better approach for that would be to remove HISTORY from CVS and build
it only when the release tarball is made.

I think the only reason HISTORY and INSTALL are in CVS is because we
want people running CVS during beta to have changes docs and install
instructions that don't require them to pull down a new tarball each
time or read the docs via a web site.

That argument seems a bit silly for HISTORY, seeing that it's generally
not up-to-date during beta testing. As for INSTALL, those instructions
don't change fast enough to surprise beta testers, so I'm not convinced
about it either.

Actually, recent releases had a current HISTORY before beta started.
However, if they are downloading the beta tarballs, the HISTORY/INSTALL
files are already generated. It would only be useful for CVS pulls
during beta though.

One idea would be to replace file content with a single URL that points
to the development docs, then when the tarball is built, it can
overwrite those files.

Marc?

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073
#21Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#20)
#22The Hermit Hacker
scrappy@hub.org
In reply to: Bruce Momjian (#20)
#23Bruce Momjian
bruce@momjian.us
In reply to: The Hermit Hacker (#22)
#24Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#18)
#25The Hermit Hacker
scrappy@hub.org
In reply to: Bruce Momjian (#23)
#26Peter Eisentraut
peter_e@gmx.net
In reply to: Bruce Momjian (#20)
#27Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#24)
#28Tom Lane
tgl@sss.pgh.pa.us
In reply to: The Hermit Hacker (#25)
#29Peter Eisentraut
peter_e@gmx.net
In reply to: Tom Lane (#28)
#30The Hermit Hacker
scrappy@hub.org
In reply to: Tom Lane (#28)
#31Peter Eisentraut
peter_e@gmx.net
In reply to: The Hermit Hacker (#25)
#32The Hermit Hacker
scrappy@hub.org
In reply to: Peter Eisentraut (#31)
#33Bruce Momjian
bruce@momjian.us
In reply to: Peter Eisentraut (#29)
#34Tom Lane
tgl@sss.pgh.pa.us
In reply to: The Hermit Hacker (#32)
#35The Hermit Hacker
scrappy@hub.org
In reply to: Bruce Momjian (#33)
#36The Hermit Hacker
scrappy@hub.org
In reply to: Tom Lane (#34)
#37Bruno Wolff III
bruno@wolff.to
In reply to: Bruce Momjian (#16)
#38Bruno Wolff III
bruno@wolff.to
In reply to: Tom Lane (#21)
#39Bruce Momjian
bruce@momjian.us
In reply to: Peter Eisentraut (#26)
#40Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#39)
#41Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#40)
#42Peter Eisentraut
peter_e@gmx.net
In reply to: The Hermit Hacker (#32)
#43Tom Lane
tgl@sss.pgh.pa.us
In reply to: Peter Eisentraut (#42)