From e62b352eed49eebb08f717b0533222440b13de7f Mon Sep 17 00:00:00 2001 From: Mike Fleetwood Date: Thu, 21 Feb 2019 16:30:03 +0000 Subject: [PATCH] Remove use of GNOME 2 gnome-doc-utils documentation infrastructure (!24) Details of old GNOME 2 gnome-doc-utils: Migrating your documentation to gnome-doc-utils https://wiki.gnome.org/Projects/GnomeDocUtils/MigrationHowTo First part is to stop using gnome-doc-utils to build and install the documentation. Also since updating the OMF catalog was only needed for GNOME 2 yelp, use of scrollkeeper is completely removed too. Closes !24 - Port to GNOME 3 yelp-tools documentation infrastructure --- .gitignore | 5 ----- .gitlab-ci.yml | 8 ++++---- Makefile.am | 9 ++------- README | 16 +++------------- autogen.sh | 17 +---------------- configure.ac | 23 ++--------------------- help/Makefile.am | 3 --- help/gparted.omf.in | 9 --------- 8 files changed, 12 insertions(+), 78 deletions(-) delete mode 100644 help/gparted.omf.in diff --git a/.gitignore b/.gitignore index ed1dbe08..87d8b214 100644 --- a/.gitignore +++ b/.gitignore @@ -8,7 +8,6 @@ *.lo *.mo *.o -*.omf .cproject .csettings .deps @@ -33,8 +32,6 @@ gparted.appdata.xml gparted.desktop gparted.desktop.in gpartedbin -gnome-doc-utils.make -help/*/gparted.xml install-sh intltool-* lib/gtest/lib @@ -45,7 +42,6 @@ m4/*.m4 !m4/ax_cxx_compile_stdcxx.m4 missing mkinstalldirs -omf.make org.gnome.gparted.policy org.gnome.gparted.policy.in stamp-* @@ -58,4 +54,3 @@ tests/test_BlockSpecial tests/test_PasswordRAMStore tests/test_PipeCapture tests/test_dummy -xmldocs.make diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 3bba2937..7437ca0f 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -7,18 +7,18 @@ stages: image: centos:latest before_script: - yum update -y - - yum install -y which gnome-common gnome-doc-utils glib2-devel intltool + - yum install -y which gnome-common glib2-devel intltool gcc-c++ libuuid-devel parted-devel gtkmm30-devel make - polkit file rarian-compat + polkit file .ubuntu_image_template: &ubuntu_image_definition # Use official Ubuntu image https://hub.docker.com/_/ubuntu/. image: ubuntu:latest before_script: - apt-get update - - apt-get install -y gnome-common gnome-doc-utils libglib2.0-dev-bin + - apt-get install -y gnome-common libglib2.0-dev-bin uuid-dev libparted-dev libgtkmm-3.0-dev make - policykit-1 rarian-compat + policykit-1 .build_stage_template: &build_stage_definition stage: build diff --git a/Makefile.am b/Makefile.am index 549d2a1a..aa2aaf76 100644 --- a/Makefile.am +++ b/Makefile.am @@ -79,8 +79,7 @@ EXTRA_DIST = \ intltool-extract.in \ intltool-merge.in \ intltool-update.in \ - gparted.in \ - gnome-doc-utils.make + gparted.in DISTCLEANFILES = \ $(appdata_DATA) \ @@ -88,8 +87,4 @@ DISTCLEANFILES = \ $(polkit_action_DATA) \ intltool-extract \ intltool-merge \ - intltool-update \ - gnome-doc-utils.make - -DISTCHECK_CONFIGURE_FLAGS = \ - --disable-scrollkeeper + intltool-update diff --git a/README b/README index aa1bb4d1..959ddf24 100644 --- a/README +++ b/README @@ -88,7 +88,6 @@ b. Building from Source gnome-common gtkmm3 gettext - gnome-doc-utils - required if help documentation is to be built On Debian or Ubuntu, these dependencies may be obtained by running one of the following commands: @@ -97,20 +96,19 @@ b. Building from Source Or; sudo apt-get install build-essential e2fsprogs uuid uuid-dev \ gnome-common libparted-dev libgtkmm-3.0-dev \ - libdevmapper-dev gnome-doc-utils docbook-xml + libdevmapper-dev docbook-xml On Fedora, you will need to run (as root); yum install gtkmm30-devel parted-devel e2fsprogs-devel gettext \ 'perl(XML::Parser)' desktop-file-utils libuuid-devel \ - gnome-doc-utils docbook-dtds intltool gnome-common \ - gcc-c++ + docbook-dtds intltool gnome-common gcc-c++ yum groupinstall 'Development Tools' On openSUSE, these dependencies may be obtained by running the following commands; sudo zypper install automake autoconf make gnome-common \ libuuid-devel parted-devel gtkmm3-devel \ - gnome-doc-utils-devel docbook-xsl-stylesheets + docbook-xsl-stylesheets sudo zypper install -t pattern devel_c_c++ Again, build GParted with the default configuration and install into @@ -123,14 +121,6 @@ b. Building from Source the --disable-doc flag: E.g., ./configure --disable-doc - Scrollkeeper is needed on GNOME/Gtk 2 desktops to update the OMF - catalog files to allow yelp to display the GParted help manual. On - GNOME/Gtk 3 desktops scrollkeeper in not required. Use can be - explicitly disabled with the --disable-scrollkeeper flag: - E.g., ./configure --disable-scrollkeeper - Note that the configure script will automatically disable - scrollkeeper if the scrollkeeper-update command is not found. - If you wish to build this package to use native libparted /dev/mapper dmraid support use the --enable-libparted-dmraid flag: E.g., ./configure --enable-libparted-dmraid diff --git a/autogen.sh b/autogen.sh index 94f6351a..7feb6796 100755 --- a/autogen.sh +++ b/autogen.sh @@ -25,19 +25,4 @@ if ! test -d $srcdir/m4; then mkdir $srcdir/m4 fi -# Check for GNOME-DOC-UTILS -GDUMAKE="gnome-doc-utils.make" -datadir=`pkg-config --variable=datadir gnome-doc-utils` -GDUMAKEFULLPATH="$datadir/gnome-doc-utils/$GDUMAKE" -if test "X$datadir" = 'X' || ! test -f "${GDUMAKEFULLPATH}" ; then - echo "Cannot find file: $GDUMAKE" - echo "You need to install gnome-doc-utils" - exit 1 -fi -# Ensure a copy of gnome-doc-utils.make exists in the top source directory -test -e $srcdir/$GDUMAKE || { - echo "Copying $GDUMAKEFULLPATH to $srcdir" - cp -p $GDUMAKEFULLPATH $srcdir -} - -REQUIRED_AUTOMAKE_VERSION=1.9 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh +REQUIRED_AUTOMAKE_VERSION=1.9 . gnome-autogen.sh diff --git a/configure.ac b/configure.ac index 5cd17502..9485eb4e 100644 --- a/configure.ac +++ b/configure.ac @@ -277,31 +277,13 @@ else fi if test "x$enable_doc" = xyes; then - GNOME_DOC_INIT + : else - dnl Do not care if GDU is not found - GNOME_DOC_INIT(,,[:]) + : fi AM_CONDITIONAL([BUILD_HELP_DOC], [test "x$enable_doc" = xyes]) -dnl GNOME 2 yelp needs scrollkeeper database updates to find installed GNOME help files. -dnl GNOME 3 yelp doesn't need scrollkeeper and its use is deprecated. To avoid requiring -dnl deprecated scrollkeeper on GNOME 3, automatically disable scrollkeeper database -dnl updates when the command is not available. -dnl (See /usr/share/aclocal/gnome-doc-utils.m4 for the GNOME_DOC_INIT macro which has -dnl already parsed the --disable-scrollkeeper option and set enable_scrollkeeper and -dnl ENABLE_SK). -AC_CHECK_PROG([have_scrollkeeper_update], [scrollkeeper-update], yes, no) -AC_MSG_CHECKING([whether to enable scrollkeeper database update]) -if test "$enable_scrollkeeper" = "yes" -a "$have_scrollkeeper_update" = "yes"; then - AC_MSG_RESULT([yes]) -else - enable_scrollkeeper=no - AM_CONDITIONAL([ENABLE_SK], false) - AC_MSG_RESULT([no]) -fi - dnl====================== dnl check whether to use native libparted dmraid support @@ -392,7 +374,6 @@ echo "======================== Final configuration ===========================" echo " Installing into prefix : $prefix" echo "" echo " Build help documentation? : $enable_doc" -echo " Update scrollkeeper database? : $enable_scrollkeeper" echo "" echo " Use native libparted dmraid support? : $enable_libparted_dmraid" echo "" diff --git a/help/Makefile.am b/help/Makefile.am index bf297b5c..96c43de9 100644 --- a/help/Makefile.am +++ b/help/Makefile.am @@ -1,6 +1,3 @@ -include $(top_srcdir)/gnome-doc-utils.make -dist-hook: doc-dist-hook - #The name of the help document to build. # This is the filename without the .xml extension. DOC_MODULE = gparted diff --git a/help/gparted.omf.in b/help/gparted.omf.in deleted file mode 100644 index bfab04fe..00000000 --- a/help/gparted.omf.in +++ /dev/null @@ -1,9 +0,0 @@ - - - - - manual - - - -