[PATCH 1/3] Documentation: hooks: fix missing verb in pre-applypatch description
Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
Documentation/hooks.txt | 9 +++++----
1 files changed, 5 insertions(+), 4 deletions(-)
Here is a patch series with my current "Documentation"
improvements.
The changes since the last patches are the following:
- move fix to "hooks" before other changes
- fix links to the renamed "githooks" (patch 2/3)
- rename and convert to man pages some tutorials
(new patch 3/3)
diff --git a/Documentation/hooks.txt b/Documentation/hooks.txt
index 44fbe58..1283ab4 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.
--
1.5.5.1.124.g7e5fa.dirty
Christian Couder <chriscool@tuxfamily.org>