<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 TRANSITIONAL//EN">
<HTML>
<HEAD>
  <META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=UTF-8">
  <META NAME="GENERATOR" CONTENT="GtkHTML/3.26.0">
</HEAD>
<BODY>
On Tue, 2010-12-07 at 19:50 +0200, Tiago Vignatti wrote:
<BLOCKQUOTE TYPE=CITE>
<PRE>
From: Pauli Nieminen &lt;<A HREF="mailto:ext-pauli.nieminen@nokia.com">ext-pauli.nieminen@nokia.com</A>&gt;

Co-authored-by: Tiago Vignatti &lt;<A HREF="mailto:tiago.vignatti@nokia.com">tiago.vignatti@nokia.com</A>&gt;
Signed-off-by: Pauli Nieminen &lt;<A HREF="mailto:ext-pauli.nieminen@nokia.com">ext-pauli.nieminen@nokia.com</A>&gt;
Signed-off-by: Tiago Vignatti &lt;<A HREF="mailto:tiago.vignatti@nokia.com">tiago.vignatti@nokia.com</A>&gt;
---
 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
 
+if ENABLE_DEVEL_DOCS
 if XSERVER_DTRACE
 doc_DATA = $(BUILT_DOC_FILES)
 else
 noinst_DATA = $(BUILT_DOC_FILES)
 endif
+endif
 
 CLEANFILES = $(CLEAN_DOC_FILES)
 
</PRE>
</BLOCKQUOTE>
<BR>
Things have significantly changed over the past few weeks.<BR>
<BR>
This is an excerpt from the release notes.<BR>
<BR>
<BLOCKQUOTE>
<PRE>
 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.
 --with-xmlto=yes|no
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Enables or disables use of the xmlto [<A HREF="https://fedorahosted.org/">https://fedorahosted.org/</A>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; xmlto/] command to translate DocBook XML to other formats.
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; All DocBook XML conversions require use of this command.
 --with-fop=yes|no
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Enables or disables use of the Apache fop [http://
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; xmlgraphics.apache.org/fop/] command to translate DocBook
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; XML to PostScript and PDF formats.
 --enable-docs=yes|no
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Enables or disables the build and installation of all
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; documentation except traditional man pages or those covered
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; by the --enable-devel-docs and --enable-specs options.
 --enable-devel-docs=yes|no
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Enables or disables the build and installation of documentation
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; for developers of the X.Org software modules.
 --enable-specs=yes|no
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Enables or disables the build and installation of the formal
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; specification documents for protocols and APIs.
</PRE>
</BLOCKQUOTE>
<BR>
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 case.<BR>
<BR>
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.<BR>
<BR>
Note that all xorg modules having documentation follows this classification and use the same macros from util-macros.<BR>
This allows xorg to have a &quot;project wide&quot; vision to communicate to users rather than doing it differently in each module.<BR>
<BR>
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.<BR>
<BR>
I am taking this opportunity for a little bit of PR&nbsp; :-)<BR>
<BR>
<BR>
<BR>
<BR>
<BR>
<BR>
<BR>
</BODY>
</HTML>