[Buildbot-devel] Documentation for GitMaildirSource

[Samuli Seppänen]

Hi,

Here's first (and hopefully final) version of documentation for the
GitMaildirSource patch I sent in earlier - see my email from 16th Nov 2010:

<http://thread.gmane.org/gmane.comp.python.buildbot.devel/6563>

I will write the test cases as soon as possible.

---

4.6.3.7 GitMaildirSource

GitMaildirSource parses commit mails sent by the Git's default
post-receive-email hook. It parses correctly mails sent directly to
buildbot's
maildir and those that have extra footers added by a mailing list server
(e.g.
sourceforge.net).

A change object is created only when a commit has changed a file,
meaning that
merge commits and such are ignored. In case a post-receive-email
contains more
than one commit, the author of the last commit is used as the author for the
change object.

The GitMaildirSource takes only one parameter: the location of the
maildir where
post-receive-emails arrive. To use this changesource, add this to your
buildbot
master configuration file:

 from buildbot.changes.mail import GitMaildirSource
 c['change_source'] = GitMaildirSource("~/maildir")

---

All the best,

Samuli