]> code.ossystems Code Review - openembedded-core.git/commitdiff
poky-doc-tools: Remove unnecessary autotools usage and simplfy structure
authorRichard Purdie <rpurdie@linux.intel.com>
Wed, 29 Sep 2010 14:26:29 +0000 (15:26 +0100)
committerRichard Purdie <rpurdie@linux.intel.com>
Wed, 29 Sep 2010 14:27:04 +0000 (15:27 +0100)
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
27 files changed:
handbook/Makefile
handbook/bsp-guide.xml
handbook/poky-doc-tools/AUTHORS [deleted file]
handbook/poky-doc-tools/COPYING [deleted file]
handbook/poky-doc-tools/ChangeLog [deleted file]
handbook/poky-doc-tools/INSTALL [deleted file]
handbook/poky-doc-tools/Makefile.am [deleted file]
handbook/poky-doc-tools/NEWS [deleted file]
handbook/poky-doc-tools/README [deleted file]
handbook/poky-doc-tools/autogen.sh [deleted file]
handbook/poky-doc-tools/common/Makefile.am [deleted file]
handbook/poky-doc-tools/configure.ac [deleted file]
handbook/poky-handbook.xml
handbook/template/Vera.ttf [moved from handbook/poky-doc-tools/common/Vera.ttf with 100% similarity]
handbook/template/Vera.xml [moved from handbook/poky-doc-tools/common/Vera.xml with 100% similarity]
handbook/template/VeraMoBd.ttf [moved from handbook/poky-doc-tools/common/VeraMoBd.ttf with 100% similarity]
handbook/template/VeraMoBd.xml [moved from handbook/poky-doc-tools/common/VeraMoBd.xml with 100% similarity]
handbook/template/VeraMono.ttf [moved from handbook/poky-doc-tools/common/VeraMono.ttf with 100% similarity]
handbook/template/VeraMono.xml [moved from handbook/poky-doc-tools/common/VeraMono.xml with 100% similarity]
handbook/template/draft.png [moved from handbook/poky-doc-tools/common/draft.png with 100% similarity]
handbook/template/fop-config.xml [moved from handbook/poky-doc-tools/common/fop-config.xml.in with 96% similarity]
handbook/template/ohand-color.svg [moved from handbook/poky-doc-tools/common/ohand-color.svg with 100% similarity]
handbook/template/poky-db-pdf.xsl [moved from handbook/poky-doc-tools/common/poky-db-pdf.xsl with 100% similarity]
handbook/template/poky-handbook.png [moved from handbook/poky-doc-tools/common/poky-handbook.png with 100% similarity]
handbook/template/poky.svg [moved from handbook/poky-doc-tools/common/poky.svg with 100% similarity]
handbook/template/titlepage.templates.xml [moved from handbook/poky-doc-tools/common/titlepage.templates.xml with 100% similarity]
handbook/tools/poky-docbook-to-pdf [moved from handbook/poky-doc-tools/poky-docbook-to-pdf.in with 72% similarity, mode: 0755]

index 502c951a7adcf3dcdf5a880abf782421c8ec0ff7..ee549f1cbf69a220396bd626ebe7ce6a9c3434b7 100644 (file)
@@ -1,10 +1,8 @@
 all: html pdf tarball
 
 pdf:
-       ./poky-doc-tools/poky-docbook-to-pdf poky-handbook.xml
-       ./poky-doc-tools/poky-docbook-to-pdf bsp-guide.xml
-#       -- old way --
-#      dblatex poky-handbook.xml
+       ./tools/poky-docbook-to-pdf poky-handbook.xml ./template
+       ./tools/poky-docbook-to-pdf bsp-guide.xml ./template
 
 XSLTOPTS = --stringparam html.stylesheet style.css \
            --stringparam  chapter.autolabel 1 \
@@ -22,8 +20,6 @@ html:
 #       See http://www.sagehill.net/docbookxsl/HtmlOutput.html 
        xsltproc $(XSLTOPTS) -o poky-handbook.html $(XSL_XHTML_URI) poky-handbook.xml
        xsltproc $(XSLTOPTS) -o bsp-guide.html $(XSL_XHTML_URI) bsp-guide.xml
