X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-format-patch.txt;h=7c467c56a3802aa2efd4b488919d197ea5b84529;hb=7aaa715d0abb12067504af08919197a67a68aca7;hp=d7ca2dbb22994a31ded56f6060c25acc69e4dab7;hpb=803f498c03b47b1da88cf8f14ba2c374f0fc16d3;p=git.git diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index d7ca2dbb..7c467c56 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -3,32 +3,33 @@ git-format-patch(1) NAME ---- -git-format-patch - Prepare patches for e-mail submission. +git-format-patch - Prepare patches for e-mail submission SYNOPSIS -------- -'git-format-patch' [-n | -k] [-o | --stdout] [-s] [-c] [--mbox] [--diff-options] [] +[verse] +'git-format-patch' [-n | -k] [-o | --stdout] [-s] [-c] + [--diff-options] [] DESCRIPTION ----------- Prepare each commit with its patch since head forked from - head, one file per patch, for e-mail submission. Each -output file is numbered sequentially from 1, and uses the first -line of the commit message (massaged for pathname safety) as the -filename. + head, one file per patch formatted to resemble UNIX mailbox +format, for e-mail submission or use with gitlink:git-am[1]. -When -o is specified, output files are created in that -directory; otherwise in the current working directory. +Each output file is numbered sequentially from 1, and uses the +first line of the commit message (massaged for pathname safety) +as the filename. + +When -o is specified, output files are created in ; otherwise +they are created in the current working directory. This option +is ignored if --stdout is specified. When -n is specified, instead of "[PATCH] Subject", the first line is formatted as "[PATCH N/M] Subject", unless you have only one patch. -When --mbox is specified, the output is formatted to resemble -UNIX mailbox format, and can be concatenated together for -processing with applymbox. - OPTIONS ------- @@ -43,11 +44,6 @@ OPTIONS Do not strip/add '[PATCH]' from the first line of the commit log message. --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. - -s|--signoff:: Add `Signed-off-by:` line to the commit message, using the committer identity of yourself. @@ -59,12 +55,6 @@ OPTIONS 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 @@ -96,7 +86,7 @@ git-format-patch -M -B origin:: See Also -------- -gitlink:git-am[1], gitlink:git-send-email +gitlink:git-am[1], gitlink:git-send-email[1] Author