INSTALL: configure /etc/xml/catalog to build docs on Cygwin
Without additional configuration steps, the documentation build on Cygwin fails because the XML catalog is missing required rewrites for certain docbook resources. This patch documents the required configuration. Signed-off-by: Jon Seymour <jon.seymour@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jon Seymour committed
Jul 25, 2010 at 13:57 UTC
0edf06dc4008ff8152cf777c44875ef49d04b6f7
1 file changed
+33
INSTALL
+33
@@ -157,3 +157,36 @@ Issues of note:
157
It has been reported that docbook-xsl version 1.72 and 1.73 are
158
buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
159
the patch in contrib/patches/docbook-xsl-manpages-charmap.patch
160
+
161
+ Users attempting to build the documentation on Cygwin may need to ensure
162
+ that the /etc/xml/catalog file looks something like this:
163
+
164
+ <?xml version="1.0"?>
165
+ <!DOCTYPE catalog PUBLIC
166
+ "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
167
+ "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"
168
+ >
169
+ <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
170
+ <rewriteURI
171
+ uriStartString = "http://docbook.sourceforge.net/release/xsl/current"
172
+ rewritePrefix = "/usr/share/sgml/docbook/xsl-stylesheets"
173
+ />
174
+ <rewriteURI
175
+ uriStartString="http://www.oasis-open.org/docbook/xml/4.5"
176
+ rewritePrefix="/usr/share/sgml/docbook/xml-dtd-4.5"
177
+ />
178
+ </catalog>
179
+
180
+ This can be achieved with the following two xmlcatalog commands:
181
+
182
+ xmlcatalog --noout \
183
+ --add rewriteURI \
184
+ http://docbook.sourceforge.net/release/xsl/current \
185
+ /usr/share/sgml/docbook/xsl-stylesheets \
186
+ /etc/xml/catalog
187
+
188
+ xmlcatalog --noout \
189
+ --add rewriteURI \
190
+ http://www.oasis-open.org/docbook/xml/4.5/xsl/current \
191
+ /usr/share/sgml/docbook/xml-dtd-4.5 \
192
+ /etc/xml/catalog