X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-format-patch.txt;h=adb4ea7b1b6c70fb6fc2486487ef34ed280ec015;hb=0f7a8f2dba5aeb8ce8ab4a710a1d1310705f7f08;hp=4dafa39a9211d9d35498f4c88418713b1aa33284;hpb=e4403d8bd3ccb6bcc3b6569012944d932334f5c4;p=git.git diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 4dafa39a9..adb4ea7b1 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -9,7 +9,7 @@ git-format-patch - Prepare patches for e-mail submission SYNOPSIS -------- [verse] -'git-format-patch' [-k] [-o | --stdout] [--thread] +'git format-patch' [-k] [-o | --stdout] [--thread] [--attach[=] | --inline[=]] [-s | --signoff] [] [-n | --numbered | -N | --no-numbered] @@ -27,7 +27,7 @@ DESCRIPTION Prepare each commit with its patch in one file per commit, formatted to resemble UNIX mailbox format. The output of this command is convenient for e-mail submission or -for use with linkgit:git-am[1]. +for use with 'git-am'. There are two ways to specify which commits to operate on. @@ -61,7 +61,7 @@ they are created in the current working directory. 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 +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. @@ -147,9 +147,9 @@ include::diff-options.txt[] to any configured headers, and may be used multiple times. --cover-letter:: - Generate a cover letter template. You still have to fill in - a description, but the shortlog and the diffstat will be - generated for you. + In addition to the patches, generate a cover letter file + containing the shortlog and the overall diffstat. You can + fill in a description in the file before sending it out. --suffix=.:: Instead of using `.patch` as the suffix for generated @@ -175,10 +175,10 @@ and file suffix, and number patches when outputting more than one. ------------ [format] - headers = "Organization: git-foo\n" - subjectprefix = CHANGE - suffix = .txt - numbered = auto + headers = "Organization: git-foo\n" + subjectprefix = CHANGE + suffix = .txt + numbered = auto cc = ------------ @@ -187,10 +187,10 @@ EXAMPLES -------- * Extract commits between revisions R1 and R2, and apply them on top of -the current branch using `git-am` to cherry-pick them: +the current branch using 'git-am' to cherry-pick them: + ------------ -$ git format-patch -k --stdout R1..R2 | git-am -3 -k +$ git format-patch -k --stdout R1..R2 | git am -3 -k ------------ * Extract all commits which are in the current branch but not in the @@ -206,7 +206,7 @@ For each commit a separate file is created in the current directory. project: + ------------ -$ git format-patch \--root origin +$ git format-patch --root origin ------------ * The same as the previous one: @@ -235,7 +235,7 @@ linkgit:git-am[1], linkgit:git-send-email[1] Author ------ -Written by Junio C Hamano +Written by Junio C Hamano Documentation --------------