[PATCH xserver 9/9] doc: use devbook.am for developers documentation

Thu Apr 28 18:16:16 PDT 2011

Relocate the docs under the doc subdir.
Remove redundant xml subdir.
The xmlrules set of makefiles are no longer used.

Reviewed-by Jeremy Huddleston <jeremyhu at apple.com>
Signed-off-by: Gaetan Nadon <memsize at videotron.ca>
---
 configure.ac                   |    1 -
 doc/.gitignore                 |    4 +++
 doc/Makefile.am                |   16 ++++++++++++-
 doc/{xml => }/Xserver-spec.xml |    0
 doc/xml/.gitignore             |    3 --
 doc/xml/Makefile.am            |   29 ------------------------
 doc/xml/xmlrules-inst.in       |   23 -------------------
 doc/xml/xmlrules-noinst.in     |   22 ------------------
 doc/xml/xmlrules.in            |   47 ----------------------------------------
 9 files changed, 18 insertions(+), 127 deletions(-)
 create mode 100644 doc/.gitignore
 rename doc/{xml => }/Xserver-spec.xml (100%)
 delete mode 100644 doc/xml/.gitignore
 delete mode 100644 doc/xml/Makefile.am
 delete mode 100644 doc/xml/xmlrules-inst.in
 delete mode 100644 doc/xml/xmlrules-noinst.in
 delete mode 100644 doc/xml/xmlrules.in

diff --git a/configure.ac b/configure.ac
index eb971bc..0c173df 100644
--- a/configure.ac
+++ b/configure.ac
@@ -2139,7 +2139,6 @@ dbe/Makefile
 dix/Makefile
 doc/Makefile
 doc/dtrace/Makefile
-doc/xml/Makefile
 man/Makefile
 fb/Makefile
 record/Makefile
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..2ee2ac5
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,4 @@
+*.html
+*.pdf
+*.ps
+*.txt
diff --git a/doc/Makefile.am b/doc/Makefile.am
index e8634fd..ac636c1 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,3 +1,15 @@
-SUBDIRS = dtrace xml
+SUBDIRS = dtrace
 
