Merge branch 'js/detach-doc'
[gitweb.git] / Documentation / git-am.txt
index 40178be92278407465ba539b94292b4632c2132d..51297d09ecdd3468ecd87a4f7aa6fac2b8ef6224 100644 (file)
@@ -9,13 +9,13 @@ git-am - Apply a series of patches from a mailbox
 SYNOPSIS
 --------
 [verse]
-'git am' [--signoff] [--keep] [--utf8 | --no-utf8]
+'git am' [--signoff] [--keep] [--keep-cr | --no-keep-cr] [--utf8 | --no-utf8]
         [--3way] [--interactive] [--committer-date-is-author-date]
         [--ignore-date] [--ignore-space-change | --ignore-whitespace]
         [--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>]
         [--reject] [-q | --quiet] [--scissors | --no-scissors]
-        [<mbox> | <Maildir>...]
-'git am' (--skip | --resolved | --abort)
+        [(<mbox> | <Maildir>)...]
+'git am' (--continue | --skip | --abort)
 
 DESCRIPTION
 -----------
@@ -25,7 +25,7 @@ current branch.
 
 OPTIONS
 -------
-<mbox>|<Maildir>...::
+(<mbox>|<Maildir>)...::
        The list of mailbox files to read patches from. If you do not
        supply this argument, the command reads from the standard input.
        If you supply directories, they will be treated as Maildirs.
@@ -37,7 +37,14 @@ 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]).
+
+--keep-cr::
+--no-keep-cr::
+       With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
+       with the same option, to prevent it from stripping CR at the end of
+       lines. `am.keepcr` configuration variable can be used to specify the
+       default behaviour.  `--no-keep-cr` is useful to override `am.keepcr`.
 
 -c::
 --scissors::
@@ -53,7 +60,7 @@ OPTIONS
 
 -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
@@ -63,7 +70,7 @@ This was optional in prior versions of git, but now it is the
 default.   You can 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::
@@ -81,7 +88,7 @@ default.   You can use `--no-utf8` to override this.
 -p<n>::
 --directory=<dir>::
 --reject::
-       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.
 
@@ -107,6 +114,7 @@ default.   You can use `--no-utf8` to override this.
        Skip the current patch.  This is only meaningful when
        restarting an aborted patch.
 
+--continue::
 -r::
 --resolved::
        After a patch failure (e.g. attempting to apply
@@ -121,7 +129,7 @@ default.   You can 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.