X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-format-patch.txt;h=a33d157b970740aa7d056ebb459350de89513a8b;hb=ffcc952b33575e28b971d63ba2b7e46b7726a257;hp=7c467c56a3802aa2efd4b488919d197ea5b84529;hpb=7bd7f2804d84258a5cd1e76c610496f6beaa4cdf;p=git.git diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 7c467c56a..a33d157b9 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -9,30 +9,47 @@ git-format-patch - Prepare patches for e-mail submission SYNOPSIS -------- [verse] -'git-format-patch' [-n | -k] [-o | --stdout] [-s] [-c] - [--diff-options] [] +'git-format-patch' [-n | -k] [-o | --stdout] [--thread] + [--attach[=] | --inline[=]] + [-s | --signoff] [] [--start-number ] + [--in-reply-to=Message-Id] [--suffix=.] + [--ignore-if-in-upstream] + [--subject-prefix=Subject-Prefix] + [..] DESCRIPTION ----------- -Prepare each commit with its patch since head forked from - head, one file per patch formatted to resemble UNIX mailbox -format, for e-mail submission or use with gitlink:git-am[1]. + +Prepare each commit between and with its patch in +one file per commit, formatted to resemble UNIX mailbox format. +If .. is not specified, the head of the current working +tree is implied. For a more complete list of ways to spell + and , see "SPECIFYING REVISIONS" section in +gitlink:git-rev-parse[1]. + +The output of this command is convenient for e-mail submission or +for use with gitlink:git-am[1]. Each output file is numbered sequentially from 1, and uses the -first line of the commit message (massaged for pathname safety) -as the filename. +first line of the commit message (massaged for pathname safety) as +the filename. The names of the output files are printed to standard +output, unless the --stdout option is specified. -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. +If -o is specified, output files are created in . Otherwise +they are created in the current working directory. -When -n is specified, instead of "[PATCH] Subject", the first -line is formatted as "[PATCH N/M] Subject", unless you have only -one patch. +If -n is specified, instead of "[PATCH] Subject", the first line +is formatted as "[PATCH n/m] Subject". +If given --thread, git-format-patch will generate In-Reply-To and +References headers to make the second and subsequent patch mails appear +as replies to the first mail; this also generates a Message-Id header to +reference. OPTIONS ------- +include::diff-options.txt[] + -o|--output-directory :: Use to store the resulting files, instead of the current working directory. @@ -40,6 +57,9 @@ OPTIONS -n|--numbered:: Name output in '[PATCH n/m]' format. +--start-number :: + Start numbering the patches at instead of 1. + -k|--keep-subject:: Do not strip/add '[PATCH]' from the first line of the commit log message. @@ -48,17 +68,64 @@ OPTIONS 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. - --stdout:: - This flag generates the mbox formatted output to the - standard output, instead of saving them into a file per - patch and implies --mbox. + Print all commits to the standard output in mbox format, + instead of creating a file for each one. + +--attach[=]:: + Create multipart/mixed attachment, the first part of + which is the commit message and the patch itself in the + second part, with "Content-Disposition: attachment". + +--inline[=]:: + Create multipart/mixed attachment, the first part of + which is the commit message and the patch itself in the + second part, with "Content-Disposition: inline". + +--thread:: + Add In-Reply-To and References headers to make the second and + subsequent mails appear as replies to the first. Also generates + the Message-Id header to reference. + +--in-reply-to=Message-Id:: + Make the first mail (or all the mails with --no-thread) appear as a + reply to the given Message-Id, which avoids breaking threads to + provide a new patch series. + +--ignore-if-in-upstream:: + Do not include a patch that matches a commit in + ... This will examine all patches reachable + from but not from and compare them with the + patches being generated, and any patch that matches is + ignored. + +--subject-prefix=:: + Instead of the standard '[PATCH]' prefix in the subject + line, instead use '[]'. This + allows for useful naming of a patch series, and can be + combined with the --numbered option. + +--suffix=.:: + Instead of using `.patch` as the suffix for generated + filenames, use specifed suffix. A common alternative is + `--suffix=.txt`. ++ +Note that you would need to include the leading dot `.` if you +want a filename like `0001-description-of-my-change.patch`, and +the first letter does not have to be a dot. Leaving it empty would +not add any suffix. + +CONFIGURATION +------------- +You can specify extra mail header lines to be added to each +message in the repository configuration. Also you can specify +the default suffix different from the built-in one: + +------------ +[format] + headers = "Organization: git-foo\n" + suffix = .txt +------------ EXAMPLES @@ -70,19 +137,22 @@ git-format-patch -k --stdout R1..R2 | git-am -3 -k:: 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. + Extract all commits which are in the current branch but + not in the origin branch. For each commit a separate file + is created in the current directory. 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. - + The same as the previous one. Additionally, it detects + and handles renames and complete rewrites intelligently to + produce a 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 patches, so use it only when you know + the recipient uses git to apply your patch. + +git-format-patch -3:: + Extract three topmost commits from the current branch + and format them as e-mailable patches. See Also --------