GNOME Bugzilla – Bug 729931
Remove doc-build infrastructure
Last modified: 2016-07-11 20:27:35 UTC
It was needed in the gnome-doc-utils era, but that has long since passed. According to fredp, the following modules still set USE_COMMON_DOC_BUILD: empathy/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh file-roller/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gcalctool/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gdl/autogen.sh:REQUIRED_AUTOMAKE_VERSION=1.11 GNOME_DATADIR="$gnome_datadir" USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gnome-calculator/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gnome-calendar/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gnome-disk-utility/autogen.sh:REQUIRED_AUTOMAKE_VERSION=1.9 USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gnome-font-viewer/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gnome-packagekit/autogen.sh:REQUIRED_AUTOMAKE_VERSION=1.7 GNOME_DATADIR="$gnome_datadir" USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gnome-power-manager/autogen.sh:REQUIRED_AUTOMAKE_VERSION=1.7 GNOME_DATADIR="$gnome_datadir" USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gnome-shell/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gnome-software/autogen.sh:REQUIRED_AUTOMAKE_VERSION=1.7 GNOME_DATADIR="$gnome_datadir" USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh gnome-system-monitor/autogen.sh:USE_COMMON_DOC_BUILD=yes gnome-utils/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh grilo/autogen.sh:USE_COMMON_DOC_BUILD=yes \ grilo-plugins/autogen.sh:USE_COMMON_DOC_BUILD=yes \ jhbuild/autogen.sh: USE_COMMON_DOC_BUILD=yes gnome-autogen.sh $@ libgda/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh libgit2-glib/autogen.sh:USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh mutter/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh mutter-wayland/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh planner/autogen.sh:USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh polkit-gnome/autogen.sh:REQUIRED_AUTOMAKE_VERSION=1.9 USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh pyatspi2-python2/autogen.sh:if [ "x$USE_COMMON_DOC_BUILD" = "xyes" ]; then pyatspi2-python2/autogen.sh: if [ "x$USE_COMMON_DOC_BUILD" = "xyes" ]; then pygtk/autogen.sh:if [ "x$USE_COMMON_DOC_BUILD" = "xyes" ]; then pygtk/autogen.sh: if [ "x$USE_COMMON_DOC_BUILD" = "xyes" ]; then vinagre/autogen.sh:ACLOCAL_FLAGS="$ACLOCAL_FLAGS" USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh Most of them seem to be doing so erroneously, since they never used gnome-doc-utils. A trial build of Empathy using the patch attached to this bug report succeeds.
Created attachment 276300 [details] [review] 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.
Created attachment 276301 [details] [review] macros2: Remove support for gnome-doc-utils Remove support for checking for the GNOME_DOC_INIT macro in configure.ac and calling gnome-doc-prepare if found. gnome-doc-utils has not been used in any modules we care about for a long time.
Created attachment 284462 [details] [review] 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.
Created attachment 284463 [details] [review] macros2: Remove support for gnome-doc-utils Remove support for checking for the GNOME_DOC_INIT macro in configure.ac and calling gnome-doc-prepare if found. gnome-doc-utils has not been used in any modules we care about for a long time.
Review of attachment 284463 [details] [review]: Looks fine, but should probably wait until after the freeze before pushing.
Review of attachment 284462 [details] [review]: Seems fine, but like the other removals this should wait until after the freeze.
Pushed. Attachment 284462 [details] pushed as a912a74 - doc-build: Remove doc-build infrastructure Attachment 284463 [details] pushed as 1f60e95 - macros2: Remove support for gnome-doc-utils
How was the list of modules in the in initial report created? I ask because it missed both Gnumeric and goffice. At least the former really does use it. What's the new way of doing things?
(In reply to Morten Welinder from comment #8) > How was the list of modules in the in initial report created? Can’t remember; fredp did it, I presume based off one of the release jhbuild modulesets. > At least the former really does use it. What's the new way of doing things? Just copy the old code from gnome-common into Gnumeric, and that should work. The new way of doing things is to use Mallard as the documentation format, and yelp-tools to provide the build macros: https://wiki.gnome.org/Apps/Yelp/Tools/yelp.m4