1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-23 17:34:34 +03:00
samba-mirror/docs-xml/build
Michael Adam 2d30e5deaf docs: add popt.common.samba.server and popt.common.samba.client entities
These are comprised by the popt.common.samba entity and the stdarg.server.debug
or the stdarg.client.debut entity, respectively.
The difference is only in the default value of the debug level setting.

Signed-off-by: Michael Adam <obnox@samba.org>
Reviewed-by: Volker Lendecke <vl@samba.org>
2013-01-15 14:49:19 +01:00
..
DTD docs: add popt.common.samba.server and popt.common.samba.client entities 2013-01-15 14:49:19 +01:00
catalog.xml.in docs-xml: convert smb.conf.5 build to waf 2012-09-17 14:18:31 +02:00
README Moving docs tree to docs-xml to make room for generated docs in the release tarball. 2008-04-23 08:47:48 -05:00

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.