Skip to content

Commit c938243

Browse files
author
florian
committed
Merge the contents of docs/internals/howto_build_documentation
into docs/README. Remove the section about the XML Toolchain as it is outdated. git-svn-id: svn://svn.valgrind.org/valgrind/trunk@15019 a5019735-40e9-0310-863c-91ae7b9d1cf9
1 parent 2e5fea2 commit c938243

File tree

3 files changed

+53
-92
lines changed

3 files changed

+53
-92
lines changed

README_DEVELOPERS

+3-2
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@ will also attempt to build the documentation.
2828

2929
If you only want to test whether the generated tarball is complete and runs
3030
regression tests successfully, building documentation is not needed.
31-
Edit docs/Makefile.am, search for BUILD_ALL_DOCS and follow instructions there.
31+
32+
make dist BUILD_ALL_DOCS=no
3233

3334
If you insist on building documentation some embarrassing instructions
34-
can be found in docs/internals/howto_build_documentation.
35+
can be found in docs/README.
3536

3637

3738
Running the regression tests

docs/README

+50-49
Original file line numberDiff line numberDiff line change
@@ -76,47 +76,56 @@ could just build the docs from XML when doing 'make install', which
7676
would be simpler.
7777

7878

79-
The XML Toolchain
80-
------------------
81-
I spent some time on the docbook-apps list in order to ascertain
82-
the most-useful / widely-available / least-fragile / advanced
83-
toolchain. Basically, everything has problems of one sort or
84-
another, so I ended up going with what I felt was the
85-
least-problematical of the various options.
86-
87-
The maintainer is responsible for ensure the following tools are
88-
present on his system:
89-
- xmllint: using libxml version 20620
90-
- xsltproc: Using libxml 20620, libxslt 10114 and libexslt 812
91-
(Nb:be sure to use a version based on libxml2
92-
version 2.6.11 or later. There was a bug in
93-
xml:base processing in versions before that.)
94-
- pdfxmltex: pdfeTeX 3.141592-1.21a-2.2 (Web2C 7.5.4)
95-
- pdftops: version 3.00
96-
- DocBook: version 4.2
97-
- bzip2
98-
99-
A big problem is latency. Norman Walsh is constantly updating
100-
DocBook, but the tools tend to lag behind somewhat. It is
101-
important that the versions get on with each other. If you
102-
decide to upgrade something, then it is your responsibility to
103-
ascertain whether things still work nicely - this *cannot* be
104-
assumed.
105-
106-
Print output: if make expires with an error, cat output.
107-
If you see something like this:
108-
! TeX capacity exceeded, sorry [pool size=436070]
109-
110-
then look at this:
111-
http://lists.debian.org/debian-doc/2003/12/msg00020.html
112-
and modify your texmf files accordingly.
113-
114-
115-
116-
Catalog/Stylesheet Location
117-
---------------------------
118-
/etc/xml/ seems to have become the standard place for catalogs
119-
in recent distros.
79+
Notes on building PDF / PS documents
80+
------------------------------------
81+
Below are random notes and recollections about how to build PDF / PS
82+
documents from the XML source at various times on various Linux distros.
83+
84+
85+
Notes [Mar 2015]
86+
----------------
87+
On Ubuntu 14.04.2 LTS the following is known to work:
88+
89+
Required packages:
90+
texlive
91+
dblatex
92+
xsltproc
93+
xmltex
94+
docbook-xml
95+
docbook-xsl
96+
97+
Additional the following lines need to be changed in
98+
/usr/share/texlive/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty
99+
around line 450 from
100+
101+
102+
\ifETE@prepend
103+
\expandafter\PrependGraphicsExtensions
104+
\else
105+
\expandafter\AppendGraphicsExtensions
106+
\fi
107+
{.eps}
108+
109+
110+
to
111+
112+
113+
%% \ifETE@prepend
114+
%% \expandafter\PrependGraphicsExtensions
115+
%% \else
116+
%% \expandafter\AppendGraphicsExtensions
117+
%% \fi
118+
%% {.eps}
119+
120+
This hack was devised by Mark Wielaard.
121+
122+
123+
Notes [Aug. 2012]
124+
-----------------
125+
On Ubuntu 10.04 there was a new capacity-related failure whilst
126+
building the print docs in the run up to the 3.8.0 release. This was
127+
fixed by editing /etc/texmf/texmf.cnf and changing pool_size to
128+
2000000.
120129

121130

122131
Notes [May 2009]
@@ -140,14 +149,6 @@ if it can't find this one:
140149
I haven't succeeded in building the print docs.
141150

142151

143-
Notes [Aug. 2012]
144-
-----------------
145-
On Ubuntu 10.04 there was a new capacity-related failure whilst
146-
building the print docs in the run up to the 3.8.0 release. This was
147-
fixed by editing /etc/texmf/texmf.cnf and changing pool_size to
148-
2000000.
149-
150-
151152
Notes [Mar. 2007]
152153
-----------------
153154
For SuSE 10.1, I have to install the following packages to get a

docs/internals/howto_build_documentation

-41
This file was deleted.

0 commit comments

Comments
 (0)