[PATCH] Updated githooks docs to cover pre-push script

From: Scott Chacon <schacon@gmail.com>
Date: Aug 19, 2008, 19:07 UTC
Message-ID: <d411cc4a0808191207j28380749i922ae9981f3e32dd@mail.gmail.com>

The new entry covers how the pre-push script runs and outlines possible use-cases for the script.

Signed-off-by: Scott Chacon <schacon@gmail.com>
---
 Documentation/githooks.txt |   12 ++++++++++++
 1 files changed, 12 insertions(+), 0 deletions(-)

diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index 046a2a7..939181f 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -299,6 +299,18 @@ This hook is invoked by 'git-gc --auto'. It takes
no parameter, and
 exiting with non-zero status from this script causes the 'git-gc --auto'
 to abort.

+pre-push
+-----------
+
+This hook is invoked by 'git push'. It takes no parameter, and
+exiting with non-zero status from this script causes the 'git push'
+command to abort.
+
+This script is useful for self-enforcing policies, such as running a script
+that checks for code-compliance, running automated tests, etc.  You can
+use this script to help ensure that your pushes are sane in an automatic
+fashion.
+
 GIT
 ---
 Part of the linkgit:git[1] suite
--
1.6.0.GIT