[PATCH xorg-docs 0/2] Add DocBook external references support

Gaetan Nadon memsize at videotron.ca
Tue Mar 22 07:19:44 PDT 2011

The docbook.am is the new reusable makefile which replaces xmlrules.in.
It will be checked-in unmodified in all modules where user docs
or specs is used. For devel docs, a different makefile will be used.

The README in xorg-sgml-doctools gives all the essentials.

Other required patches:

New xhtml and fo stylesheets in xorg-sgml-doctools.
New macros in version 1.14 of util-macros

This is a draft for review, the final patch will have the version matching
for doctools and util-macros.

An olink example which can be added in a <para>graph:
 <olink targetdoc='secint' targetptr='secint'>SECURITY extension</olink>

While xmlto provides some convenience, it also lacks flexibility
(the usual price to pay). Large projects like Apache do not use it,
and we had someone helping out which recommended not using it.

As we are adding more features to the DocBook documentation,
the requirements to build it may increase. The capability
to build it in each module and on all platforms has been retained.

The text format is still available using the same w3m tool that
xmlto was using. Should there be issues with a specific tool,
there is flexibility to find a solution.

Gaetan Nadon (2):
  Documentation: add Docbook external references support
  Replace XMLTO with XSLTPROC, XMLLINT and W3M tools

 .gitignore                    |    2 +
 configure.ac                  |   13 +++--
 docbook.am                    |  103 +++++++++++++++++++++++++++++++++++++++++
 general/Makefile.am           |   18 ++++---
 general/fonts/Makefile.am     |   13 ++++--
 general/graphics/Makefile.am  |   13 ++++--
 general/input/Makefile.am     |   13 ++++--
 general/platforms/Makefile.am |   15 ++++--
 specs/CTEXT/Makefile.am       |   14 ++++--
 specs/ICCCM/Makefile.am       |   14 ++++--
 specs/XLFD/Makefile.am        |   14 ++++--
 specs/Xext/Makefile.am        |   14 ++++--
 specs/Xserver/Makefile.am     |   12 +++--
 xmlrules.in                   |   65 --------------------------
 14 files changed, 208 insertions(+), 115 deletions(-)
 create mode 100644 docbook.am
 delete mode 100644 xmlrules.in

More information about the xorg-devel mailing list