user-manual: use pithier example commit
[gitweb.git] / Documentation / git-applypatch.txt
index 14ce53aade7e0549fed75eb89c453c6556a6eacb..451434a757eab84d502a9529c571bc647e8b76d7 100644 (file)
@@ -3,7 +3,7 @@ git-applypatch(1)
 
 NAME
 ----
-git-applypatch - Apply one patch extracted from an e-mail.
+git-applypatch - Apply one patch extracted from an e-mail
 
 
 SYNOPSIS
@@ -12,10 +12,17 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
+This is usually not what an end user wants to run directly.  See
+gitlink:git-am[1] instead.
+
 Takes three files <msg>, <patch>, and <info> prepared from an
 e-mail message by 'git-mailinfo', and creates a commit.  It is
 usually not necessary to use this command directly.
 
+This command can run `applypatch-msg`, `pre-applypatch`, and
+`post-applypatch` hooks.  See link:hooks.html[hooks] for more
+information.
+
 
 OPTIONS
 -------
@@ -26,7 +33,7 @@ OPTIONS
 <patch>::
        The patch to apply.
 
-<info>:
+<info>::
        Author and subject information extracted from e-mail,
        used on "author" line and as the first line of the
        commit log message.
@@ -42,5 +49,5 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite