1
0
mirror of https://github.com/postgres/postgres.git synced 2025-11-07 19:06:32 +03:00
Commit Graph

101 Commits

Author SHA1 Message Date
Tom Lane
f1e522696f Don't generate plain-text HISTORY and src/test/regress/README anymore.
Providing this information as plain text was doubtless worth the trouble
ten years ago, but it seems likely that hardly anyone reads it in this
format anymore.  And the effort required to maintain these files (in the
form of extra-complex markup rules in the relevant parts of the SGML
documentation) is significant.  So, let's stop doing that and rely solely
on the other documentation formats.

Per discussion, the plain-text INSTALL instructions might still be worth
their keep, so we continue to generate that file.

Rather than remove HISTORY and src/test/regress/README from distribution
tarballs entirely, replace them with simple stub files that tell the reader
where to find the relevant documentation.  This is mainly to avoid possibly
breaking packaging recipes that expect these files to exist.

Back-patch to all supported branches, because simplifying the markup
requirements for release notes won't help much unless we do it in all
branches.
2014-02-10 20:48:12 -05:00
Peter Eisentraut
743b73bdf5 doc: A few awkward phrasing fixes
Josh Kupershmidt
2013-03-03 08:49:49 -05:00
Peter Eisentraut
44c03efee3 doc: Fix broken links to DocBook wiki 2012-12-01 01:52:23 -05:00
Robert Haas
152525b5f3 Document that xslt-related RPMs may be needed to build docs. 2012-08-30 10:39:03 -04:00
Peter Eisentraut
26a6267226 Add instructions for setting up documentation tool chain on Mac OS X 2012-08-23 02:29:21 -04:00
Peter Eisentraut
5baf6da717 Documentation spell and markup checking 2012-06-08 00:06:20 +03:00
Peter Eisentraut
1c882e07da Split contrib documentation into extensions and programs
Create separate appendixes for contrib extensions and other server
plugins on the one hand, and utility programs on the other.  Recast
the documentation of the latter as refentries, so that man pages are
generated.
2012-05-09 20:39:53 +03:00
Peter Eisentraut
3aa42c25c3 Put Debian package list back in alphabetical order 2012-02-24 20:40:29 +02:00
Bruce Momjian
a870c7fdbc Add opensp as a requirement for building the docs on Debian --- tested
on Debian Squeeze.
2012-02-07 20:30:11 -05:00
Peter Eisentraut
f44d275b6d Document minimum required version of DocBook XSL stylesheets 2011-08-27 23:28:55 +03:00
Robert Haas
07e58cbe19 Advise Debian/Ubuntu users to use openjade1.3.
The latest openjade packages for Ubuntu 10.10 seg fault when building
our documentation.

Josh Berkus
2011-04-14 11:35:41 -07:00
Bruce Momjian
5d5678d7c3 Properly capitalize documentation headings; some only had initial-word
capitalization.
2011-01-29 13:01:48 -05:00
Peter Eisentraut
fc946c39ae Remove useless whitespace at end of lines 2010-11-23 22:34:55 +02:00
Peter Eisentraut
402e11913f Remove reference.ced
This is a parsed DocBook DTD for the PSGML Emacs mode, but it hasn't
been updated since we switched to DocBook 4.2 about seven years ago.
Also, PSGML has deprecated this method of DTD parsing.
2010-10-14 23:16:46 +03:00
Magnus Hagander
9f2e211386 Remove cvs keywords from all files. 2010-09-20 22:08:53 +02:00
Peter Eisentraut
5194b9d049 Spell and markup checking 2010-08-17 04:37:21 +00:00
Peter Eisentraut
7de38696c4 Add target to build HTML documentation as single page 2010-06-12 09:55:12 +00:00
Bruce Momjian
a128991705 Overflow box is on page after listed page number, per Alvaro. 2010-05-31 22:42:59 +00:00
Bruce Momjian
0b4150323b Update TeX overflow documentation page pattern mask, in docs. 2010-05-31 22:15:25 +00:00
Bruce Momjian
66dd050560 Document how to find TeX overflow boxes in our documentation build, per
details from Alvaro Herrera.
2010-05-31 22:14:20 +00:00
Peter Eisentraut
a95e51962d Update broken and permanently moved links 2010-03-17 17:12:31 +00:00
Bruce Momjian
4fa69e566c Revert mention that HTML documentation has to be built first.
Now require gmake 3.79.1 or later to build source/sgml.
2010-01-22 22:50:03 +00:00
Bruce Momjian
9ca0989037 Document that the HTML documentation must be built before the PDF
documentation.
2010-01-22 15:49:29 +00:00
Peter Eisentraut
ed9208829a Ship documentation without intermediate tarballs
Documentation files in HTML and man formats are now prepared for
distribution using the distprep make target, like everything else.  They
are placed in doc/src/sgml/html and manX and installed from there by
make install, if present.  The business with the tarballs in the tarball
is gone.
2009-08-09 22:47:59 +00:00
Peter Eisentraut
c29d7f02c2 Use DocBook XSL stylesheets for man page building
This switches the man page building process to use the DocBook XSL stylesheet
toolchain.  The previous targets for Docbook2X are removed. configure has been
updated to look for the new tools.  The Documentation appendix contains the
new build instructions.  There are also a few isolated tweaks in the
documentation to improve places that came out strangely in the man pages.
2009-08-04 22:04:37 +00:00
Tom Lane
c30446b9c9 Proofreading for Bruce's recent round of documentation proofreading.
Most of those changes were good, but some not so good ...
2009-06-17 21:58:49 +00:00
Bruce Momjian
ba36c48e39 Proofreading adjustments for first two parts of documentation (Tutorial
and SQL).
2009-04-27 16:27:36 +00:00
Alvaro Herrera
aa3288146a Update URL to Docbook DSSSL stylesheets, per Gabriele Bartolini. 2008-11-03 15:39:38 +00:00
Peter Eisentraut
cdd0895978 Update man page build instructions. 2008-09-12 08:43:53 +00:00
Peter Eisentraut
1ed168fc1b Update required TeX settings 2007-12-28 11:13:55 +00:00
Bruce Momjian
4ab7ea5ace Remove tabs from SGML files to help tag alingment and improve
detection of tabs are added in the future.
2007-02-16 03:50:29 +00:00
Bruce Momjian
09a9f10e7f Consistenly use colons before '<programlisting>' blocks, where
appropriate.
2007-02-01 00:28:19 +00:00
Bruce Momjian
a134ee3379 Update documentation on may/can/might:
Standard English uses "may", "can", and "might" in different ways:

        may - permission, "You may borrow my rake."

        can - ability, "I can lift that log."

        might - possibility, "It might rain today."

