cvs commit: doc/el_GR.ISO8859-7/share/tools/checkupdate checkupdate.1 checkupdate.py

[Giorgos Keramidas]

On Sun, 15 Jun 2008 16:36:55 +0000 (UTC), Giorgos Keramidas <keramida at FreeBSD.org> wrote:
> keramida    2008-06-15 16:36:55 UTC
>
>   FreeBSD doc repository
>
>   Modified files:
>     el_GR.ISO8859-7/share/tools/checkupdate checkupdate.1
>                                             checkupdate.py
>   Log:
>   checkupdate: Add a new -e option that reports 'everything'.
>
>   When the -e option is enabled, report file revision information
>   for 'everything', including files that don't need a translation
>   update.
>
>   Revision  Changes    Path
>   1.2       +5 -1      doc/el_GR.ISO8859-7/share/tools/checkupdate/checkupdate.1
>   1.3       +11 -2     doc/el_GR.ISO8859-7/share/tools/checkupdate/checkupdate.py

Many thanks to Gabor Pali (pgj) for kicking my ass into actually
finishing this.  It's been sitting in a "that would be nice" TODO entry
for months, until he wrote a shell version, which I translated to this
Python version of the same script to add a bit of debugging and make it
a bit extensible :)

The script isn't as well documented as I would like it to be, but it
should be easy to use for other translations too, or to adapt it to use
the 'Original version:' convention already present in some translations.

A typical run for the doc/el_GR.ISO8859-7 tree is:

(1) For a file collection that is 'up to date' with the English version:

    :
    : % find el_GR.ISO8859-7/articles/compiz-fusion | checkupdate
    : %
    :

    In this case, no output means the obvious: no updates needed.

    With the -e flag, the file revisions are reported anyway, even if
    they match:

    :
    : % find el_GR.ISO8859-7/articles/compiz-fusion | checkupdate -e
    : el_GR.ISO8859-7/articles/compiz-fusion/Makefile rev. 1.1
    :     1.1        -> 1.1         en_US.ISO8859-1/articles/compiz-fusion/Makefile
    :
    : el_GR.ISO8859-7/articles/compiz-fusion/article.sgml rev. 1.2
    :     1.6        -> 1.6         en_US.ISO8859-1/articles/compiz-fusion/article.sgml
    :
    : %

(2) For a file collection that needs updates:

    : keramida at kobe:/hg/doc/el$ find el_GR.ISO8859-7/articles/formatting-media | checkupdate
    : el_GR.ISO8859-7/articles/formatting-media/Makefile rev. 1.3
    :     1.1        -> 1.8         en_US.ISO8859-1/articles/formatting-media/Makefile
    :
    : el_GR.ISO8859-7/articles/formatting-media/article.sgml rev. 1.7
    :     1.29       -> 1.31        en_US.ISO8859-1/articles/formatting-media/article.sgml
    :
    : keramida at kobe:/hg/doc/el$

    Each file that needs a translation update is reported in 2 lines.

    The first line shows the translated file path and its current CVS or
    Subversion revision number.  The second line shows:

      * The originally translated version, as it is recorded in the
        %SRCID% comment in the file.

      * The current CVS or Subversion revision of the English master
        source file.

      * The path of the master source file, as it is recorded in the
        %SOURCE% comment of the translated file.  This usually matches
        the translated path, except for a few files in `share/'.

    If the %SOURCE% comment points to a file that doesn't really exist
    the script should print:

            1.29       -> NONE        en_US.ISO8859-1/blah (MISSING)

    It doesn't do this yet, but I'll add it soon-ish.

Other things we want to add with pgj@ are:

  * The ability to preview the diff of OLDREV -> NEWREV, so that
    translators can run the script to get a feel of what needs
    translation.

  * Some rundimentary 'file checks' like:

      - The translated file is missing a $FreeBSD$ line.

      - The %SRCID% tag in the translated file links to an absurd
        revision (i.e. greater than the latest English revision)

      - etc.