[master 1/8] Dump gtk-doc.

David Shea dshea at redhat.com
Thu Jul 24 19:32:45 UTC 2014


Gtk-doc is the worst. Allow me to enumerate:

  - It adds an option to our autoconf script that causes everything to
    fail if it is disabled. It is disabled by default.

  - It's driven through an opaque Makefile that forces docs to be built
    at source distribution time.

  - It requires the library to be built before it can generate docs, so
    it requires a full build before a source tarball can be created.

  - ...and it doesn't set up any Makefile dependencies at all, so it
    just fails if you forget to do a build first.

  - In fact, it's pretty crummy about keeping track of the dependencies
    for its own generated files. If you add or remove one of the source
    files that docs are generated from, you pretty much just have to do
    a git clean and start over.

  - It pulls in a ton of dependencies for other docs packages so that it
    can generate cross references but it still doesn't have cross
    reference data for half the stuff in glib because it sucks.

Also no one reads the docs, probably. --enable-gtk-doc will now cause
./configure to fail: we're yanking this band-aid off so update your
builds.
---
 .gitignore                           |  7 ----
 widgets/Makefile.am                  |  4 +--
 widgets/autogen.sh                   |  1 -
 widgets/configure.ac                 |  6 ----
 widgets/doc/AnacondaWidgets-docs.xml | 63 ------------------------------------
 widgets/doc/Makefile.am              | 59 ---------------------------------
 6 files changed, 2 insertions(+), 138 deletions(-)
 delete mode 100644 widgets/doc/AnacondaWidgets-docs.xml
 delete mode 100644 widgets/doc/Makefile.am

diff --git a/.gitignore b/.gitignore
index 1f46374..a218d6f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -35,7 +35,6 @@ configure
 data/liveinst/gnome/fedora-welcome.desktop
 depcomp
 dirbrowser
-gtk-doc.m4
 install-sh
 keymaps-override-*
 libtool
@@ -83,12 +82,6 @@ tests/test-suite.log
 updates.img
 utils/dd/dd_extract
 utils/dd/dd_list
