From: Junio C Hamano Date: Mon, 24 Apr 2017 05:07:55 +0000 (-0700) Subject: Merge branch 'xy/format-patch-base' X-Git-Tag: v2.13.0-rc1~22 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/2cef68f8e5043729952e14f0aa4c595cafbbfc2a?hp=-c Merge branch 'xy/format-patch-base' Doc cleanup. * xy/format-patch-base: doc: trivial typo in git-format-patch.txt --- 2cef68f8e5043729952e14f0aa4c595cafbbfc2a diff --combined Documentation/git-format-patch.txt index f7a069bb92,9c5f8327cd..c890328b02 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@@ -19,8 -19,7 +19,8 @@@ SYNOPSI [--start-number ] [--numbered-files] [--in-reply-to=Message-Id] [--suffix=.] [--ignore-if-in-upstream] - [--subject-prefix=Subject-Prefix] [(--reroll-count|-v) ] + [--rfc] [--subject-prefix=Subject-Prefix] + [(--reroll-count|-v) ] [--to=] [--cc=] [--[no-]cover-letter] [--quiet] [--notes[=]] [] @@@ -59,7 -58,7 +59,7 @@@ output, unless the `--stdout` option i If `-o` is specified, output files are created in . Otherwise they are created in the current working directory. The default path -can be set with the 'format.outputDirectory' configuration option. +can be set with the `format.outputDirectory` configuration option. The `-o` option takes precedence over `format.outputDirectory`. To store patches in the current working directory even when `format.outputDirectory` points elsewhere, use `-o .`. @@@ -147,9 -146,9 +147,9 @@@ series, where the head is chosen from t `--in-reply-to`, and the first patch mail, in this order. 'deep' threading makes every mail a reply to the previous one. + -The default is `--no-thread`, unless the 'format.thread' configuration +The default is `--no-thread`, unless the `format.thread` configuration is set. If `--thread` is specified without a style, it defaults to the -style specified by 'format.thread' if any, or else `shallow`. +style specified by `format.thread` if any, or else `shallow`. + Beware that the default for 'git send-email' is to thread emails itself. If you want `git format-patch` to take care of threading, you @@@ -173,11 -172,6 +173,11 @@@ will want to ensure that threading is d allows for useful naming of a patch series, and can be combined with the `--numbered` option. +--rfc:: + Alias for `--subject-prefix="RFC PATCH"`. RFC means "Request For + Comments"; use this when sending an experimental patch for + discussion rather than application. + -v :: --reroll-count=:: Mark the series as the -th iteration of the topic. The @@@ -239,7 -233,7 +239,7 @@@ keeping them as Git notes allows them t of the patch series (but see the discussion of the `notes.rewrite` configuration options in linkgit:git-notes[1] to use this workflow). ---[no]-signature=:: +--[no-]signature=:: Add a signature to each message produced. Per RFC 3676 the signature is separated from the body by a line with '-- ' on it. If the signature option is omitted the signature defaults to the Git version @@@ -557,7 -551,7 +557,7 @@@ series A, B, C, the history would be li ................................................ With `git format-patch --base=P -3 C` (or variants thereof, e.g. with - `--cover-letter` of using `Z..C` instead of `-3 C` to specify the + `--cover-letter` or using `Z..C` instead of `-3 C` to specify the range), the base tree information block is shown at the end of the first message the command outputs (either the first patch, or the cover letter), like this: