branch: fix segfault when resolving an invalid HEAD
[gitweb.git] / Documentation / git-applypatch.txt
index 55facd2c7a4c8e0c8a142ba3bc3d64902276ba84..451434a757eab84d502a9529c571bc647e8b76d7 100644 (file)
@@ -3,25 +3,40 @@ git-applypatch(1)
 
 NAME
 ----
-git-applypatch - Some git command not yet documented.
+git-applypatch - Apply one patch extracted from an e-mail
 
 
 SYNOPSIS
 --------
-'git-applypatch' [ --option ] <args>...
+'git-applypatch' <msg> <patch> <info> [<signoff>]
 
 DESCRIPTION
 -----------
-Does something not yet documented.
+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
 -------
---option::
-       Some option not yet documented.
+<msg>::
+       Commit log message (sans the first line, which comes
+       from e-mail Subject stored in <info>).
+
+<patch>::
+       The patch to apply.
 
-<args>...::
-       Some argument not yet documented.
+<info>::
+       Author and subject information extracted from e-mail,
+       used on "author" line and as the first line of the
+       commit log message.
 
 
 Author
@@ -34,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