Roundup devel tracker in love with Mercurial
=============================================

This document serves a tutorial on setting up a Roundup instance
with devel template featuring Mercurial integration. Several assumptions
are made in this tutorial:

1) You've checked out gsoc-2009 Roundup branch
2) You know how to setup mercurial repository
3) You want to work with a local mercurial repository

Let's follow the steps:

1) Setup Mercurial post-commit hook

a) Copy notify-roundup.sh from scripts/notify-roundup/hg/notify-roundup.sh to somewhere
b) Change paths to notify-roundup.{py,ini} and your roundup instance inside notify-roundup.sh [1]
b) Make sure its executable (chmod +x)
c) Add the following to /path/to/hg/repo/.hg/hgrc

[hooks]
commit = /path/to/notify-roundup.sh

Note: Commit should probably be changed by "incoming". This is subject to further investigation.

[1] notify-roundup.py and notify-roundup.ini can be found in scripts/notify-roundup

2) Modify notify-roundup.ini

a) Set tracker home: tracker-home = /path/to/tracker-home
b) Set address mappings
Please be aware that we are playing tricks with Mercurial here. Your Roundup user should be the same
as your first name for Mercurial. Lets explore that further with an example:

HG author is set as: Mario Danic <mario@nospam.com>
Notify-roundup would look for address mapping like this:
mario = whatever_email_you_registered_with_to_Roundup

So it takes your first name, lowers all chars and uses mappings
to find appropriate Roundup user. 
c) Set VCS type to hg

3) Now, now, this wasn't so hard :)

How-to format mercurial commit message
=======================================

By default, notify-roundup handles bugs.
To change status of bug1, format your commit
message like this:

bug1 pending

Current limitations and bugs
============================

1) Notify-roundup can work only with one item-class
2) Notify-roundup can only modify Status
3) Commit date isn't parsed 
4) Summary isn't composed
5) Changed files should be generated and posted
6) Diff should be created for vcs_rev page
7) Parse multiple lines of commit message
    * This might already work

We are aware of the those limitations, and have plans to alleviate them in the future.