--------------------------------------
Info and reminders for the development
--------------------------------------

Translations
------------

Note: examples here are given for the french localisation, change the
'fr' directory to the one corresponding to your targeted language !

Note: the commands expressed here should be executable in
backup-monitor's source directory (in the parent directory of ./bin
and ./share).

Requires: the "gettext" package.


- Get the template file::

$ xgettext -k_ -kN_ --package-name=backup-monitor --package-version=1.5 -o share/locale/backup-monitor.pot bin/backup-monitor.py 


- Chose one of the following actions:

  * Reuse and update an old one (here fr)::

$ msgmerge -U share/locale/fr/LC_MESSAGES/backup-monitor.po share/locale/backup-monitor.pot


  * Create a new localisation (here fr)::

$ msginit -i share/locale/backup-monitor.pot -o share/locale/fr/LC_MESSAGES/backup-monitor.po



- Generate the binary file to be installed (here fr)::

$ msgfmt share/locale/fr/LC_MESSAGES/backup-monitor.po -o share/locale/fr/LC_MESSAGES/backup-monitor.mo


Testing
-------

There is no unit-test for backup-monitor, this is not a result of some
strange ideology, but just due to lack of time (compared to a very
limited vision concerning this project's future developments... ).

However one might quickly "test" the modifications by using some
command-line options handled by backup-monitor.py. These options are

  - help: will show this message, and deactivate everything else. 

  - now: dont wait before actually launching the program.

  - verbose: talk to me pleaaaase.

  - once: launch the backup procedure only once (do not stay in background).

  - test: just a test run that will mostly print what would be done in
    a real run and perform a rsync dry run.
    


Ideas for cleanup
-----------------

The code is probably not as clean as it should and could be improvde by:

- finding a better way to manage path in the python script (those that
  are expressed as gloabal variables for now)

- clarify the roles of the functions and the high level class (the
  current mix looks a bit weird)