summaryrefslogtreecommitdiff
path: root/doc/src/sgml/Makefile
AgeCommit message (Collapse)Author
2014-02-12Rename 'gmake' to 'make' in docs and recommended commandsBruce Momjian
This simplifies the docs and makes it easier to cut/paste command lines.
2014-02-10Don't generate plain-text HISTORY and src/test/regress/README anymore.Tom Lane
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.
2013-11-28doc: Allow selecting web site CSS style sheet in XSLT HTML buildPeter Eisentraut
2013-10-21doc: Improve setup for documentation building with FOPPeter Eisentraut
Add a makefile rule for building PDFs with FOP. Two new build targets in doc/src/sgml are postgres-A4-fop.pdf and postgres-US-fop.pdf. Run .fo output through xmllint for reformatting, so that errors are easier to find. (The default output has hardly any line breaks, so you might be looking for an error in column 20000.) Set some XSLT parameters to optimize for building with FOP. Remove some redundant or somewhat useless chapterinfo/author information, because it renders strangely with the FO stylesheet. Reviewed-by: Álvaro Herrera <alvherre@2ndquadrant.com>
2013-10-15doc: Enable book index in XSLT buildsPeter Eisentraut
The XSLT toolchain requires an empty <index> element where the index is supposed to appear. Add that with conditionals to hide it from the DSSSL build.
2013-10-10doc: Move check-tabs target into html targetPeter Eisentraut
The previous plan of having the check-tabs target a prerequisite of "all" and "distprep" caused make distcheck to fail because make -q distprep would never be satisfied. Put check-tabs into the html target instead, so it is only called when a build actually happens.
2013-10-10doc: Handle additional character entities for SGML/XML conversionPeter Eisentraut
2013-10-10Remove maintainer-check target, fold into normal buildPeter Eisentraut
make maintainer-check was obscure and rarely called in practice, and many breakages were missed. Fold everything that make maintainer-check used to do into the normal build. Specifically: - Call duplicate_oids when genbki.pl is called. - Check for tabs in SGML files when the documentation is built. - Run msgfmt with the -c option during the regular build. Add an additional configure check to see whether we are using the GNU version. (make maintainer-check probably used to fail with non-GNU msgfmt.) Keep maintainer-check as around as phony target for the time being in case anyone is calling it. But it won't do anything anymore.
2013-02-13doc: Add make target to produce EPUB from DocBookPeter Eisentraut
2012-11-12Use a stamp file for the XSLT HTML doc buildPeter Eisentraut
This way it works more like the DSSSL build, and dependencies are tracked better by make. Also copy the CSS stylesheet to the html directory. This was forgotten when the output directory was changed.
2012-04-19Untabify DSSSL and XSL files and add to check-tabs targetPeter Eisentraut
Like with SGML files, using tabs in these files is confusing and unnecessary.
2012-03-22Fix configure's search for collateindex.pl.Tom Lane
PGAC_PATH_COLLATEINDEX supposed that it could use AC_PATH_PROGS to search for collateindex.pl, but that macro will only accept files that are marked executable, and at least some DocBook installations don't mark the script executable (a case the docs Makefile was already prepared for). Accept the script if it's present and readable in $DOCBOOKSTYLE/bin, and otherwise search the PATH as before. Having fixed that up, we don't need the fallback case that was in the docs Makefile, and instead can throw an understandable error if configure didn't find the script. Per recent trouble report from John Lumby.
2012-03-02Add a rule to optionally build docs with the stylesheet from the websiteMagnus Hagander
For those of us who prefer the formatting of the docs using the website stylesheets. Use "make STYLE=website draft" (for example) to use. The stylesheet itself is referenced directly to the website, so there is currently no copy of it stored in the source repository. Thus, docs built with it will only look correct if the browser can access the website when viewing them.
2011-06-19Produce HISTORY file consistently as ASCIIPeter Eisentraut
The release notes may contain non-ASCII characters (for contributor names), which lynx converts to the encoding determined by the current locale. The get output that is deterministic and easily readable by everyone, we make lynx produce LATIN1 and then convert that to ASCII with transliteration for the non-ASCII characters.
2011-04-04Uppercase <!ENTITY> and <!DOCTYPE> tags in SGML sourceAlvaro Herrera
This improves compatibility with external toolchains, such as those used by some documentation translation tools. Gabriele Bartolini
2011-03-28Add maintainer-check targetPeter Eisentraut
This can do various source code checks that are not appropriate for either the build or the regression tests. Currently: duplicate_oids, SGML syntax and tabs check, NLS syntax check.
2011-02-03Avoid maintaining three separate copies of the error codes list.Robert Haas
src/pl/plpgsql/src/plerrcodes.h, src/include/utils/errcodes.h, and a big chunk of errcodes.sgml are now automatically generated from a single file, src/backend/utils/errcodes.txt. Jan Urbański, reviewed by Tom Lane.
2010-11-23Remove useless whitespace at end of linesPeter Eisentraut
2010-09-22Remove anonymous cvs instructions, and replace them with instructionsMagnus Hagander
for git. Change other references from cvs to git as well.
2010-09-20Remove cvs keywords from all files.Magnus Hagander
2010-06-12postgres.txt should get cleaned by 'make clean'.Tom Lane
2010-06-12Remove lynx -stdin flag for postgres.text.Bruce Momjian
2010-06-12Add SGML Makefile rule for single-page text, postgres.txt.Bruce Momjian
2010-06-12Add space between after ">" in ">$@" in SGML Makefile, for clarity.Bruce Momjian
2010-06-12Add target to build HTML documentation as single pagePeter Eisentraut
2010-05-13Fix vpath installation from distribution tarball (bug #5447)Peter Eisentraut
2010-05-01Install hack workaround for failure of 'make all' in VPATH builds.Tom Lane
It appears that gmake gets confused if postgres.sgml is not present in the working directory, and instantiates some default rule or other that would let postgres.sgml be built from postgres.xml. I haven't been able to track down exactly where that's coming from, but the problem can be dodged by specifying srcdir explicitly in the rule for postgres.xml. Per report from Vladimir Kokovic.
2010-05-01Adjust postgres.xml rule so that make will notice a failure exit from osx.Tom Lane
The previous coding had it in a pipe, which on most shells won't report the error. Per experimentation with a bug report from Vladimir Kokovic. This doesn't actually fix his problem, but it does explain why make didn't report that there was a problem.
2010-04-02Fix the build and install rules for man pages with SQL section != 7Peter Eisentraut
The previous coding failed in various scenarios possibly including vpath builds and doing make install without preceding make all.
2010-03-30Separate targets "make docs" and "make install-docs" for the documentationPeter Eisentraut
It is no longer installed by default, but included in "make world"/"make install-world". Documentation updated accordingly. Also, fix vpathsearch function to work when calling make install-docs without previous make docs.
2010-02-05Previous commit was to have tab checking as part of gmake check.Bruce Momjian
2010-02-05*** empty log message ***Bruce Momjian
2010-02-05Add SGML 'check-tabs' Makefile rule to check for tabs.Bruce Momjian
2010-01-06Fix missing <manvolnum> markers in dblink reference entries.Tom Lane
Silences complaints from "make man", and allows these man pages to be included in man3/.
2009-12-30Revert makefile refactoring (version 1.123) because it doesn't workPeter Eisentraut
when building several files at once (e.g., gmake postgres-A4.pdf postgres-US.pdf).
2009-10-06Clean up the clean rules of the documentationPeter Eisentraut
Most things should be cleaned by "make clean", except the parts that are shipped in the tarball. These rules had gotten a bit out of whack after the various restructurings of the documentation build rules.
2009-10-06Really unbreak maintainer-clean.Alvaro Herrera
(Or rather, unbreak what the previous commit broke)
2009-10-05Unbreak doc/src/sgml maintainer-clean rule on VPATH builds.Alvaro Herrera
2009-09-14Print builds don't actually depend on html target (anymore).Peter Eisentraut
2009-08-28Derived files that are shipped in the distribution used to be built in thePeter Eisentraut
source directory even for out-of-tree builds. They are now alsl built in the build tree. This should be more convenient for certain developers' workflows, and shouldn't really break anything else.
2009-08-26Update of install-sh, mkinstalldirs, and associated configuryPeter Eisentraut
Update install-sh to that from Autoconf 2.63, plus our Darwin-specific changes (which I simplified a bit). install-sh is now able to install multiple files in one run, so we could simplify our makefiles sometime. install-sh also now has a -d option to create directories, so we don't need mkinstalldirs anymore. Use AC_PROG_MKDIR_P in configure.in, so we can use mkdir -p when available instead of install-sh -d. For consistency with the rest of the world, the corresponding make variable has been renamed from $(mkinstalldirs) to $(MKDIR_P).
2009-08-17Make version.sgml depend on configure instead of Makefile.global. ThisPeter Eisentraut
cheats a bit, but it avoids unsatisfied dependencies in distribution tarballs. (found by make distcheck)
2009-08-15Make sure that 'make distclean' cleans out all files that are not meantTom Lane
to be shipped. Also, allow 'make clean' to remove intermediate working files.
2009-08-11Remove unnecessary files from distributionPeter Eisentraut
2009-08-11Simplify and speed up man page installationPeter Eisentraut
2009-08-11Refactor some $(JADE.tex.call)sAlvaro Herrera
2009-08-09Ship documentation without intermediate tarballsPeter Eisentraut
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-05Fix manpages related to SPI functions.Alvaro Herrera
This patch adds declaration so that they end up in section 3, and adds them to the Makefiles to install them. Also, some synopses needed reflowing so that they look nice in 80-column terminals.
2009-08-04Use DocBook XSL stylesheets for man page buildingPeter Eisentraut
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-07-20Small additional clean from the rearrangement of the HTML index build rulesPeter Eisentraut