summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Nieder <jrnieder@gmail.com>2014-02-24 12:38:29 -0800
committerJunio C Hamano <gitster@pobox.com>2014-02-24 13:23:57 -0800
commit0e3d40c60d9ae14ddc9f525ce4db3cbc0bde5278 (patch)
treefb6357f0542505db995335113f85043c56cf2eaf
parent5f95c9f850b19b368c43ae399cc831b17a26a5ac (diff)
downloadgit-jn/am-doc-hooks.tar.gz
am doc: add a pointer to relevant hooksjn/am-doc-hooks
It is not obvious when looking at a new command what hooks will affect it. Add a HOOKS section to the git-am(1) page, imitating git-commit(1), to make it easier for people to discover e.g. the applypatch-msg hook that can implement a custom subject-mangling strategy (e.g., removing a "bug #nnnn:" prefix introduced by a bug tracker). Reported-by: Phillip Susi <psusi@ubuntu.com> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-am.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 54d8461d61..abcffb64be 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -189,6 +189,11 @@ commits, like running 'git am' on the wrong branch or an error in the
commits that is more easily fixed by changing the mailbox (e.g.
errors in the "From:" lines).
+HOOKS
+-----
+This command can run `applypatch-msg`, `pre-applypatch`,
+and `post-applypatch` hooks. See linkgit:githooks[5] for more
+information.
SEE ALSO
--------