Finish git-am documentation.
Signed-off-by: Junio C Hamano <junkio@cox.net>
Junio C Hamano committed
Oct 20, 2005 at 22:14 UTC
baa720f501a1e8e81fcc6813e28e0ed01d6ca6dd
1 file changed
+49
-10
Documentation/git-am.txt
+49
-10
@@ -8,7 +8,7 @@ git-am - Apply a series of patches in a mailbox
8
9
SYNOPSIS
10
--------
11
-'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--3way] <mbox>
11
+'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--3way] <mbox>...
12
'git-am' [--skip]
13
14
DESCRIPTION
@@ -17,17 +17,56 @@ 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.
20
+OPTIONS
21
+-------
22
+--signoff::
23
+ Add `Signed-off-by:` line to the commit message, using
24
+ the committer identity of yourself.
25
26
+--dotest=<dir>::
27
+ Instead of `.dotest` directory, use <dir> as a working
28
+ area to store extracted patches.
29
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.
30
+--utf8, --keep::
31
+ Pass `--utf8` and `--keep` flags to `git-mailinfo` (see
32
+ gitlink:git-mailinfo[1]).
33
+
34
+--3way::
35
+ When the patch does not apply cleanly, fall back on
36
+ 3-way merge, if the patch records the identity of blobs
37
+ it is supposed to apply to, and we have those blobs
38
+ locally.
39
+
40
+--skip::
41
+ Skip the current patch. This is only meaningful when
42
+ restarting an aborted patch.
43
+
44
+--interactive::
45
+ Run interactively, just like git-applymbox.
46
+
47
+
48
+DISCUSSION
49
+----------
50
+
51
+When initially invoking it, you give it names of the mailboxes
52
+to crunch. Upon seeing the first patch that does not apply, it
53
+aborts in the middle, just like 'git-applymbox' does. You can
54
+recover from this in one of two ways:
55
+
56
+. skip the current one by re-running the command with '--skip'
57
+ option.
58
+
59
+. hand resolve the conflict in the working directory, run 'git
60
+ diff HEAD' to extract the merge result into a patch form and
61
+ replacing the patch part of the message in .dotest directory.
62
+ After doing this, run `git-reset --hard HEAD` to bring the
63
+ working tree to the state before half-applying the patch, then
64
+ re-run the command without any options.
65
+
66
+The command refuses to process new mailboxes while `.dotest`
67
+directory exists, so if you decide to start over from scratch,
68
+run `rm -f .dotest` before running the command with mailbox
69
+names.
70
71
72
SEE ALSO