am doc: add a pointer to relevant hooks
authorJonathan Nieder <jrnieder@gmail.com>
Mon, 24 Feb 2014 20:38:29 +0000 (12:38 -0800)
committerJunio C Hamano <gitster@pobox.com>
Mon, 24 Feb 2014 21:23:57 +0000 (13:23 -0800)
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>
Documentation/git-am.txt
index 54d8461d61b2f2ad5dbf5ce8c9106534d1a74289..abcffb64bea677e30639c10f61083f3960207ecb 100644 (file)
@@ -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
 --------