[PATCH] doc/xml: fix disabling of devel docs

Gaetan Nadon memsize at videotron.ca
Tue Dec 7 10:39:46 PST 2010

On Tue, 2010-12-07 at 19:50 +0200, Tiago Vignatti wrote:

> From: Pauli Nieminen <ext-pauli.nieminen at nokia.com>
> Co-authored-by: Tiago Vignatti <tiago.vignatti at nokia.com>
> Signed-off-by: Pauli Nieminen <ext-pauli.nieminen at nokia.com>
> Signed-off-by: Tiago Vignatti <tiago.vignatti at nokia.com>
> ---
>  doc/xml/dtrace/Makefile.am |    2 ++
>  1 files changed, 2 insertions(+), 0 deletions(-)
> diff --git a/doc/xml/dtrace/Makefile.am b/doc/xml/dtrace/Makefile.am
> index 0e25e5d..a941563 100644
> --- a/doc/xml/dtrace/Makefile.am
> +++ b/doc/xml/dtrace/Makefile.am
> @@ -25,11 +25,13 @@ XML_FILES = Xserver-DTrace.xml
>  include ../xmlrules.in
>  else
>  noinst_DATA = $(BUILT_DOC_FILES)
>  endif
> +endif

Things have significantly changed over the past few weeks.

This is an excerpt from the release notes.

         New configure options for documentation in modules
         As many more modules now contain documentation to be converted from DocBook XML to text,
         HTML, PostScript, and/or PDF formats, new standard options have been added to the configure
         macros to control the build of these in the modules.
                             Enables or disables use of the xmlto [https://fedorahosted.org/
                             xmlto/] command to translate DocBook XML to other formats.
                             All DocBook XML conversions require use of this command.
                             Enables or disables use of the Apache fop [http://
                             xmlgraphics.apache.org/fop/] command to translate DocBook
                             XML to PostScript and PDF formats.
                             Enables or disables the build and installation of all
                             documentation except traditional man pages or those covered
                             by the --enable-devel-docs and --enable-specs options.
                             Enables or disables the build and installation of documentation
                             for developers of the X.Org software modules.
                             Enables or disables the build and installation of the formal
                             specification documents for protocols and APIs.

The --enable-builddocs option will soon be removed once the posted
patches get reviewed and pushed. There used to be an assumption that
there was only developers docs in the xserver, but this is no longer the

After those patches, the work will be completed. Anyone who wants to
make a change, or fix what looks like a bug is invited to understand the
new docs classification and the new macros supporting it.

Note that all xorg modules having documentation follows this
classification and use the same macros from util-macros.
This allows xorg to have a "project wide" vision to communicate to users
rather than doing it differently in each module.

The doc generation tools are all checked at config time for their
presence and their correct versions (for some). There should be no build
breaks for those reasons as docs generation is skipped if the tools are
not up to spec.

I am taking this opportunity for a little bit of PR  :-)

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.x.org/archives/xorg-devel/attachments/20101207/1e650703/attachment.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: This is a digitally signed message part
URL: <http://lists.x.org/archives/xorg-devel/attachments/20101207/1e650703/attachment.pgp>

More information about the xorg-devel mailing list