Skip to content
  • Curtis Gedak's avatar
    Reduce dependency on scrollkeeper (#743318) · 0eb9f1fc
    Curtis Gedak authored and Mike Fleetwood's avatar Mike Fleetwood committed
    Scrollkeeper and the associated OMF catalog files are used by the
    GNOME 2 version of yelp to display the GParted help manual.  To see how
    this works try the following command:
    
      yelp ghelp:gparted
    
    GNOME version 3 and higher yelp do not require scrollkeeper or the OMF
    catalog files to properly display the GParted help manual.  And in fact
    GNOME 3 deprecated the GNOME 2 method of building and installing GNOME
    help documents altogether; including use of GNOME_DOC_INIT autoconf
    macro, the gnome-doc-utils package and use of scrollkeeper.
    
      [GNOME 3] GNOME Goal: Port To New Documentation Infrastructure
      https://wiki.gnome.org/Initiatives/GnomeGoals/NewDocumentationInfrastructure
    
    Further, the next release of Debian, Debian 10 (Buster), will be
    removing the scrollkeeper / rarian package.
    
      rarian: Don't release with Buster
      https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=885657
    
    GParted is still a GNOME 2 app using GNOME 2 documentation build system
    using autoconf GNOME_DOC_INIT macro.
    
      [GNOME 2] Migrating your documentation to gnome-doc-utils
      https://wiki.gnome.org/Projects/GnomeDocUtils/MigrationHowTo
    
    This is needed to build GParted documentation on still supported GNOME 2
    distributions RHEL / CentOS 6.  So avoid requiring deprecated
    scrollkeeper on GNOME 3 by automatically disabling scrollkeeper database
    updates when the scrollkeeper-update command is not available.
    
      Executable          | Configure option used  | Use scrollkeeper
      scrollkeeper-update | on command line        | when building help
      exists?             |                        | for GParted?
      --------------------+------------------------+-------------------
      Yes                 | <none>                 | Yes
      Yes                 | --enable-scrollkeeper  | Yes
      Yes                 | --disable-scrollkeeper | No
                          |                        |
      No                  | <any>                  | No
    
    Note that because GParted is still using the GNOME 2 documentation build
    system it still builds and installs OMF files.  It is just that they are
    not required with GNOME 3 yelp and this commit automatically disables
    updating the scrollkeeper database when the scrollkeeper-update command
    is not available.
    
    Bug 743318 - configure script missing check for scrollkeeper dependency
    0eb9f1fc