Re: [DOCS] [HACKERS] Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)

2014-02-12 Thread Tom Lane
Peter Eisentraut  writes:
> On 2/8/14, 4:41 PM, Tom Lane wrote:
>> + Release notes for all versions of PostgreSQL can be found on-line at
>> + http://www.postgresql.org/docs/devel/static/release.html

> Should be "current" instead of "devel"?

>> + 
>> + In a distribution file set, release notes for the current version can be
>> + found prebuilt under doc/src/sgml/html/.  Visit the index.html file with
>> + an HTML browser, then consult the "Release Notes" appendix.

> You can point them straight at doc/src/sgml/html/release.html.

Done and done.  I also noticed that these instructions were wrong anyway
for 8.4, which still has the embedded-tarball HTML docs, so I adjusted
the text for that version.

regards, tom lane


-- 
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers


Re: [DOCS] [HACKERS] Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)

2014-02-12 Thread Peter Eisentraut
On 2/8/14, 4:41 PM, Tom Lane wrote:
> diff --git a/HISTORY b/HISTORY
> index ...360c7f6 .
> *** a/HISTORY
> --- b/HISTORY
> ***
> *** 0 
> --- 1,6 
> + Release notes for all versions of PostgreSQL can be found on-line at
> + http://www.postgresql.org/docs/devel/static/release.html

Should be "current" instead of "devel"?

> + 
> + In a distribution file set, release notes for the current version can be
> + found prebuilt under doc/src/sgml/html/.  Visit the index.html file with
> + an HTML browser, then consult the "Release Notes" appendix.

You can point them straight at doc/src/sgml/html/release.html.


-- 
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers


Re: [DOCS] [HACKERS] Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)

2014-02-09 Thread Robert Haas
On Sat, Feb 8, 2014 at 4:41 PM, Tom Lane  wrote:
> I wrote:
>> Gavin Flower  writes:
>>> How about adding URL's for the online versions of HISTORY & README's (or
>>> their rough equivalents - perhaps the online version of the latest
>>> 'Appendix E. Release Notes' would be sufficient?) to the INSTALL file?
>
>> Actually, what I had in mind was to replace the dynamically-generated
>> HISTORY and README files with small text files that contain those
>> URL references.
>
> Here's a proposed patch against HEAD for this.  It also gets rid of some
> rather quaint instructions for using Netscape to construct these files ;-)
>
> Barring objection, I'd like to update all the live branches this way
> before the upcoming releases.  I'm tired of having to worry about
> whether the release notes will build as plain text; but that worry
> won't go away unless we nuke the text output in all the branches.

Sounds OK to me.  If there's as many as two people using those files,
I'll be surprised.  (Of course, I've been surprised before.)

-- 
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company


-- 
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers


Re: [DOCS] [HACKERS] Viability of text HISTORY/INSTALL/regression README files (was Re: [COMMITTERS] pgsql: Document a few more regression test hazards.)

2014-02-08 Thread Tom Lane
I wrote:
> Gavin Flower  writes:
>> How about adding URL's for the online versions of HISTORY & README's (or 
>> their rough equivalents - perhaps the online version of the latest 
>> 'Appendix E. Release Notes' would be sufficient?) to the INSTALL file?

> Actually, what I had in mind was to replace the dynamically-generated
> HISTORY and README files with small text files that contain those
> URL references.

Here's a proposed patch against HEAD for this.  It also gets rid of some
rather quaint instructions for using Netscape to construct these files ;-)

Barring objection, I'd like to update all the live branches this way
before the upcoming releases.  I'm tired of having to worry about
whether the release notes will build as plain text; but that worry
won't go away unless we nuke the text output in all the branches.

regards, tom lane

diff --git a/GNUmakefile.in b/GNUmakefile.in
index 40ab280..a573880 100644
*** a/GNUmakefile.in
--- b/GNUmakefile.in
*** distdir:
*** 103,112 
  	  fi || exit; \
  	done
  	$(MAKE) -C $(distdir) distprep