-#       -- old way --
-#      xmlto xhtml-nochunks poky-handbook.xml
 
 tarball: html
        tar -cvzf poky-handbook.tgz poky-handbook.html style.css screenshots/ss-sato.png poky-beaver.png poky-handbook.png
@@ -36,3 +32,6 @@ SOURCES = *.png *.xml *.css *.svg
 
 publish:
        scp -r $(OUTPUTS) $(SOURCES) o-hand.com:/srv/www/pokylinux.org/doc/
+
+clean:
+       rm $(OUTPUTS)
index e5933d7e9c65266c567e8c1ec9d85bb4d5c86bbd..ab2043aadf23f9560eea6c0b2ea6f2419e4ba48f 100644 (file)
@@ -9,7 +9,7 @@
 
         <mediaobject>
             <imageobject>
-                <imagedata fileref='common/poky-handbook.png' 
+                <imagedata fileref='template/poky-handbook.png' 
                     format='SVG' 
                     align='center' scalefit='1' width='100%'/>
             </imageobject>    
@@ -42,7 +42,7 @@
 
     <legalnotice>
       <para>
-        Permission is granted to copy, distribute and/or modify this document under 
+        Permission is granted to copy, distribute and/or modify pthis document under 
         the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-nc-sa/2.0/uk/">Creative Commons Attribution-Non-Commercial-Share Alike 2.0 UK: England &amp; Wales</ulink> as published by Creative Commons.
       </para>
     </legalnotice>
