summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/build/README26
-rw-r--r--docs/build/catalog.xml.in (renamed from docs/build/catalog.xml)4
2 files changed, 28 insertions, 2 deletions
diff --git a/docs/build/README b/docs/build/README
new file mode 100644
index 0000000000..736f673153
--- /dev/null
+++ b/docs/build/README
@@ -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.
diff --git a/docs/build/catalog.xml b/docs/build/catalog.xml.in
index 912b7cc428..03ac0bdd99 100644
--- a/docs/build/catalog.xml
+++ b/docs/build/catalog.xml.in
@@ -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>