git-commit-vandalism/contrib
Michael Haggerty bc501f69fc git-multimail: an improved replacement for post-receive-email
Add git-multimail, a tool for generating notification emails for
pushes to a Git repository.  It is largely plug-in compatible with
post-receive-email, and is proposed to eventually replace that script.
The advantages of git-multimail relative to post-receive-email are
described in README.migrate-from-post-receive-email.

git-multimail is organized in a directory contrib/hooks/multimail.
The directory contains:

* git_multimail.py -- a Python module that can generate notification
  emails for pushes to a Git repository.  The file can be used
  directly as a post-receive script (configured via git config
  settings), or it can be imported as a Python module and configured
  via arbitrary Python code.

* README -- user-level documentation for configuring and using
  git-multimail.

* post-receive -- an example of building a post-receive script that
  imports git_multimail.py as a Python module, with an example of how
  to change the email templates.

* README.migrate-from-post-receive-email -- documentation targeted at
  current users of post-receive-email, explaining the differences and
  how to migrate a post-receive-email configuration to git-multimail.

* migrate-mailhook-config -- a script that can migrate a user's
  post-receive-email configuration options to the equivalent
  git-multimail options.

* README.Git -- a short explanation of the relationship between
  git-multimail and the rest of the Git project, plus the exact date
  and revision when this version was taken from the upstream project.

All but the last file are taken verbatim from the upstream
git-multimail project.

git-multimail is originally derived from post-receive-email and also
incorporates suggestions from the mailing list as well as patches by
the people listed below.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Contributions-by: Matthieu Moy <Matthieu.Moy@imag.fr>
Contributions-by: Ramkumar Ramachandra <artagnon@gmail.com>
Contributions-by: Chris Hiestand <chrishiestand@gmail.com>
Contributions-by: Michiel Holtkamp <git@elfstone.nl>
Contributions-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2013-07-15 12:59:48 -07:00
..
blameview
buildsystems msvc: Fix an "unrecognized option" linker warning 2010-01-22 16:15:14 -08:00
ciabot Add checks to Python scripts for version dependencies. 2012-12-28 11:35:04 -08:00
completion completion: regression fix for zsh 2013-05-21 09:28:45 -07:00
continuous
convert-objects Documentation: use [verse] for SYNOPSIS sections 2011-07-06 14:26:26 -07:00
credential Merge branch 'da/downcase-u-in-usage' into maint 2013-04-01 09:19:04 -07:00
diff-highlight diff-highlight: document some non-optimal cases 2012-02-13 15:57:07 -08:00
diffall contrib/diffall: fix cleanup trap on Windows 2012-03-14 15:22:38 -07:00
emacs emacs: make 'git-status' work with separate git dirs 2012-11-26 09:34:28 -08:00
examples contrib/examples/git-remote.perl: use a lowercase "usage:" string 2013-02-24 21:30:15 -08:00
fast-import contrib/fast-import/import-zips.py: use spaces instead of tabs 2013-02-24 13:31:08 -08:00
git-jump git-jump: ignore (custom) prefix in diff mode 2012-09-17 12:31:57 -07:00
git-shell-commands Add sample commands for git-shell 2010-08-12 15:16:31 -07:00
gitview Documentation: use [verse] for SYNOPSIS sections 2011-07-06 14:26:26 -07:00
hg-to-git Add checks to Python scripts for version dependencies. 2012-12-28 11:35:04 -08:00
hooks git-multimail: an improved replacement for post-receive-email 2013-07-15 12:59:48 -07:00
mw-to-git git-remote-mediawiki: spelling fixes 2013-04-12 12:13:05 -07:00
p4import Add checks to Python scripts for version dependencies. 2012-12-28 11:35:04 -08:00
patches
persistent-https Add persistent-https to contrib 2012-05-30 13:50:45 -07:00
remote-helpers remote-hg: fix order of configuration comments 2013-05-21 09:33:24 -07:00
stats contrib: update stats/mailmap script 2012-12-12 11:09:11 -08:00
subtree contrib/subtree: fix spelling of accidentally 2013-04-12 12:23:12 -07:00
svn-fe svn-fe: allow svnrdump_sim.py to run with Python 3 2013-01-24 19:32:35 -08:00
thunderbird-patch-inline contrib/thunderbird-patch-inline: do not require bash to run the script 2011-03-30 12:29:39 -07:00
vim contrib/vim: simplify instructions for old vim support 2013-01-10 14:58:54 -08:00
workdir prefer test -h over test -L in shell scripts 2010-09-27 10:48:23 -07:00
git-resurrect.sh request-pull: protect against OPTIONS_KEEPDASHDASH from environment 2010-05-01 11:02:21 -07:00
README
remotes2config.sh
rerere-train.sh contrib/rerere-train: use installed git-sh-setup 2012-04-30 12:50:38 -07:00

Contributed Software

Although these pieces are available as part of the official git
source tree, they are in somewhat different status.  The
intention is to keep interesting tools around git here, maybe
even experimental ones, to give users an easier access to them,
and to give tools wider exposure, so that they can be improved
faster.

I am not expecting to touch these myself that much.  As far as
my day-to-day operation is concerned, these subdirectories are
owned by their respective primary authors.  I am willing to help
if users of these components and the contrib/ subtree "owners"
have technical/design issues to resolve, but the initiative to
fix and/or enhance things _must_ be on the side of the subtree
owners.  IOW, I won't be actively looking for bugs and rooms for
enhancements in them as the git maintainer -- I may only do so
just as one of the users when I want to scratch my own itch.  If
you have patches to things in contrib/ area, the patch should be
first sent to the primary author, and then the primary author
should ack and forward it to me (git pull request is nicer).
This is the same way as how I have been treating gitk, and to a
lesser degree various foreign SCM interfaces, so you know the
drill.

I expect that things that start their life in the contrib/ area
to graduate out of contrib/ once they mature, either by becoming
projects on their own, or moving to the toplevel directory.  On
the other hand, I expect I'll be proposing removal of disused
and inactive ones from time to time.

If you have new things to add to this area, please first propose
it on the git mailing list, and after a list discussion proves
there are some general interests (it does not have to be a
list-wide consensus for a tool targeted to a relatively narrow
audience -- for example I do not work with projects whose
upstream is svn, so I have no use for git-svn myself, but it is
of general interest for people who need to interoperate with SVN
repositories in a way git-svn works better than git-svnimport),
submit a patch to create a subdirectory of contrib/ and put your
stuff there.

-jc