! 	$(MAKE) -C $(distdir)/doc/src/sgml/ HISTORY INSTALL regress_README
! 	cp $(distdir)/doc/src/sgml/HISTORY $(distdir)/
  	cp $(distdir)/doc/src/sgml/INSTALL $(distdir)/
- 	cp $(distdir)/doc/src/sgml/regress_README $(distdir)/src/test/regress/README
  	$(MAKE) -C $(distdir) distclean
  	rm -f $(distdir)/README.git
  
--- 103,110 
  	  fi || exit; \
  	done
  	$(MAKE) -C $(distdir) distprep
! 	$(MAKE) -C $(distdir)/doc/src/sgml/ INSTALL
  	cp $(distdir)/doc/src/sgml/INSTALL $(distdir)/
  	$(MAKE) -C $(distdir) distclean
  	rm -f $(distdir)/README.git
  
diff --git a/HISTORY b/HISTORY
index ...360c7f6 .
*** a/HISTORY
--- b/HISTORY
***
*** 0 
--- 1,6 
+ Release notes for all versions of PostgreSQL can be found on-line at
+ http://www.postgresql.org/docs/devel/static/release.html
+ 
+ In a distribution file set, release notes for the current version can be
+ found prebuilt under doc/src/sgml/html/.  Visit the index.html file with
+ an HTML browser, then consult the "Release Notes" appendix.
diff --git a/README b/README
index 49d55af..302028e 100644
*** a/README
--- b/README
*** See the file INSTALL for instructions on
*** 17,24 
  PostgreSQL.  That file also lists supported operating systems and
  hardware platforms and contains information regarding any other
  software packages that are required to build or run the PostgreSQL
! system.  Changes between all PostgreSQL releases are recorded in the
! file HISTORY.  Copyright and license information can be found in the
  file COPYRIGHT.  A comprehensive documentation set is included in this
  distribution; it can be read as described in the installation
  instructions.
--- 17,23 
  PostgreSQL.  That file also lists supported operating systems and
  hardware platforms and contains information regarding any other
  software packages that are required to build or run the PostgreSQL
! system.  Copyright and license information can be found in the
  file COPYRIGHT.  A comprehensive documentation set is included in this
  distribution; it can be read as described in the installation
  instructions.
diff --git a/README.git b/README.git
index d5378b4..0bf2b56 100644
*** a/README.git
--- b/README.git
***
*** 1,12 
  (This file does not appear in release tarballs.)
  
! In a release or snapshot tarball of PostgreSQL, documentation files named
! INSTALL and HISTORY will appear in this directory.  However, these files are
! not stored in git and so will not be present if you are using a git checkout.
! If you are using git, you can view the most recent install instructions at:
  	http://www.postgresql.org/docs/devel/static/installation.html
- and the current release notes at:
- 	http://www.postgresql.org/docs/devel/static/release.html
  
  Users compiling from git will also need compatible versions of Bison, Flex,
  and Perl, as discussed in the install documentation.  These programs are not
--- 1,12 
  (This file does not appear in release tarballs.)
  
! In a release or snapshot tarball of PostgreSQL, a documentation file named
! INSTALL will appear in this directory.  However, this file is not stored in
! git and so will not be present if you are using a git checkout.
! 
! If you are using a git checkout, you can view the most recent installation
! instructions at:
  	http://www.postgresql.org/docs/devel/static/installation.html
  
  Users compiling from git will also need compatible versions of Bison, Flex,
  and Perl, as discussed in the install documentation.  These programs are not
diff --git a/doc/src/sgml/.gitignore b/doc/src/sgml/.gitignore
index e1b84b4..2f0329c 100644
*** a/doc/src/sgml/.gitignore
--- b/doc/src/sgml/.gitignore
***
*** 6,14 
  /man7/
  /man-stamp
  # Other popular build targets
- /HISTORY
  /INSTALL
- /regress_README
  /postgres-US.pdf
  /postgres-A4.pdf
  /postgres.html
--- 6,12