docs: Add a pointer to the git post-receive hook

[patchwork] / docs / INSTALL

diff --git a/docs/INSTALL b/docs/INSTALL
index 5043c930c2f3c0363135b37f12b4b02db0ee2c52..2c1a0a95593ba4ed2fb27454557f92d9d3e3b151 100644 (file)
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -9,7 +9,7 @@ You'll need the following (applications used for patchwork development are
 in brackets):
 
   * A python interpreter
-  * django >= 1.2
+  * django >= 1.5
   * A webserver (apache)
   * mod_python or flup
   * A database server (postgresql, mysql)
@@ -85,11 +85,11 @@ in brackets):
         lib/packages is for stuff we'll download, lib/python is to add
         to our python path. We'll symlink python modules into lib/python.
 
-        At the time of release, patchwork depends on django version 1.2 or
+        At the time of release, patchwork depends on django version 1.5 or
         later. Your distro probably provides this. If not, do a:
 
          cd lib/packages
-         git clone https://github.com/django/django.git -b stable/1.2.x
+         git clone https://github.com/django/django.git -b stable/1.5.x
          cd ../python
          ln -s ../packages/django/django ./django
 
@@ -217,6 +217,23 @@ fastcgi:
 
      sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
 
+7. Optional: Configure your VCS to automatically update patches
+
+    The tools directory of the patchwork distribution contains a file
+    named post-receive.hook which is an example git hook that can be
+    used to automatically update patches to the Accepted state when
+    corresponding comits are pushed via git.
+
+    To install this hook, simply copy it to the .git/hooks directory on
+    your server, name it post-receive, and make it executable.
+
+    This sample hook has support to update patches to different states
+    depending on which branch is being pushed to. See the STATE_MAP
+    setting in that file.
+
+    If you are using a system other than git, you can likely write a
+    similar hook using pwclient to update patch state. If you do write
+    one, please contribute it.
 
 Some errors: