X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=git-format-patch.txt;h=7cc7fafc1d7fbe380ffa53e0d028886e15d0010e;hb=6d891e69a947d5abd6ecd44db9748716b8c428f5;hp=47705de4fc4b525f2b686d628473f63ec4f53da2;hpb=235a91e6b0d1d18a2517cf7e0a18278a6912bdb0;p=git.git diff --git a/git-format-patch.txt b/git-format-patch.txt index 47705de4..7cc7fafc 100644 --- a/git-format-patch.txt +++ b/git-format-patch.txt @@ -3,34 +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 -------- [verse] -'git-format-patch' [-n | -k] [-o | --stdout] [-s] [-c] [--mbox] +'git-format-patch' [-n | -k] [-o | --stdout] [--attach] [-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 ------- @@ -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,17 +55,23 @@ 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 patch and implies --mbox. +--attach:: + Create attachments instead of inlining patches. + + +CONFIGURATION +------------- +You can specify extra mail header lines to be added to each +message in the repository configuration as follows: + +[format] + headers = "Organization: git-foo\n" + EXAMPLES --------