GnomeDocUtilsMigrationHowTo improvements

[Behdad Esfahbod <behdad behdad org>]

Hi,

Hope these are the right lists to write to.  I would like to suggest
some improvements in the GnomeDocUtilsMigrationHowTo document [1].
Warning: rants following.

First problem is: translators go on and convert translations for a
language in a module to GnomeDocUtils, remove the
help/<lang>/Makefile.am file and walk away happily, leaving a broken
build behind...  Has happened quite a few times to me, including today
[2].

There are also a couple of technical problems with that document.  One
is:

<quote>
Set your build system up: 
      * If you don't have one yet, create a m4 directory in your
        toplevel source directory; and create a .cvsignore file in it
        containing at least gnome-doc-utils.m4. Add this directory and
        its .cvsignore to cvs. 
        
      * Add the following to configure.ac (resp. configure.in): 
        
              * AC_CONFIG_MACRO_DIR([m4])
  * Add m4 to EXTRA_DIST in the top-level Makefile.am See below Note 2
</quote>

This is absolutely unnecessary, and it does create problems.  A lot.


Finally, as noted by Mariano [2], the "--disable-scrollkeeper to
DISTCHECK_CONFIGURE_FLAGS in the top-level Makefile.am" part is also not
necessary.  scrollkeeper has never kept make distcheck from running.
Not recently enough that I've seen FWIW.


rants off,
behdad


[1] http://live.gnome.org/GnomeDocUtilsMigrationHowTo
[2] http://bugzilla.gnome.org/show_bug.cgi?id=354056

-- 
behdad
http://behdad.org/

"Commandment Three says Do Not Kill, Amendment Two says Blood Will Spill"
        -- Dan Bern, "New American Language"