summaryrefslogtreecommitdiff
path: root/Documentation/git-am.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-am.txt')
-rw-r--r--Documentation/git-am.txt33
1 files changed, 21 insertions, 12 deletions
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 5622971f6a..c45c53ec24 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -9,11 +9,11 @@ git-am - Apply a series of patches from a mailbox
SYNOPSIS
--------
[verse]
-'git-am' [--signoff] [--keep] [--utf8 | --no-utf8]
+'git am' [--signoff] [--keep] [--utf8 | --no-utf8]
[--3way] [--interactive] [--binary]
[--whitespace=<option>] [-C<n>] [-p<n>]
- <mbox>|<Maildir>...
-'git-am' [--skip | --resolved]
+ [<mbox> | <Maildir>...]
+'git am' (--skip | --resolved | --abort)
DESCRIPTION
-----------
@@ -35,11 +35,11 @@ OPTIONS
-k::
--keep::
- Pass `-k` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
+ Pass `-k` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]).
-u::
--utf8::
- Pass `-u` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
+ Pass `-u` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]).
The proposed commit log message taken from the e-mail
is re-coded into UTF-8 encoding (configuration variable
`i18n.commitencoding` can be used to specify project's
@@ -49,7 +49,7 @@ This was optional in prior versions of git, but now it is the
default. You could use `--no-utf8` to override this.
--no-utf8::
- Pass `-n` flag to `git-mailinfo` (see
+ Pass `-n` flag to 'git-mailinfo' (see
linkgit:git-mailinfo[1]).
-3::
@@ -61,17 +61,17 @@ default. You could use `--no-utf8` to override this.
-b::
--binary::
- Pass `--allow-binary-replacement` flag to `git-apply`
+ Pass `--allow-binary-replacement` flag to 'git-apply'
(see linkgit:git-apply[1]).
--whitespace=<option>::
- This flag is passed to the `git-apply` (see linkgit:git-apply[1])
+ This flag is passed to the 'git-apply' (see linkgit:git-apply[1])
program that applies
the patch.
-C<n>::
-p<n>::
- These flags are passed to the `git-apply` (see linkgit:git-apply[1])
+ These flags are passed to the 'git-apply' (see linkgit:git-apply[1])
program that applies
the patch.
@@ -97,7 +97,10 @@ default. You could use `--no-utf8` to override this.
to the screen before exiting. This overrides the
standard message informing you to use `--resolved`
or `--skip` to handle the failure. This is solely
- for internal use between `git-rebase` and `git-am`.
+ for internal use between 'git-rebase' and 'git-am'.
+
+--abort::
+ Restore the original branch and abort the patching operation.
DISCUSSION
----------
@@ -140,11 +143,17 @@ aborts in the middle,. You can recover from this in one of two ways:
the index file to bring it in a state that the patch should
have produced. Then run the command with '--resolved' option.
-The command refuses to process new mailboxes while `.dotest`
+The command refuses to process new mailboxes while `.git/rebase-apply`
directory exists, so if you decide to start over from scratch,
-run `rm -f -r .dotest` before running the command with mailbox
+run `rm -f -r .git/rebase-apply` before running the command with mailbox
names.
+Before any patches are applied, ORIG_HEAD is set to the tip of the
+current branch. This is useful if you have problems with multiple
+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).
+
SEE ALSO
--------