Brief documentation for the mysterious git-am script
The git-am script is nowhere called and nowhere (including itself) explained, and the name isn't helpful either. For those like me who will wonder what is it about, add some documentation stub for it to the documentation. I probably got something wrong and I don't feel like investigating all the options - this is just kind of "emergency" docs. Signed-off-by: Petr Baudis <pasky@suse.cz> Signed-off-by: Junio C Hamano <junkio@cox.net>
Petr Baudis committed
Oct 21, 2005 at 02:28 UTC
42e2cba20466e50825c55d2642da72bf4f088040
3 files changed
+54
-1
Documentation/git-am.txt
new
+51
@@ -0,0 +1,51 @@
1
+git-am(1)
2
+================
3
+
4
+NAME
5
+----
6
+git-am - Apply a series of patches in a mailbox
7
+
8
+
9
+SYNOPSIS
10
+--------
11
+'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--3way] <mbox>
12
+'git-am' [--skip]
13
+
14
+DESCRIPTION
15
+-----------
16
+Splits mail messages in a mailbox into commit log message,
17
+authorship information and patches, and applies them to the
18
+current branch.
19
+
20
+This is the replacement for the 'git-applymbox' script.
21
+Unlike git-applymbox, it can take more than one mailbox file from
22
+the command line, as well as reading from the standard input when
23
+'-' is specified. Other differences include changed parameter names
24
+and less descriptive command name.
25
+
26
+
27
+When initially invoking it, you give it name of the mailbox to crunch.
28
+The usage hints that it might get interrupted and you will want to
29
+resume the last round of applying - to do that, pass it no mailbox
30
+name, and optionally the mysterious '--skip' parameter.
31
+
32
+
33
+SEE ALSO
34
+--------
35
+gitlink:git-applymbox[1], gitlink:git-applypatch[1].
36
+
37
+
38
+Author
39
+------
40
+Written by Junio C Hamano <junkio@cox.net>
41
+
42
+Documentation
43
+--------------
44
+Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
45
+
46
+This manual page is a stub. You can help the git documentation by expanding it.
47
+
48
+GIT
49
+---
50
+Part of the gitlink:git[7] suite
51
+
Documentation/git-applymbox.txt
+1
-1
@@ -75,7 +75,7 @@ OPTIONS
75
76
SEE ALSO
77
--------
78
-gitlink:git-applypatch[1].
78
+gitlink:git-am[1], gitlink:git-applypatch[1].
79
80
81
Author
git-applymbox.sh
+2
@@ -15,6 +15,8 @@
15
## Pay a special attention to the commit log message if you do this and
16
## use a Signoff_file, because applypatch wants to append the sign-off
17
## message to msg-clean every time it is run.
18
+##
19
+## git-am is supposed to be the newer and better tool for this job.
20
21
. git-sh-setup || die "Not a git archive"
22