summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2014-05-02 16:09:43 +0200
committerPhilip Withnall <philip.withnall@collabora.co.uk>2014-09-23 08:12:00 +0100
commita912a74ba7999fe3ed49b07bab86685a5d117f82 (patch)
tree78f877d05ec8ec6432018bd2d7481fdea3be025d
parent6684e2fa5d5a4c72c9bf116f74688c0b47f350cf (diff)
downloadgnome-common-a912a74ba7999fe3ed49b07bab86685a5d117f82.tar.gz
doc-build: Remove doc-build infrastructure
This pertained to the old GNOME documentation infrastructure, used before Mallard existed. This isn’t used by any modules we care about any more. Most modules which set USE_COMMON_DOC_BUILD do so erroneously. https://bugzilla.gnome.org/show_bug.cgi?id=729931
-rw-r--r--Makefile.am2
-rw-r--r--configure.ac2
-rw-r--r--doc-build/Makefile.am12
-rw-r--r--doc-build/README9
-rw-r--r--doc-build/gnome-doc-common.in49
-rw-r--r--doc-build/omf.make65
-rw-r--r--doc-build/xmldocs.make101
-rw-r--r--macros2/gnome-autogen.sh10
8 files changed, 1 insertions, 249 deletions
diff --git a/Makefile.am b/Makefile.am
index ddcbe9b..5e4f9f8 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = macros2 doc-build
+SUBDIRS = macros2
EXTRA_DIST = \
autogen.sh \
diff --git a/configure.ac b/configure.ac
index 3c0e5c2..9d81b72 100644
--- a/configure.ac
+++ b/configure.ac
@@ -16,8 +16,6 @@ AM_MAINTAINER_MODE([enable])
AC_CONFIG_FILES([
Makefile
macros2/Makefile
-doc-build/Makefile
-doc-build/gnome-doc-common
])
AC_OUTPUT
diff --git a/doc-build/Makefile.am b/doc-build/Makefile.am
deleted file mode 100644
index e701f5d..0000000
--- a/doc-build/Makefile.am
+++ /dev/null
@@ -1,12 +0,0 @@
-bin_SCRIPTS = gnome-doc-common
-
-pkgdatadir = $(datadir)/gnome-common/data
-pkgdata_DATA = \
- omf.make \
- xmldocs.make
-
-EXTRA_DIST = \
- omf.make \
- xmldocs.make \
- gnome-doc-common.in \
- README
diff --git a/doc-build/README b/doc-build/README
deleted file mode 100644
index 6b44642..0000000
--- a/doc-build/README
+++ /dev/null
@@ -1,9 +0,0 @@
-To automatically include the standard user documentation build files (omf.make
-and xmldocs.make) in you package, set USE_COMMON_DOC_BUILD=yes in autogen.sh
-before calling the macros2/autogen.sh script.
-
-When porting applications across to use this feature, ensure that all of the
-references to xmldocs.make are to $(top_srcdir)/xmldocs.make in the appropriate
-Makefile.am files. Some modules assume that xmldocs.make is in another
-directory (like docs/ or something).
-
diff --git a/doc-build/gnome-doc-common.in b/doc-build/gnome-doc-common.in
deleted file mode 100644
index aede9a5..0000000
--- a/doc-build/gnome-doc-common.in
+++ /dev/null
@@ -1,49 +0,0 @@
-#!/bin/sh
-
-progname=`echo "$0" | sed 's%^.*/%%'`
-
-PROGRAM=gnome-doc-common
-PACKAGE=@PACKAGE@
-VERSION=@VERSION@
-
-prefix=@prefix@
-datarootdir=@datarootdir@
-datadir=@datadir@
-
-# options
-docdir=.
-copy=no
-
-while test $# -gt 0; do
- case "$1" in
- --help)
- echo "usage: $progname [--version|--help]" 1>&2
- exit 1 ;;
- --version)
- echo "$PROGRAM ($PACKAGE) $VERSION"
- exit 0 ;;
- --copy)
- copy=yes
- shift ;;
- -*)
- echo "$progname: unrecognised option '$1'" 1>&2
- echo "usage: $progname [--version|--help]" 1>&2
- exit 1 ;;
- *)
- echo "$progname: too many arguments" 1>&2
- echo "usage: $progname [--version|--help]" 1>&2
- exit 1 ;;
- esac
-done
-
-for file in omf.make xmldocs.make; do
- rm -f $docdir/$file
- if test "$copy" = yes; then
- cp -f $datadir/$PACKAGE/data/$file $docdir/ ||
- exit 1
- else
- ln -sf $datadir/$PACKAGE/data/$file $docdir/ ||
- cp -f $datadir/$PACKAGE/data/$file $docdir/ ||
- exit 1
- fi
-done
diff --git a/doc-build/omf.make b/doc-build/omf.make
deleted file mode 100644
index 35dec24..0000000
--- a/doc-build/omf.make
+++ /dev/null
@@ -1,65 +0,0 @@
-#
-# No modifications of this Makefile should be necessary.
-#
-# This file contains the build instructions for installing OMF files. It is
-# generally called from the makefiles for particular formats of documentation.
-#
-# Note that you must configure your package with --localstatedir=/var
-# so that the scrollkeeper-update command below will update the database
-# in the standard scrollkeeper directory.
-#
-# If it is impossible to configure with --localstatedir=/var, then
-# modify the definition of scrollkeeper_localstate_dir so that
-# it points to the correct location. Note that you must still use
-# $(localstatedir) in this or when people build RPMs it will update
-# the real database on their system instead of the one under RPM_BUILD_ROOT.
-#
-# Note: This make file is not incorporated into xmldocs.make because, in
-# general, there will be other documents install besides XML documents
-# and the makefiles for these formats should also include this file.
-#
-# About this file:
-# This file was derived from scrollkeeper_example2, a package
-# illustrating how to install documentation and OMF files for use with
-# ScrollKeeper 0.3.x and 0.4.x. For more information, see:
-# http://scrollkeeper.sourceforge.net/
-# Version: 0.1.3 (last updated: March 20, 2002)
-#
-
-omf_dest_dir=$(datadir)/omf/@PACKAGE@
-scrollkeeper_localstate_dir = $(localstatedir)/scrollkeeper
-
-# At some point, it may be wise to change to something like this:
-# scrollkeeper_localstate_dir = @SCROLLKEEPER_STATEDIR@
-
-omf: omf_timestamp
-
-omf_timestamp: $(omffile)
- -for file in $(omffile); do \
- absfile=$(srcdir)/$$file; \
- test -r $$file && absfile=$$file; \
- scrollkeeper-preinstall $(docdir)/$(docname).xml $$absfile $$file.out; \
- done; \
- touch omf_timestamp
-
-install-data-hook-omf:
- $(mkinstalldirs) $(DESTDIR)$(omf_dest_dir)
- for file in $(omffile); do \
- absfile=$(srcdir)/$$file.out; \
- test -r $$file.out && absfile=$$file.out; \
- $(INSTALL_DATA) $$absfile $(DESTDIR)$(omf_dest_dir)/$$file; \
- done
- -scrollkeeper-update -p $(DESTDIR)$(scrollkeeper_localstate_dir) -o $(DESTDIR)$(omf_dest_dir)
-
-uninstall-local-omf:
- -for file in $(omffile); do \
- basefile=`basename $$file`; \
- rm -f $(DESTDIR)$(omf_dest_dir)/$$basefile; \
- done
- -rmdir $(DESTDIR)$(omf_dest_dir)
- -scrollkeeper-update -p $(DESTDIR)$(scrollkeeper_localstate_dir)
-
-clean-local-omf:
- -for file in $(omffile); do \
- rm -f $$file.out; \
- done
diff --git a/doc-build/xmldocs.make b/doc-build/xmldocs.make
deleted file mode 100644
index b93e3f3..0000000
--- a/doc-build/xmldocs.make
+++ /dev/null
@@ -1,101 +0,0 @@
-#
-# No modifications of this Makefile should be necessary.
-#
-# To use this template:
-# 1) Define: figdir, docname, lang, omffile, and entities in
-# your Makefile.am file for each document directory,
-# although figdir, omffile, and entities may be empty
-# 2) Make sure the Makefile in (1) also includes
-# "include $(top_srcdir)/xmldocs.make" and
-# "dist-hook: app-dist-hook".
-# 3) Optionally define 'entities' to hold xml entities which
-# you would also like installed
-# 4) Figures must go under $(figdir)/ and be in PNG format
-# 5) You should only have one document per directory
-# 6) Note that the figure directory, $(figdir)/, should not have its
-# own Makefile since this Makefile installs those figures.
-#
-# example Makefile.am:
-# figdir = figures
-# docname = scrollkeeper-manual
-# lang = C
-# omffile=scrollkeeper-manual-C.omf
-# entities = fdl.xml
-# include $(top_srcdir)/xmldocs.make
-# dist-hook: app-dist-hook
-#
-# About this file:
-# This file was taken from scrollkeeper_example2, a package illustrating
-# how to install documentation and OMF files for use with ScrollKeeper
-# 0.3.x and 0.4.x. For more information, see:
-# http://scrollkeeper.sourceforge.net/
-# Version: 0.1.2 (last updated: March 20, 2002)
-#
-
-
-# ********** Begin of section some packagers may need to modify **********
-# This variable (docdir) specifies where the documents should be installed.
-# This default value should work for most packages.
-docdir = $(datadir)/gnome/help/$(docname)/$(lang)
-
-# ********** You should not have to edit below this line **********
-xml_files = $(entities) $(docname).xml
-
-EXTRA_DIST = $(xml_files) $(omffile)
-CLEANFILES = omf_timestamp
-
-include $(top_srcdir)/omf.make
-
-all: omf
-
-$(docname).xml: $(entities)
- -ourdir=`pwd`; \
- cd $(srcdir); \
- cp $(entities) $$ourdir
-
-app-dist-hook:
- if test "$(figdir)"; then \
- $(mkinstalldirs) $(distdir)/$(figdir); \
- for file in $(srcdir)/$(figdir)/*.png; do \
- basefile=`echo $$file | sed -e 's,^.*/,,'`; \
- $(INSTALL_DATA) $$file $(distdir)/$(figdir)/$$basefile; \
- done \
- fi
-
-install-data-local: omf
- $(mkinstalldirs) $(DESTDIR)$(docdir)
- for file in $(xml_files); do \
- cp $(srcdir)/$$file $(DESTDIR)$(docdir); \
- done
- if test "$(figdir)"; then \
- $(mkinstalldirs) $(DESTDIR)$(docdir)/$(figdir); \
- for file in $(srcdir)/$(figdir)/*.png; do \
- basefile=`echo $$file | sed -e 's,^.*/,,'`; \
- $(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/$(figdir)/$$basefile; \
- done \
- fi
-
-install-data-hook: install-data-hook-omf
-
-uninstall-local: uninstall-local-doc uninstall-local-omf
-
-uninstall-local-doc:
- -if test "$(figdir)"; then \
- for file in $(srcdir)/$(figdir)/*.png; do \
- basefile=`echo $$file | sed -e 's,^.*/,,'`; \
- rm -f $(DESTDIR)$(docdir)/$(figdir)/$$basefile; \
- done; \
- rmdir $(DESTDIR)$(docdir)/$(figdir); \
- fi
- -for file in $(xml_files); do \
- rm -f $(DESTDIR)$(docdir)/$$file; \
- done
- -rmdir $(DESTDIR)$(docdir)
-
-clean-local: clean-local-doc clean-local-omf
-
-# for non-srcdir builds, remove the copied entities.
-clean-local-doc:
- if test $(srcdir) != .; then \
- rm -f $(entities); \
- fi
diff --git a/macros2/gnome-autogen.sh b/macros2/gnome-autogen.sh
index 28ee66d..798f1af 100644
--- a/macros2/gnome-autogen.sh
+++ b/macros2/gnome-autogen.sh
@@ -12,7 +12,6 @@ test "$REQUIRED_GLIB_GETTEXT_VERSION" || REQUIRED_GLIB_GETTEXT_VERSION=2.2.0
test "$REQUIRED_INTLTOOL_VERSION" || REQUIRED_INTLTOOL_VERSION=0.25
test "$REQUIRED_PKG_CONFIG_VERSION" || REQUIRED_PKG_CONFIG_VERSION=0.14.0
test "$REQUIRED_GTK_DOC_VERSION" || REQUIRED_GTK_DOC_VERSION=1.0
-test "$REQUIRED_DOC_COMMON_VERSION" || REQUIRED_DOC_COMMON_VERSION=2.3.0
test "$REQUIRED_GNOME_DOC_UTILS_VERSION" || REQUIRED_GNOME_DOC_UTILS_VERSION=0.4.2
# a list of required m4 macros. Package can set an initial value
@@ -332,11 +331,6 @@ if $want_gnome_doc_utils; then
"http://ftp.gnome.org/pub/GNOME/sources/gnome-doc-utils/"
fi
-if [ "x$USE_COMMON_DOC_BUILD" = "xyes" ]; then
- version_check gnome-common DOC_COMMON gnome-doc-common \
- $REQUIRED_DOC_COMMON_VERSION " "
-fi
-
check_m4macros
if [ "$#" = 0 -a "x$NOCONFIGURE" = "x" ]; then
@@ -376,10 +370,6 @@ for configure_ac in $configure_files; do
$GTKDOCIZE --copy || exit 1
fi
- if [ "x$USE_COMMON_DOC_BUILD" = "xyes" ]; then
- printbold "Running gnome-doc-common..."
- gnome-doc-common --copy || exit 1
- fi
if grep "^GNOME_DOC_INIT" $basename >/dev/null; then
printbold "Running $GNOME_DOC_PREPARE..."
$GNOME_DOC_PREPARE --force --copy || exit 1