use GIT_DIR instead of /var/tmp

[thirdparty/git.git] / Documentation / git-format-patch.txt

diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index a1483ffd0f865eb486686d7c8050090b389a81c3..d7ca2dbb22994a31ded56f6060c25acc69e4dab7 100644 (file)
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -8,7 +8,7 @@ git-format-patch - Prepare patches for e-mail submission.
 
 SYNOPSIS
 --------
-'git-format-patch' [-n][-o <dir>][-k][--mbox][--diff-options] <his> [<mine>]
+'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] [--diff-options] <his> [<mine>]
 
 DESCRIPTION
 -----------
@@ -32,28 +32,72 @@ processing with applymbox.
 
 OPTIONS
 -------
--o <dir>::
+-o|--output-directory <dir>::
        Use <dir> to store the resulting files, instead of the
        current working directory.
 
--n::
+-n|--numbered::
        Name output in '[PATCH n/m]' format.
 
--k::
+-k|--keep-subject::
        Do not strip/add '[PATCH]' from the first line of the
        commit log message.
 
---author, --date::
+-a|--author, -d|--date::
        Output From: and Date: headers for commits made by
        yourself as well.  Usually these are output only for
        commits made by people other than yourself.
 
---mbox::
+-s|--signoff::
+       Add `Signed-off-by:` line to the commit message, using
+       the committer identity of yourself.
+
+-c|--check::
+        Display suspicious lines in the patch.  The definition
+        of 'suspicious lines' is currently the lines that has
+        trailing whitespaces, and the lines whose indentation
+        has a SP character immediately followed by a TAB
+        character.
+
+-m|--mbox::
        Format the output files for closer to mbox format by
        adding a phony Unix "From " line, so they can be
        concatenated together and fed to `git-applymbox`.
        Implies --author and --date.
 
+--stdout::
+       This flag generates the mbox formatted output to the
+       standard output, instead of saving them into a file per
+       patch and implies --mbox.
+
+
+EXAMPLES
+--------
+
+git-format-patch -k --stdout R1..R2 | git-am -3 -k::
+       Extract commits between revisions R1 and R2, and apply
+       them on top of the current branch using `git-am` to
+       cherry-pick them.
+
+git-format-patch origin::
+       Extract commits the current branch accumulated since it
+       pulled from origin the last time in a patch form for
+       e-mail submission.
+
+git-format-patch -M -B origin::
+       The same as the previous one, except detect and handle
+       renames and complete rewrites intelligently to produce
+       renaming patch.  A renaming patch reduces the amount of
+       text output, and generally makes it easier to review
+       it.  Note that the "patch" program does not understand
+       renaming patch well, so use it only when you know the
+       recipient uses git to apply your patch.
+
+
+See Also
+--------
+gitlink:git-am[1], gitlink:git-send-email
+
 
 Author
 ------