Doc: add more detail for git-format-patch
In git-format-patch.txt, we were missing some key user information. First of all, document the special value of `--base=auto`. Next, while we're at it, surround option arguments with <> and change existing names such as "Message-Id" to "message id", which conforms with how existing documentation is written. Finally, document the `format.outputDirectory` config and change `format.coverletter` to use camel case. Signed-off-by: Denton Liu <liu.denton@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Denton Liu committed
Aug 27, 2019 at 00:05 UTC
c1a6f21cd4c18a8118dd90c858f76e386648310f
1 file changed
+13
-10
Documentation/git-format-patch.txt
+13
-10
@@ -17,9 +17,9 @@ SYNOPSIS
17
[--signature-file=<file>]
18
[-n | --numbered | -N | --no-numbered]
19
[--start-number <n>] [--numbered-files]
20
- [--in-reply-to=Message-Id] [--suffix=.<sfx>]
20
+ [--in-reply-to=<message id>] [--suffix=.<sfx>]
21
[--ignore-if-in-upstream]
22
- [--rfc] [--subject-prefix=Subject-Prefix]
22
+ [--rfc] [--subject-prefix=<subject prefix>]
23
[(--reroll-count|-v) <n>]
24
[--to=<email>] [--cc=<email>]
25
[--[no-]cover-letter] [--quiet]
@@ -159,9 +159,9 @@ Beware that the default for 'git send-email' is to thread emails
159
itself. If you want `git format-patch` to take care of threading, you
160
will want to ensure that threading is disabled for `git send-email`.
161
162
---in-reply-to=Message-Id::
162
+--in-reply-to=<message id>::
163
Make the first mail (or all the mails with `--no-thread`) appear as a
164
- reply to the given Message-Id, which avoids breaking threads to
164
+ reply to the given <message id>, which avoids breaking threads to
165
provide a new patch series.
166
167
--ignore-if-in-upstream::
@@ -171,9 +171,9 @@ will want to ensure that threading is disabled for `git send-email`.
171
patches being generated, and any patch that matches is
172
ignored.
173
174
---subject-prefix=<Subject-Prefix>::
174
+--subject-prefix=<subject prefix>::
175
Instead of the standard '[PATCH]' prefix in the subject
176
- line, instead use '[<Subject-Prefix>]'. This
176
+ line, instead use '[<subject prefix>]'. This
177
allows for useful naming of a patch series, and can be
178
combined with the `--numbered` option.
179
@@ -314,7 +314,8 @@ you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.
314
--base=<commit>::
315
Record the base tree information to identify the state the
316
patch series applies to. See the BASE TREE INFORMATION section
317
- below for details.
317
+ below for details. If <commit> is "auto", a base commit is
318
+ automatically chosen.
319
320
--root::
321
Treat the revision argument as a <revision range>, even if it
@@ -330,8 +331,9 @@ CONFIGURATION
331
-------------
332
You can specify extra mail header lines to be added to each message,
333
defaults for the subject prefix and file suffix, number patches when
333
-outputting more than one patch, add "To" or "Cc:" headers, configure
334
-attachments, and sign off patches with configuration variables.
334
+outputting more than one patch, add "To:" or "Cc:" headers, configure
335
+attachments, change the patch output directory, and sign off patches
336
+with configuration variables.
337
338
------------
339
[format]
@@ -343,7 +345,8 @@ attachments, and sign off patches with configuration variables.
345
cc = <email>
346
attach [ = mime-boundary-string ]
347
signOff = true
346
- coverletter = auto
348
+ outputDirectory = <directory>
349
+ coverLetter = auto
350
------------
351
352