-dist_noinst_DATA = smartsched
+if ENABLE_DEVEL_DOCS
+if HAVE_XMLTO
+
+# Main DocBook/XML files (DOCTYPE book)
+docbook = Xserver-spec.xml
+
+# Generate DocBook/XML output formats with or without stylesheets
+include $(top_srcdir)/devbook.am
+
+endif HAVE_XMLTO
+endif ENABLE_DEVEL_DOCS
+
+EXTRA_DIST = smartsched
diff --git a/doc/xml/Xserver-spec.xml b/doc/Xserver-spec.xml
similarity index 100%
rename from doc/xml/Xserver-spec.xml
rename to doc/Xserver-spec.xml
diff --git a/doc/xml/.gitignore b/doc/xml/.gitignore
deleted file mode 100644
index 3f0ed13..0000000
--- a/doc/xml/.gitignore
+++ /dev/null
@@ -1,3 +0,0 @@
-Xserver-spec.html
-Xserver-spec.pdf
-Xserver-spec.txt
diff --git a/doc/xml/Makefile.am b/doc/xml/Makefile.am
deleted file mode 100644
index 0236038..0000000
--- a/doc/xml/Makefile.am
+++ /dev/null
@@ -1,29 +0,0 @@
-#
-# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a
-# copy of this software and associated documentation files (the "Software"),
-# to deal in the Software without restriction, including without limitation
-# the rights to use, copy, modify, merge, publish, distribute, sublicense,
-# and/or sell copies of the Software, and to permit persons to whom the
-# Software is furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice (including the next
-# paragraph) shall be included in all copies or substantial portions of the
-# Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
-# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-# DEALINGS IN THE SOFTWARE.
-#
-
-doc_sources =  Xserver-spec.xml
-
-# Developer's documentation is not installed
-if ENABLE_DEVEL_DOCS
-include $(top_srcdir)/doc/xml/xmlrules-noinst.in
-endif
diff --git a/doc/xml/xmlrules-inst.in b/doc/xml/xmlrules-inst.in
deleted file mode 100644
index 9b90278..0000000
--- a/doc/xml/xmlrules-inst.in
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# The doc_sources variable contains one or more DocBook/XML source file.
-# The generated documents will be installed in $(docdir),
-# The DocBook/XML files will always be included in the tarball
-
-dist_doc_DATA = $(doc_sources)
-
-if HAVE_XMLTO
-doc_DATA = $(doc_sources:.xml=.html)
-
-if HAVE_FOP
-doc_DATA += $(doc_sources:.xml=.pdf)
-endif
-
-if HAVE_XMLTO_TEXT
-doc_DATA += $(doc_sources:.xml=.txt)
-endif
-
-CLEANFILES = $(doc_DATA)
-include $(top_srcdir)/doc/xml/xmlrules.in
-
-endif HAVE_XMLTO
-
diff --git a/doc/xml/xmlrules-noinst.in b/doc/xml/xmlrules-noinst.in
deleted file mode 100644
index 0333652..0000000
--- a/doc/xml/xmlrules-noinst.in
+++ /dev/null
@@ -1,22 +0,0 @@
-
-# The doc_sources variable contains one or more DocBook/XML source file.
-# The generated documents will NOT be installed in $(docdir),
-# The DocBook/XML files will always be included in the tarball
-
-dist_noinst_DATA = $(doc_sources)
-
-if HAVE_XMLTO
-noinst_DATA = $(doc_sources:.xml=.html)
-
-if HAVE_FOP
-noinst_DATA += $(doc_sources:.xml=.pdf)
-endif
-
-if HAVE_XMLTO_TEXT
-noinst_DATA += $(doc_sources:.xml=.txt)
-endif
-
-CLEANFILES = $(noinst_DATA)
-include $(top_srcdir)/doc/xml/xmlrules.in
-
-endif HAVE_XMLTO
diff --git a/doc/xml/xmlrules.in b/doc/xml/xmlrules.in
deleted file mode 100644
index 8b22761..0000000
--- a/doc/xml/xmlrules.in
+++ /dev/null
@@ -1,47 +0,0 @@
-#
-# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a
-# copy of this software and associated documentation files (the "Software"),
-# to deal in the Software without restriction, including without limitation
-# the rights to use, copy, modify, merge, publish, distribute, sublicense,
-# and/or sell copies of the Software, and to permit persons to whom the
-# Software is furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice (including the next
-# paragraph) shall be included in all copies or substantial portions of the
-# Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
-# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-# DEALINGS IN THE SOFTWARE.
-#
-
-# This file provides pattern rules to generate html/pdf/txt from DocBook/XML
-# A stylesheet is used if xorg-sgml-doctools is installed
-# This file is included by xmlrules-inst.in for installable user's documentation
-# It is included by xmlrules-noinst for non installable developer's documentation
-# If the server version or release date changes, autogen && make
-
-XML_ENT_DIR = $(abs_top_builddir)
-SUFFIXES = .xml .txt .html .pdf
-
-XMLTO_FLAGS = --searchpath $(XML_ENT_DIR)
-
-if HAVE_STYLESHEETS
-XMLTO_FLAGS += -m $(XSL_STYLESHEET) \
-	--stringparam html.stylesheet=$(STYLESHEET_SRCDIR)/xorg.css
-endif
-
-%.txt: %.xml $(XML_ENT_DIR)/xserver.ent
-	$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) txt $<
-
-%.html: %.xml $(XML_ENT_DIR)/xserver.ent
-	$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) xhtml-nochunks $<
-
-%.pdf: %.xml $(XML_ENT_DIR)/xserver.ent
-	$(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop pdf $<
-- 
1.6.0.4