Unfortunately, in conversational English, their use is often mixed, as
in, "You may use this variable to do X", when in fact, "can" is a better
choice.  Similarly, "It may crash" is better stated, "It might crash".

Also update two error messages mentioned in the documenation to match.
2007-01-31 20:56:20 +00:00
Teodor Sigaev
b62f85691e Update FreeBSD DocBook installation notices 2007-01-31 15:23:28 +00:00
Bruce Momjian
3ec7ae1b67 Modify SGML makefile to allow 'gmake draft' to build draft html ('draft'
is now a target, no longer a modifier).
2007-01-27 22:44:32 +00:00
Bruce Momjian
320abc3a95 Modify draft SGML instructions to use DRAFT=Y because recursion was
causing html to be called twice --- no way to exit the makefile after
the recursion returns.
2007-01-26 22:23:50 +00:00
Bruce Momjian
ebdee66d5f Remove SGML makefile .SECONDARY tag so html rules will work properly;
Documentation/comment improvements.
2007-01-11 00:02:39 +00:00
Bruce Momjian
f3a7068a54 Build SGML documention output several times if necessary to have proper
indexes;  add 'draft' option to disable it.
2007-01-09 22:19:36 +00:00
Bruce Momjian
421c1ca48d Back out double-run of PDF/PS output. Requires building bookindex.sgml
properly.

Remove SGML docs about openjade performance patch, and instead add
comment in style sheet where indenting code is commented out.

Backpatch to 8.2.X.
2006-12-15 16:50:07 +00:00
Bruce Momjian
c4dfc4137e Document patch needed to get PDF and PS output in a reasonable amount of
time.
2006-12-15 02:44:28 +00:00
Peter Eisentraut
314c7b642b Make separate targets for building printable documentation in A4 and
US letter paper formats.
2006-12-10 20:46:03 +00:00
Peter Eisentraut
0a265e487b Add some information about increasing JadeTeX parameters. 2006-12-10 02:37:40 +00:00
Peter Eisentraut
0f763503ff Spellchecking and such 2006-10-23 18:10:32 +00:00
Peter Eisentraut
033cb9d30b Fix list of environment variables for configure. Remove some variables
that are almost never used.  Put documentation-related variables into the
documentation chapter.
2006-10-23 14:13:43 +00:00
Bruce Momjian
32cebaecff Remove emacs info from footer of SGML files. 2006-09-16 00:30:20 +00:00
Tom Lane
5e6bbc21f4 Add missing quote, per Dave Page. 2005-05-13 16:48:14 +00:00
Bruce Momjian
0e2f88a6d5 We don't put URL's in ulink's because the URL is always generated, but
we can put words in ulink and the URL will still be printed.

per Peter
2005-04-09 03:52:43 +00:00
Bruce Momjian
fd977434b3 Adjust SGML ulink tags to the URL is always displayed in our printed docs. 2005-03-31 03:54:38 +00:00
Bruce Momjian
2abe40aac7 Fix typo in SGML. 2005-02-19 04:39:52 +00:00
Bruce Momjian
eea1ef2c85 Add reference to the NewbieDoc Docbook Guide. 2005-02-19 04:34:17 +00:00