-widgets/doc/AnacondaWidgets-*.txt
-widgets/doc/AnacondaWidgets.*
-widgets/doc/*.stamp
-widgets/doc/html
-widgets/doc/xml
-widgets/gtk-doc.make
 widgets/src/gettext.h
 anaconda.po
 data/liveinst/gnome/fedora-welcome.po
diff --git a/widgets/Makefile.am b/widgets/Makefile.am
index ad80f87..be28f54 100644
--- a/widgets/Makefile.am
+++ b/widgets/Makefile.am
@@ -21,10 +21,10 @@
 
 ACLOCAL_AMFLAGS = -I m4
 
-SUBDIRS = src python glade doc data
+SUBDIRS = src python glade data
 
 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.guess config.h.in config.sub \
-	configure depcomp gtk-doc.make install-sh ltmain.sh missing py-compile \
+	configure depcomp install-sh ltmain.sh missing py-compile \
 	m4/*.m4
 
 run-glade:
diff --git a/widgets/autogen.sh b/widgets/autogen.sh
index e18b17c..55ed5de 100755
--- a/widgets/autogen.sh
+++ b/widgets/autogen.sh
@@ -1,7 +1,6 @@
 #!/bin/bash -e
 [ -d m4 ] || mkdir m4
 libtoolize --copy --force
-gtkdocize --copy
 aclocal -I m4
 autoconf
 autoheader --force
diff --git a/widgets/configure.ac b/widgets/configure.ac
index 49c4104..1922afa 100644
--- a/widgets/configure.ac
+++ b/widgets/configure.ac
@@ -47,11 +47,6 @@ GOBJECT_INTROSPECTION_CHECK([0.6.7])
 AS_IF([test "x$found_introspection" = xyes], [:],
       [AC_MSG_ERROR([*** GObject introspection must be enabled])])
 
-dnl A missing GTK_DOC_CHECK should fail in autogen.sh running gtkdocize, but
-dnl might as well check it here too
-m4_pattern_forbid([GTK_DOC_CHECK])dnl
-GTK_DOC_CHECK([1.14], [--flavour no-tmpl])
-
 PKG_CHECK_MODULES([GLADEUI], [gladeui-2.0 >= 3.10])
 PKG_CHECK_MODULES([GTK], [gtk+-x11-3.0 >= 3.11.3])
 PKG_CHECK_MODULES([GLIB], [glib-2.0])
@@ -64,7 +59,6 @@ AC_STRUCT_TIMEZONE
 
 AC_CHECK_FUNCS([pow setenv setlocale strchr])
 AC_CONFIG_FILES([Makefile
-                 doc/Makefile
                  glade/Makefile
                  src/Makefile
                  python/Makefile
diff --git a/widgets/doc/AnacondaWidgets-docs.xml b/widgets/doc/AnacondaWidgets-docs.xml
deleted file mode 100644
index b67f97d..0000000
--- a/widgets/doc/AnacondaWidgets-docs.xml
+++ /dev/null
@@ -1,63 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
-<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
-]>
-
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
-    <bookinfo>
-        <title>The AnacondaWidgets Library Reference Manual</title>
-
-        <authorgroup>
-            <author>
-                <firstname>Chris</firstname>
-                <surname>Lumens</surname>
-                <affiliation>
-                    <address>
-                        <email>clumens at redhat.com</email>
-                    </address>
-                </affiliation>
-            </author>
-        </authorgroup>
-    </bookinfo>
-
-    <chapter id="windows">
-        <title>Window Widgets</title>
-        <xi:include href="xml/BaseWindow.xml" />
-        <xi:include href="xml/BaseStandalone.xml" />
-        <xi:include href="xml/HubWindow.xml" />
-        <xi:include href="xml/SpokeWindow.xml" />
-        <xi:include href="xml/StandaloneWindow.xml" />
-    </chapter>
-
-    <chapter id="disks">
-        <title>Disk-Related Widgets</title>
-        <xi:include href="xml/DiskOverview.xml" />
-        <xi:include href="xml/MountpointSelector.xml" />
-    </chapter>
-
-    <chapter id="miscellaneous">
-        <title>Miscellaneous Widgets</title>
-        <xi:include href="xml/SpokeSelector.xml" />
-        <xi:include href="xml/LayoutIndicator.xml" />
-    </chapter>
-
-    <chapter id="utility">
-	<title>Utility Functions</title>
-	<xi:include href="xml/widgets-common.xml" />
-    </chapter>
-
-    <chapter id="hierarchy">
-        <title>Object Hierarchy</title>
-        <xi:include href="xml/tree_index.sgml" />
-    </chapter>
-
-    <index id="api-index-full">
-        <title>Index</title>
-        <xi:include href="xml/api-index-full.xml" />
-    </index>
-
-    <xi:include href="xml/annotation-glossary.xml">
-	<xi:fallback />
-    </xi:include>
-</book>
diff --git a/widgets/doc/Makefile.am b/widgets/doc/Makefile.am
deleted file mode 100644
index b148f39..0000000
--- a/widgets/doc/Makefile.am
+++ /dev/null
@@ -1,59 +0,0 @@
-# Makefile.am for anaconda widget documentation
-#
-# Copyright (C) 2011  Red Hat, Inc.
-#
-# This copyrighted material is made available to anyone wishing to use,
-# modify, copy, or redistribute it subject to the terms and conditions of
-# the GNU General Public License v.2, or (at your option) any later version.
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY expressed or implied, including the implied warranties of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
-# Public License for more details.  You should have received a copy of the
-# GNU General Public License along with this program; if not, write to the
-# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-# 02110-1301, USA.  Any Red Hat trademarks that are incorporated in the
-# source code or documentation are not subject to the GNU General Public
-# License and may only be used or replicated with the express permission of
-# Red Hat, Inc.
-#
-# Red Hat Author(s): Chris Lumens <clumens at redhat.com>
-#
-
-## Process this file with automake to produce Makefile.in
-
-# The name of the module.
-DOC_MODULE=AnacondaWidgets
-
-# The top-level SGML file.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
-
-# Directories containing the source code.
-DOC_SOURCE_DIR=$(top_srcdir)
-
-# Header files to ignore while scanning.
-IGNORE_HFILES = config.h \
-	gettext.h \
-	intl.h
-
-# Extra options to supply to gtkdoc-scan.
-SCAN_OPTIONS=--rebuild-types
-
-# Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--sgml-mode
-
-# Only needed if you are using gtkdoc-scangobj to dynamically query widget
-# signals and properties (which we are).
-GTKDOC_CFLAGS=$(GLIB_CFLAGS) $(GTK_CFLAGS)
-GTKDOC_LIBS=$(GLIB_LIBS) $(GTK_LIBS) $(top_builddir)/src/libAnacondaWidgets.la
-
-include $(top_srcdir)/gtk-doc.make
-
-if ENABLE_GTK_DOC
-TESTS_ENVIRONMENT = cd $(srcdir) && \
-  DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
-  SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
-#TESTS = $(GTKDOC_CHECK)
-endif
-
-MAINTAINERCLEANFILES = AnacondaWidgets-overrides.txt AnacondaWidgets-sections.txt \
-	AnacondaWidgets.types Makefile.in
-- 
1.9.3



More information about the anaconda-patches mailing list