Add first cut at networkless build instructions for samba-docs
authorAlexander Bokovoy <ab@samba.org>
Sun, 13 Apr 2008 20:11:27 +0000 (20:11 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 13:47:45 +0000 (08:47 -0500)
(This used to be commit 86bfaa5a1ccc1feff567e3ce5a5374a7b58d65d8)

docs/build/README [new file with mode: 0644]
docs/build/catalog.xml.in [moved from docs/build/catalog.xml with 79% similarity]

diff --git a/docs/build/README b/docs/build/README
new file mode 100644 (file)
index 0000000..736f673
--- /dev/null
@@ -0,0 +1,26 @@
+HOW TO BUILD SAMBA DOCUMENTATION WITHOUT NETWORK ACCESS
+-------------------------------------------------------
+
+Samba documentation depends on several DTD schema specification and XML files
+that are stored in samba-web Subversion repository and hosted publicly through
+Samba.org web-site. In order to do networkless builds a local XML catalog should
+provide a local replica of those files.
+
+The easiest way to provide them is to fetch samba-docs subversion repository.
+In this directory (build/) we reference samba-web repository as external source
+so that Subversion fetches current state of DTDs out of samba-web repository.
+You then need to point xsltproc utility to use locally-provided version of DTDs.
+
+It is done by setting XML_CATALOG_FILES variable:
+
+export XML_CATALOG_FILES="file:///etc/xml/catalog file://$(pwd)/build/catalog.xml"
+
+where $(pwd)/build/catalog.xml is generated from $(pwd)/build/catalog.xml.in by a 
+following command:
+
+cat $(pwd)/build/catalog.xml.in | sed -e "s|@BUILDDIR@|$(pwd)|g" > $(pwd)/build/catalog.xml
+
+where $(pwd) assumes that you're in the top-level directory of samba-docs.
+
+After those steps a regular make process can be followed and xsltproc will automatically
+use locally-provided DTDs through catalog.xml we've created.
similarity index 79%
rename from docs/build/catalog.xml
rename to docs/build/catalog.xml.in
index 912b7cc428497fb69eb2269c5ba5b49349f9e4ff..03ac0bdd99eed67ebd259f05a4b76ff4a910393e 100644 (file)
@@ -6,9 +6,9 @@
 
     <rewriteURI
                        uriStartString="http://www.samba.org/samba/DTD/"
-                       rewritePrefix="file://@DIR@/build/DTD/"/>
+                       rewritePrefix="file://@BUILDDIR@/build/DTD/"/>
 
     <rewriteURI
                        uriStartString="http://www.gnu.org/licenses/"
-                       rewritePrefix="file://@DIR@/Samba3-ByExample/"/>
+                       rewritePrefix="file://@BUILDDIR@/Samba3-ByExample/"/>
 </catalog>