maintainer/README

   1  maintainer
   2  -----------
   3  This directory contains some development tools which are expected to be
   4  used only by the maintainer.
   5  These tools are not distributed in the tarball, and are only present in
   6  git (that I use here as some sort of backup repository).
   7
   8  Build system rationale
   9  ----------------------
  10  Documentation only includes architecture-independant files, and is thus
  11  fully included in the distributed tarball.
  12
  13  - default is to not build the documentation
  14
  15  - because the packager will be able to install the documentation from
  16    the distributed tarball, it is enough if only the maintainer is able
  17    to build this documentation
  18
  19  - it is up to the maintainer to choose where to build the documentation:
  20    > either in the oldest targeted distribution
  21    > either in its own development machine.
  22
  23    The first choice (the oldest system) might be more secure as it will
  24    embed in aclocal.m4 a version number compatible with all other systems.
  25    Contrarily, we are not sure that choosing the second option (the newest
  26    system) does not lead to some issues in older systems.
  27
  28  - depending on the build tools version, the distribution may have to be
  29    build on the oldest or the newest system.
  30    For example, Debian 7 Wheezy (gtk-doc 1.18) requires gtk-doc to be
  31    enabled, while this is no more true with Fedora 24 (gtk-doc 1.25).
  32
  33 # in Debian 7 wheezy:
  34 # apt-get install autoconf automake pkg-config gtk-doc-tools libglib2.0-dev libgtk-3-dev libgtop2-dev libxml2-dev uuid-dev gnome-doc-utils libgconf2-dev dblatex libnautilus-extension-dev scrollkeeper
  35
  36  Building the distributed tarball
  37  --------------------------------
  38  The whole process is managed by the 'run-distcheck.sh' script:
  39
  40  - it first reconfigure (gtkdocize+autoreconf) the whole source tree
  41  - it then rebuild all sources and generates all the documentation
  42  - last it makes distcheck.
  43
  44  Running
  45  -------
  46  G_MESSAGES_DEBUG=FMA gdb ./_install/bin/fma-config-tool
  47
  48 -----------------------------------------------------------------------
  49  P. Wieser, created on jan. 2014
  50             last updated on feb. 2017