diff options
| -rw-r--r-- | Documentation/git-format-patch.txt | 32 | ||||
| -rwxr-xr-x | git-format-patch.sh | 30 |
2 files changed, 25 insertions, 37 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 47705de4f..9ac063685 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -9,28 +9,27 @@ git-format-patch - Prepare patches for e-mail submission. SYNOPSIS -------- [verse] -'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] +'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--diff-options] <his> [<mine>] DESCRIPTION ----------- Prepare each commit with its patch since <mine> head forked from -<his> 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. +<his> 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 <dir>; 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 ------- @@ -45,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. @@ -61,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 diff --git a/git-format-patch.sh b/git-format-patch.sh index 5fb8ce1fb..e54c9e4a9 100755 --- a/git-format-patch.sh +++ b/git-format-patch.sh @@ -3,23 +3,23 @@ # Copyright (c) 2005 Junio C Hamano # -USAGE='[-n | -k] [-o <dir> | --stdout] [--signoff] [--check] [--mbox] [--diff-options] <upstream> [<our-head>]' -LONG_USAGE='Prepare each commit with its patch since our-head forked from upstream, -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. +USAGE='[-n | -k] [-o <dir> | --stdout] [--signoff] [--check] [--diff-options] <his> [<mine>]' +LONG_USAGE='Prepare each commit with its patch since <mine> head forked from +<his> head, one file per patch formatted to resemble UNIX mailbox +format, for e-mail submission or use with git-am. -There are three output modes. By default, output files are created in -the current working directory; when -o is specified, they are created -in that directory instead; when --stdout is specified, they are spit -on standard output, and can be piped to git-am. +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 -n is specified, instead of "[PATCH] Subject", the first line is formatted -as "[PATCH N/M] Subject", unless you have only one patch. +When -o is specified, output files are created in <dir>; 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.' . git-sh-setup # Force diff to run in C locale. @@ -48,7 +48,7 @@ do -s|--s|--si|--sig|--sign|--signo|--signof|--signoff) signoff=t ;; --st|--std|--stdo|--stdou|--stdout) - stdout=t mbox=t date=t author=t ;; + stdout=t ;; -o=*|--o=*|--ou=*|--out=*|--outp=*|--outpu=*|--output=*|--output-=*|\ --output-d=*|--output-di=*|--output-dir=*|--output-dire=*|\ --output-direc=*|--output-direct=*|--output-directo=*|\ |