summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Documentation/hooks.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/hooks.txt b/Documentation/hooks.txt
index 44fbe58f20..1283ab4daa 100644
--- a/Documentation/hooks.txt
+++ b/Documentation/hooks.txt
@@ -28,10 +28,11 @@ The default 'applypatch-msg' hook, when enabled, runs the
pre-applypatch
--------------
-This hook is invoked by `git-am`. It takes no parameter,
-and is invoked after the patch is applied, but before a commit
-is made. Exiting with non-zero status causes the working tree
-after application of the patch not committed.
+This hook is invoked by `git-am`. It takes no parameter, and is
+invoked after the patch is applied, but before a commit is made.
+
+If it exits with non-zero status, then the working tree will not be
+committed after applying the patch.
It can be used to inspect the current working tree and refuse to
make a commit if it does not pass certain test.