git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Updated githooks docs to cover pre-push script
@ 2008-08-19 19:07 Scott Chacon
  0 siblings, 0 replies; only message in thread
From: Scott Chacon @ 2008-08-19 19:07 UTC (permalink / raw)
  To: git list; +Cc: Junio C Hamano

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

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2008-08-19 19:08 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-08-19 19:07 [PATCH] Updated githooks docs to cover pre-push script Scott Chacon

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).