frederik
/
xserver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: use devbook.am for developers documentation 

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@apple.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Keith Packard <keithp@keithp.com>
This commit is contained in:
Gaetan Nadon 2011-05-14 13:30:20 -04:00 committed by Keith Packard
parent 96c65be39b
commit 0e7f61d72c
10 changed files with 18 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
configure.ac
View File

@ -2153,7 +2153,6 @@ dbe/Makefile
dix/Makefile
doc/Makefile
doc/dtrace/Makefile
doc/xml/Makefile
man/Makefile
fb/Makefile
record/Makefile

4
doc/.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
*.html
*.pdf
*.ps
*.txt

16
doc/Makefile.am
View File

@ -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 Xinput.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

0
doc/xml/Xinput.xml → doc/Xinput.xml
View File

0
doc/xml/Xserver-spec.xml → doc/Xserver-spec.xml
View File

3
doc/xml/.gitignore vendored
View File

@ -1,3 +0,0 @@
Xserver-spec.html
Xserver-spec.pdf
Xserver-spec.txt

29
doc/xml/Makefile.am
View File

@ -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 Xinput.xml
# Developer's documentation is not installed
if ENABLE_DEVEL_DOCS
include $(top_srcdir)/doc/xml/xmlrules-noinst.in
endif

23
doc/xml/xmlrules-inst.in
View File

@ -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

22
doc/xml/xmlrules-noinst.in
View File

@ -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

47
doc/xml/xmlrules.in
View File

@ -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 $<