Planner Goal: distcheck (2017)

1. Purpose

By obsolescence, Planner code became non-buildable.

Planner Goal: distcheck aims to make Planner comply with GNOME Goal: distcheck, thus buildable.

The expected outcome is a 0.14.7 micro release.

Test case:

$ git clone git://git.gnome.org/planner
$ cd planner
$ ./autogen.sh
$ ./configure
$ make
$ make check
$ make install
$ make installcheck
$ make distcheck
================================================
planner-0.14.7 archives ready for distribution:
planner-0.14.7.tar.gz
================================================

Throughout the process, the build system should not complain.

No code is expected to change.

Right files should be installed in the right places. The installed application should work properly. Fixing already broken functionality is not required.

No backward compatibility is required from the build system.

This goal is estimated at 2 Person-Months. Knowledge of the GNU Build System and GNOME is helpful. It is due for 2017-12-31 at the latest. It will be closed by sending a message to the discussion list for planner developers.

2. References

1. Planner Git

2. Planner/Build Bugzilla

3. GNOME Goal: distcheck

4. GNOME Goal: Modernize your autotools configuration

3. Comments

Discussion takes place at the discussion list for planner developers.

Relevant theads:

1. making a release, Andrew, 2017-04-22

   1. Re: making a release, Alexandre, 2017-05-03

      2. Re: making a release, Ahmed, 2017-05-08

         2. Re: making a release, Ahmed, 2017-06-07

            1. Re: making a release, Andrew, 2017-06-08

      3. Re: making a release, Ahmed, 2017-06-07

4. WBS

• 1. Pass the distcheck stage of the build process

  • The test case must unroll error-free.

  1. Bug 782100 - ./autogen.sh fails

  2. Bug 782227 - make check fails

  3. Bug 782346 - make distcheck fails

  4. Commit 9a7df13 - make distcheck fails

  2. Install the User's Guide

  • This task was previously named "2. Investigate Bug 782100".

    GNOME Goal: Port To New Documentation Infrastructure is a direction.

  1. Bug 346247 - Switch to yelp-tools

     • The fact is that the User's Guide is out of reach.

       $ LANG=C yelp help:planner
       $ LANG=C planner (and ask for help)

  2. Bug XXXXXX - Recover existing translations

     • The User's Guide has been translated into Basque and Spanish. Translators' work must be valued at its true value.

       $ LANG=eu_ES.utf8 yelp help:planner
       $ LANG=es_ES.utf8 planner (and ask for help)

  3. Bug XXXXXX - Switch to Mallard

     • This task is not mandatory. It is estimated at 2 Person-Weeks. It is postponed to another round.

  3. Resolve same build issues

  • The warnings from the build system should be minimized.

    GNOME Goal: Modernize your autotools configuration is a direction.

  1. Bug 703067 - Use AX_COMPILER_FLAGS

  2. Bug 742998 - Add m4/

  3. Bug 743091 - Use AM_CPPFLAGS

  4. Bug 747423 - Modernize GTK-Doc

     • This task involves moving comments from GTK-Doc SGML templates to C sources. Too much code change is involved, though only comments are concerned. This task is postponed to another round.

  5. Bug 783246 - Predictable Python plug-in

     • The standard build (i.e. with no option specified) should have a standard (predictable) result.

  4. Push trivial awaiting list

  1. Integrate Debian patches

     1. Debian Planner Package bugs

        • No Debian bug concern the build system.

     2. Debian Planner Package patches

        • fix-as-needed-build.patch solves Bug 697712 - should use -lm to build the planner binary differently.

          no-index-sgml.patch is the same as Bug 782346 - make distcheck fails because of missing docs/libplanner/html/index.sgml.

          plugins_directory.diff changes modules and plugins directories.

  2. Integrate Fedora patches

     1. Fedora Planner package bugs

        • No Fedora bug concern Planner.

     2. Fedora Planner package patches

        • planner-desktop-warnings.patch modifies data/desktop.in.in.

  5. Remove dead dependencies

  • Can any one elaborate ?

  6. Still passes distcheck

  • Can any one elaborate ?

  7. Check the install stage of the build process

  • Apart from fixing the build system, we are releasing a GNOME application. It must integrate the desktop and be functional.

    Time passing, make installcheck should expand.

  1. Bug XXXXXX - Localization is not functional

     • This seriously blocks any GNOME application release.

  2. Bug XXXXXX - Don't use update-mime-database

     • Non-root users should be able to install Planner.

  3. Bug XXXXXX - Don't use update-desktop-database

  4. Bug XXXXXX - Don't use gconftool-2

  8. Release

  1. Update the repository
  2. Update the wiki

     • == New in Planner v0.14.7 Release - 31 December 2017 ==
        * Planner complies with GNOME Goal: distcheck.
         Thanks to: Alexánder Alzate <jhonnyalexander_91 yahoo es>,
         Ahmed Baïzid <ahmed baizid org>,
         Piotr Drąg <piotrdrag gmail com>, and
         Andrew Miloradovsky <miloradovsky gmail com>.

  3. Update Planner status on GNOME Goal: distcheck

5. Status

$ git clone git://git.gnome.org/planner
$ cd planner
$ ./autogen.sh
***Warning*** USE_COMMON_DOC_BUILD is deprecated, you may remove it from autogen.sh
***Warning*** USE_GNOME2_MACROS is deprecated, you may remove it from autogen.sh
***Warning*** PKG_NAME is deprecated, you may remove it from autogen.sh
libtoolize: Consider adding 'AC_CONFIG_MACRO_DIRS([m4])' to configure.ac,
libtoolize: and rerunning libtoolize and aclocal.
libtoolize: Consider adding '-I m4' to ACLOCAL_AMFLAGS in Makefile.am.
eds-backend/Makefile.am:1: warning: 'INCLUDES' is the old name for 'AM_CPPFLAGS'
eds-backend/planner-source/Makefile.am:1: warning: 'INCLUDES' is the old name for 'AM_CPPFLAGS'
eds-backend/utils/Makefile.am:1: warning: 'INCLUDES' is the old name for 'AM_CPPFLAGS'
libplanner/Makefile.am:1: warning: 'INCLUDES' is the old name for 'AM_CPPFLAGS'
python/Makefile.am:1: warning: 'INCLUDES' is the old name for 'AM_CPPFLAGS'
src/Makefile.am:1: warning: 'INCLUDES' is the old name for 'AM_CPPFLAGS'
tests/Makefile.am:3: warning: 'INCLUDES' is the old name for 'AM_CPPFLAGS'
$ ./configure
$ make
$ make check
$ make install
$ make installcheck
$ make distcheck
gtkdoc-mktmpl is deprecated and will be removed from one of the next gtk-doc release.
Please refer to the documentation "Modernizing the documentation"/"GTK-Doc 1.9".
WARNING: failed to install schema ...
================================================
planner-0.14.7 archives ready for distribution:
planner-0.14.7.tar.gz
================================================

6. Epilog

Planner followed its turtle pace of development. 2018, GNOME moved to Gitlab. As of 2020-07, Planner doesn't build on GNU/Linux, still.