diff options
author | Gaetan Nadon <memsize@videotron.ca> | 2011-03-02 14:33:07 -0500 |
---|---|---|
committer | Gaetan Nadon <memsize@videotron.ca> | 2011-03-31 09:29:43 -0400 |
commit | 7f8345aa6fb60a7fd7adf0095a2354fad1d8d5ef (patch) | |
tree | ea4c0eb63656d29aadd10f2ff9627157b349b4b9 | |
parent | 77027deabca37183cfbbed107cf14ca80f29f26d (diff) |
doc: use common makefile for developers documentation
The user/specs docs now have external references support.
Developers doc are not installed so they do not participate.
However, using a similar makefile shared amongst developers
document reduces maintenance and is forward looking.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
-rw-r--r-- | configure.ac | 4 | ||||
-rw-r--r-- | devbook.am | 61 | ||||
-rw-r--r-- | doc/Makefile.am | 59 | ||||
-rw-r--r-- | doc/fontlib.xml | 2 |
4 files changed, 68 insertions, 58 deletions
diff --git a/configure.ac b/configure.ac index 0dbb5a1..c62d6e4 100644 --- a/configure.ac +++ b/configure.ac @@ -45,9 +45,9 @@ m4_ifndef([XORG_MACROS_VERSION], XORG_MACROS_VERSION(1.10) XORG_DEFAULT_OPTIONS XORG_ENABLE_DEVEL_DOCS -XORG_WITH_XMLTO(0.0.20) +XORG_WITH_XMLTO(0.0.22) XORG_WITH_FOP -XORG_CHECK_SGML_DOCTOOLS(1.5) +XORG_CHECK_SGML_DOCTOOLS(1.7) # Checks for header files. AC_CHECK_HEADERS([endian.h poll.h sys/poll.h]) diff --git a/devbook.am b/devbook.am new file mode 100644 index 0000000..62f4829 --- /dev/null +++ b/devbook.am @@ -0,0 +1,61 @@ +# +# Generate output formats for a single DocBook/XML with/without chapters +# +# Variables set by the calling Makefile: +# noinst_DATA: developers docs are not installed +# docbook: the main DocBook/XML file, no chapters, appendix or image files +# chapters: all files pulled in by an XInclude statement and images. +# + +# +# This makefile is intended for Developers Documentation and is not installed. +# Do not use for Users docs or Specs which need to be installed and require olink support +# Refer to http://www.x.org/releases/X11R7.6/doc/xorg-docs/ReleaseNotes.html#id2584393 +# for an explanation on documents classification. +# + +# Developers documnetation is not installed +noinst_DATA = + +# DocBook/XML file with chapters, appendix and images it includes +dist_noinst_DATA = $(docbook) $(chapters) + +# +# Generate DocBook/XML output formats with or without stylesheets +# + +# Stylesheets are available if the package xorg-sgml-doctools is installed +if HAVE_STYLESHEETS + +# The location where all cross reference databases are installed +XMLTO_FLAGS = \ + --searchpath "$(XORG_SGML_PATH)/X11" \ + --stringparam current.docid="$(<:.xml=)" + +XMLTO_XHTML_FLAGS = \ + -m $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl \ + --stringparam html.stylesheet=$(STYLESHEET_SRCDIR)/xorg.css + +XMLTO_FO_FLAGS = \ + -m $(STYLESHEET_SRCDIR)/xorg-fo.xsl +endif HAVE_STYLESHEETS + +noinst_DATA += $(docbook:.xml=.html) +%.html: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_XHTML_FLAGS) xhtml-nochunks $< + +if HAVE_FOP +noinst_DATA += $(docbook:.xml=.pdf) $(docbook:.xml=.ps) +%.pdf: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_FO_FLAGS) --with-fop pdf $< +%.ps: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_FO_FLAGS) --with-fop ps $< +endif HAVE_FOP + +if HAVE_XMLTO_TEXT +noinst_DATA += $(docbook:.xml=.txt) +%.txt: %.xml $(chapters) + $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_XHTML_FLAGS) txt $< +endif HAVE_XMLTO_TEXT + +CLEANFILES = $(noinst_DATA) diff --git a/doc/Makefile.am b/doc/Makefile.am index d2c4724..4a093c0 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,63 +1,12 @@ -# -# 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. -# - -# Developer documentation - not installed on system -EXTRA_DIST = fontlib.xml if ENABLE_DEVEL_DOCS -doc_sources = fontlib.xml - if HAVE_XMLTO -noinst_DATA = $(doc_sources:.xml=.html) - -if HAVE_FOP -noinst_DATA += $(doc_sources:.xml=.ps) $(doc_sources:.xml=.pdf) -endif - -if HAVE_XMLTO_TEXT -noinst_DATA += $(doc_sources:.xml=.txt) -endif - -if HAVE_STYLESHEETS -XMLTO_FLAGS = -m $(XSL_STYLESHEET) \ - --stringparam html.stylesheet=$(STYLESHEET_SRCDIR)/xorg.css -endif - -CLEANFILES = $(noinst_DATA) - -SUFFIXES = .xml .ps .pdf .txt .html - -.xml.txt: - $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) txt $< - -.xml.html: - $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) xhtml-nochunks $< -.xml.pdf: - $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop pdf $< +# Main DocBook/XML files (DOCTYPE book) +docbook = fontlib.xml -.xml.ps: - $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) --with-fop ps $< +# Generate DocBook/XML output formats with or without stylesheets +include $(top_srcdir)/devbook.am endif HAVE_XMLTO endif ENABLE_DEVEL_DOCS diff --git a/doc/fontlib.xml b/doc/fontlib.xml index 86cef8d..cce83e9 100644 --- a/doc/fontlib.xml +++ b/doc/fontlib.xml @@ -4,7 +4,7 @@ <!-- lifted from troff+ms by doclifter --> <!-- previous version was in xorg-docs/specs/Xserver/fontlib.ms --> - <article id='fontlibms'> + <article id='fontlib'> <!-- .ps 12 --> <!-- .EF 'Font Library Interface'\- % \-'July 27, 1991' --> <!-- .OF 'Font Library Interface'\- % \-'July 27, 1991' --> |