diff --git a/handbook/poky-doc-tools/AUTHORS b/handbook/poky-doc-tools/AUTHORS
deleted file mode 100644 (file)
index e69de29..0000000
diff --git a/handbook/poky-doc-tools/COPYING b/handbook/poky-doc-tools/COPYING
deleted file mode 100644 (file)
index e69de29..0000000
diff --git a/handbook/poky-doc-tools/ChangeLog b/handbook/poky-doc-tools/ChangeLog
deleted file mode 100644 (file)
index beee679..0000000
+++ /dev/null
@@ -1,30 +0,0 @@
-2008-02-15  Matthew Allum  <mallum@openedhand.com>
-
-       * common/Makefile.am:
-       * common/poky-handbook.png:
-        Add a PNG image for the manual. Seems our logo SVG
-        is too complex/transparent for PDF
-
-2008-02-14  Matthew Allum  <mallum@openedhand.com>
-
-       * common/Makefile.am:
-       * common/fop-config.xml.in:
-       * common/poky-db-pdf.xsl:
-       * poky-docbook-to-pdf.in:
-        Font tweakage.
-
-2008-01-27  Matthew Allum  <mallum@openedhand.com>
-
-       * INSTALL:
-       * Makefile.am:
-       * README:
-       * autogen.sh:
-       * common/Makefile.am:
-       * common/fop-config.xml.in:
-       * common/ohand-color.svg:
-       * common/poky-db-pdf.xsl:
-       * common/poky.svg:
-       * common/titlepage.templates.xml:
-       * configure.ac:
-       * poky-docbook-to-pdf.in:
-       Initial import.
diff --git a/handbook/poky-doc-tools/INSTALL b/handbook/poky-doc-tools/INSTALL
deleted file mode 100644 (file)
index 23e5f25..0000000
+++ /dev/null
@@ -1,236 +0,0 @@
-Installation Instructions
-*************************
-
-Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
-Software Foundation, Inc.
-
-This file is free documentation; the Free Software Foundation gives
-unlimited permission to copy, distribute and modify it.
-
-Basic Installation
-==================
-
-These are generic installation instructions.
-
-   The `configure' shell script attempts to guess correct values for
-various system-dependent variables used during compilation.  It uses
-those values to create a `Makefile' in each directory of the package.
-It may also create one or more `.h' files containing system-dependent
-definitions.  Finally, it creates a shell script `config.status' that
-you can run in the future to recreate the current configuration, and a
-file `config.log' containing compiler output (useful mainly for
-debugging `configure').
-
-   It can also use an optional file (typically called `config.cache'
-and enabled with `--cache-file=config.cache' or simply `-C') that saves
-the results of its tests to speed up reconfiguring.  (Caching is
-disabled by default to prevent problems with accidental use of stale
-cache files.)
-
-   If you need to do unusual things to compile the package, please try
-to figure out how `configure' could check whether to do them, and mail
-diffs or instructions to the address given in the `README' so they can
-be considered for the next release.  If you are using the cache, and at
-some point `config.cache' contains results you don't want to keep, you
-may remove or edit it.
-
-   The file `configure.ac' (or `configure.in') is used to create
-`configure' by a program called `autoconf'.  You only need
-`configure.ac' if you want to change it or regenerate `configure' using
-a newer version of `autoconf'.
-
-The simplest way to compile this package is:
-
-  1. `cd' to the directory containing the package's source code and type
-     `./configure' to configure the package for your system.  If you're
-     using `csh' on an old version of System V, you might need to type
-     `sh ./configure' instead to prevent `csh' from trying to execute
-     `configure' itself.
-
-     Running `configure' takes awhile.  While running, it prints some
-     messages telling which features it is checking for.
-
-  2. Type `make' to compile the package.
-
-  3. Optionally, type `make check' to run any self-tests that come with
-     the package.
-
-  4. Type `make install' to install the programs and any data files and
-     documentation.
-
-  5. You can remove the program binaries and object files from the
-     source code directory by typing `make clean'.  To also remove the
-     files that `configure' created (so you can compile the package for
-     a different kind of computer), type `make distclean'.  There is
-     also a `make maintainer-clean' target, but that is intended mainly
-     for the package's developers.  If you use it, you may have to get
-     all sorts of other programs in order to regenerate files that came
-     with the distribution.
-
-Compilers and Options
-=====================
-
-Some systems require unusual options for compilation or linking that the
-`configure' script does not know about.  Run `./configure --help' for
-details on some of the pertinent environment variables.
-
-   You can give `configure' initial values for configuration parameters
-by setting variables in the command line or in the environment.  Here
-is an example:
-
-     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
-
-   *Note Defining Variables::, for more details.
-
-Compiling For Multiple Architectures
-====================================
-
-You can compile the package for more than one kind of computer at the
-same time, by placing the object files for each architecture in their
-own directory.  To do this, you must use a version of `make' that
-supports the `VPATH' variable, such as GNU `make'.  `cd' to the
-directory where you want the object files and executables to go and run
-the `configure' script.  `configure' automatically checks for the
-source code in the directory that `configure' is in and in `..'.
-
-   If you have to use a `make' that does not support the `VPATH'
-variable, you have to compile the package for one architecture at a
-time in the source code directory.  After you have installed the
-package for one architecture, use `make distclean' before reconfiguring
-for another architecture.
-
-Installation Names
-==================
-
-By default, `make install' installs the package's commands under
-`/usr/local/bin', include files under `/usr/local/include', etc.  You
-can specify an installation prefix other than `/usr/local' by giving
-`configure' the option `--prefix=PREFIX'.
-
-   You can specify separate installation prefixes for
-architecture-specific files and architecture-independent files.  If you
-pass the option `--exec-prefix=PREFIX' to `configure', the package uses
-PREFIX as the prefix for installing programs and libraries.
-Documentation and other data files still use the regular prefix.
-
-   In addition, if you use an unusual directory layout you can give
-options like `--bindir=DIR' to specify different values for particular
-kinds of files.  Run `configure --help' for a list of the directories
-you can set and what kinds of files go in them.
-
-   If the package supports it, you can cause programs to be installed
-with an extra prefix or suffix on their names by giving `configure' the
-option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
-
-Optional Features
-=================
-
-Some packages pay attention to `--enable-FEATURE' options to
-`configure', where FEATURE indicates an optional part of the package.
-They may also pay attention to `--with-PACKAGE' options, where PACKAGE
-is something like `gnu-as' or `x' (for the X Window System).  The
-`README' should mention any `--enable-' and `--with-' options that the
-package recognizes.
-
-   For packages that use the X Window System, `configure' can usually
-find the X include and library files automatically, but if it doesn't,
-you can use the `configure' options `--x-includes=DIR' and
-`--x-libraries=DIR' to specify their locations.
-
-Specifying the System Type
-==========================
-
-There may be some features `configure' cannot figure out automatically,
-but needs to determine by the type of machine the package will run on.
-Usually, assuming the package is built to be run on the _same_
-architectures, `configure' can figure that out, but if it prints a
-message saying it cannot guess the machine type, give it the
-`--build=TYPE' option.  TYPE can either be a short name for the system
-type, such as `sun4', or a canonical name which has the form:
-
-     CPU-COMPANY-SYSTEM
-
-where SYSTEM can have one of these forms:
-
-     OS KERNEL-OS
-
-   See the file `config.sub' for the possible values of each field.  If
-`config.sub' isn't included in this package, then this package doesn't
-need to know the machine type.
-
-   If you are _building_ compiler tools for cross-compiling, you should
-use the option `--target=TYPE' to select the type of system they will
-produce code for.
-
-   If you want to _use_ a cross compiler, that generates code for a
-platform different from the build platform, you should specify the
-"host" platform (i.e., that on which the generated programs will
-eventually be run) with `--host=TYPE'.
-
-Sharing Defaults
-================
-
-If you want to set default values for `configure' scripts to share, you
-can create a site shell script called `config.site' that gives default
-values for variables like `CC', `cache_file', and `prefix'.
-`configure' looks for `PREFIX/share/config.site' if it exists, then
-`PREFIX/etc/config.site' if it exists.  Or, you can set the
-`CONFIG_SITE' environment variable to the location of the site script.
-A warning: not all `configure' scripts look for a site script.
-
-Defining Variables
-==================
-
-Variables not defined in a site shell script can be set in the
-environment passed to `configure'.  However, some packages may run
-configure again during the build, and the customized values of these
-variables may be lost.  In order to avoid this problem, you should set
-them in the `configure' command line, using `VAR=value'.  For example:
-
-     ./configure CC=/usr/local2/bin/gcc
-
-causes the specified `gcc' to be used as the C compiler (unless it is
-overridden in the site shell script).  Here is a another example:
-
-     /bin/bash ./configure CONFIG_SHELL=/bin/bash
-
-Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
-configuration-related scripts to be executed by `/bin/bash'.
-
-`configure' Invocation
-======================
-
-`configure' recognizes the following options to control how it operates.
-
-`--help'
-`-h'
-     Print a summary of the options to `configure', and exit.
-
-`--version'
-`-V'
-     Print the version of Autoconf used to generate the `configure'
-     script, and exit.
-
-`--cache-file=FILE'
-     Enable the cache: use and save the results of the tests in FILE,
-     traditionally `config.cache'.  FILE defaults to `/dev/null' to
-     disable caching.
-
-`--config-cache'
-`-C'
-     Alias for `--cache-file=config.cache'.
-
-`--quiet'
-`--silent'
-`-q'
-     Do not print messages saying which checks are being made.  To
-     suppress all normal output, redirect it to `/dev/null' (any error
-     messages will still be shown).
-
-`--srcdir=DIR'
-     Look for the package's source code in directory DIR.  Usually
-     `configure' can determine that directory automatically.
-
-`configure' also accepts some other, not widely useful, options.  Run
-`configure --help' for more details.
-
diff --git a/handbook/poky-doc-tools/Makefile.am b/handbook/poky-doc-tools/Makefile.am
deleted file mode 100644 (file)
index 4533cd8..0000000
+++ /dev/null
@@ -1,24 +0,0 @@
-SUBDIRS = common
-
-EXTRA_DIST = poky-docbook-to-pdf.in
-
-bin_SCRIPTS = poky-docbook-to-pdf
-
-edit = sed \
-        -e 's,@datadir\@,$(pkgdatadir),g' \
-        -e 's,@prefix\@,$(prefix),g'      \
-        -e 's,@version\@,@VERSION@,g'
-
-##
-# These URI should be rewritten by your distribution's xml catalog to
-# match your localy installed XSL stylesheets.
-XSL_BASE_URI="http://docbook.sourceforge.net/release/xsl/current"
-XSL_TEMPLATE_URI = $(XSL_BASE_URI)/template/titlepage.xsl
-
-poky-docbook-to-pdf: poky-docbook-to-pdf.in
-       rm -f poky-docbook-to-pdf
-       $(edit) poky-docbook-to-pdf.in > poky-docbook-to-pdf
-
-clean-local:
-       rm -fr poky-docbook-to-pdf
-       rm -fr poky-pr-docbook-to-pdf
\ No newline at end of file
diff --git a/handbook/poky-doc-tools/NEWS b/handbook/poky-doc-tools/NEWS
deleted file mode 100644 (file)
index e69de29..0000000
diff --git a/handbook/poky-doc-tools/README b/handbook/poky-doc-tools/README
deleted file mode 100644 (file)
index 54e2d8e..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-poky-doc-tools
-==============
-
-Simple tools to wrap fop to create Poky branded PDF's from docbook sources.
-(based on OH doc tools)
-
-Dependencies
-============
-
-Sun Java, make sure the java in your path is the *sun* java.
-
-xlstproc, nwalsh style sheets, fop
-
-FOP, installed - see http://www.sagehill.net/docbookxsl/InstallingAnFO.html.
-Updated to work with (fop > 0.95)
-
-
-
-
diff --git a/handbook/poky-doc-tools/autogen.sh b/handbook/poky-doc-tools/autogen.sh
deleted file mode 100755 (executable)
index d68a142..0000000
+++ /dev/null
@@ -1,3 +0,0 @@
-#! /bin/sh
-autoreconf -v --install || exit 1
-./configure "$@"
diff --git a/handbook/poky-doc-tools/common/Makefile.am b/handbook/poky-doc-tools/common/Makefile.am
deleted file mode 100644 (file)
index c6b154b..0000000
+++ /dev/null
@@ -1,21 +0,0 @@
-SUPPORT_FILES = VeraMoBd.ttf              VeraMoBd.xml            \
-               VeraMono.ttf              VeraMono.xml            \
-               Vera.ttf                  Vera.xml                \
-                draft.png                 titlepage.templates.xml \
-               poky-db-pdf.xsl           poky.svg                \
-               ohand-color.svg           poky-handbook.png
-
-commondir = $(pkgdatadir)/common
-common_DATA = $(SUPPORT_FILES) fop-config.xml
-
-EXTRA_DIST = $(SUPPORT_FILES) fop-config.xml.in
-
-edit = sed -e 's,@datadir\@,$(pkgdatadir),g' 
-
-fop-config.xml: fop-config.xml.in
-       rm -f fop-config.xml
-       $(edit) fop-config.xml.in > fop-config.xml
-
-
-clean-local:
-       rm -fr fop-config.xml
\ No newline at end of file
diff --git a/handbook/poky-doc-tools/configure.ac b/handbook/poky-doc-tools/configure.ac
deleted file mode 100644 (file)
index 0d15c81..0000000
+++ /dev/null
@@ -1,27 +0,0 @@
-AC_PREREQ(2.53)
-AC_INIT(poky-doc-tools, 0.1, http://o-hand.com)
-AM_INIT_AUTOMAKE()
-
-AC_PATH_PROG(HAVE_XSLTPROC, xsltproc, no)
-if test x$HAVE_XSLTPROC = xno; then
-  AC_MSG_ERROR([Required xsltproc program not found])
-fi
-
-AC_PATH_PROG(HAVE_FOP, fop, no)
-if test x$HAVE_FOP = xno; then
-  AC_MSG_ERROR([Required fop program not found])
-fi
-
-AC_CHECK_FILE([/usr/share/xml/docbook/stylesheet/nwalsh/template/titlepage.xsl],HAVE_NWALSH="yes", HAVE_NWALSH="no")
-if test x$HAVE_FOP = xno; then
-  AC_MSG_ERROR([Required 'nwalsh' docbook stylesheets not found])
-fi
-
-AC_OUTPUT([
-Makefile
-common/Makefile
-])
-
-echo "
-                == poky-doc-tools $VERSION configured successfully. ==
-"
\ No newline at end of file
index a7b7312cc11a07a32ba93dd0fa122a8c2913083e..fb2bc80df30bf0746e3330b275ff23e67b15ad18 100644 (file)
@@ -9,7 +9,7 @@
 
         <mediaobject>
             <imageobject>
-                <imagedata fileref='common/poky-handbook.png' 
+                <imagedata fileref='template/poky-handbook.png' 
                     format='SVG' 
                     align='center' scalefit='1' width='100%'/>
             </imageobject>    
similarity index 96%
rename from handbook/poky-doc-tools/common/fop-config.xml.in
rename to handbook/template/fop-config.xml
index 40cdf9c334780526e5b8889632576c82acc8b411..7d56223d17707ca04f5539c0a0146b40fa76066a 100644 (file)
@@ -10,8 +10,8 @@
     Set the baseDir so common/openedhand.svg references in plans still
     work ok. Note, relative file references to current dir should still work.
     -->        
-  <base>@datadir@</base>
-  <font-base>@datadir@/common</font-base>
+  <base>template</base>
+  <font-base>template</font-base>
  
   <!-- Source resolution in dpi (dots/pixels per inch) for determining the
        size of pixels in SVG and bitmap images, default: 72dpi -->
old mode 100644 (file)
new mode 100755 (executable)
similarity index 72%
rename from handbook/poky-doc-tools/poky-docbook-to-pdf.in
rename to handbook/tools/poky-docbook-to-pdf
index b56aee4..8e3d754
@@ -1,7 +1,7 @@
 #!/bin/sh
        
-if [ -z "$1" ]; then
-   echo "usage: [-v] $0 <docbook file>"
+if [ -z "$1" -o -z "$2" ]; then
+   echo "usage: [-v] $0 <docbook file> <templatedir>"
    echo
    echo "*NOTE* you need xsltproc, fop and nwalsh docbook stylesheets" 
    echo "       installed for this to work!"
@@ -9,14 +9,10 @@ if [ -z "$1" ]; then
    exit 0
 fi
 
-if [ "$1" = "-v" ]; then
-   echo "Version @version@"
-   exit 1
-fi
-
 BASENAME=`basename $1 .xml` || exit 1
 FO="$BASENAME.fo" 
 PDF="$BASENAME.pdf"
+TEMPLATEDIR=$2
 
 ##
 # These URI should be rewritten by your distribution's xml catalog to
@@ -26,7 +22,7 @@ XSL_BASE_URI="http://docbook.sourceforge.net/release/xsl/current"
 xsltproc -o /tmp/titlepage.xsl                                           \
         --xinclude                                                      \
          $XSL_BASE_URI/template/titlepage.xsl \
-         @datadir@/common/titlepage.templates.xml || exit 1
+         $TEMPLATEDIR/titlepage.templates.xml || exit 1
 
 xsltproc --xinclude                    \
         --stringparam hyphenate false \
@@ -34,16 +30,16 @@ xsltproc --xinclude                    \
         --stringparam ulink.show 1 \
          --stringparam  body.font.master  9 \
          --stringparam  title.font.master  11 \
-         --stringparam draft.watermark.image "@datadir@/common/draft.png" \
+         --stringparam draft.watermark.image "$TEMPLATEDIR/draft.png" \
          --output $FO               \
-         @datadir@/common/poky-db-pdf.xsl    \
+         $TEMPLATEDIR/poky-db-pdf.xsl    \
         $1                 || exit 1
 
-fop -c @datadir@/common/fop-config.xml -fo $FO -pdf $PDF       || exit 1
+fop -c $TEMPLATEDIR/fop-config.xml -fo $FO -pdf $PDF       || exit 1
 
 rm -f $FO
 rm -f  /tmp/titlepage.xsl
 
 echo
 echo " #### Success! $PDF ready. ####"
-echo
\ No newline at end of file
+echo