format-patch: teach format.notes config option
[git/git.git] / Documentation / config / format.txt
CommitLineData
e108551a
NTND
1format.attach::
2 Enable multipart/mixed attachments as the default for
3 'format-patch'. The value can also be a double quoted string
4 which will enable attachments as the default and set the
5 value as the boundary. See the --attach option in
6 linkgit:git-format-patch[1].
7
8format.from::
9 Provides the default value for the `--from` option to format-patch.
10 Accepts a boolean value, or a name and email address. If false,
11 format-patch defaults to `--no-from`, using commit authors directly in
12 the "From:" field of patch mails. If true, format-patch defaults to
13 `--from`, using your committer identity in the "From:" field of patch
14 mails and including a "From:" field in the body of the patch mail if
15 different. If set to a non-boolean value, format-patch uses that
16 value instead of your committer identity. Defaults to false.
17
18format.numbered::
19 A boolean which can enable or disable sequence numbers in patch
20 subjects. It defaults to "auto" which enables it only if there
21 is more than one patch. It can be enabled or disabled for all
22 messages by setting it to "true" or "false". See --numbered
23 option in linkgit:git-format-patch[1].
24
25format.headers::
26 Additional email headers to include in a patch to be submitted
27 by mail. See linkgit:git-format-patch[1].
28
29format.to::
30format.cc::
31 Additional recipients to include in a patch to be submitted
32 by mail. See the --to and --cc options in
33 linkgit:git-format-patch[1].
34
35format.subjectPrefix::
36 The default for format-patch is to output files with the '[PATCH]'
37 subject prefix. Use this variable to change that prefix.
38
39format.signature::
40 The default for format-patch is to output a signature containing
41 the Git version number. Use this variable to change that default.
42 Set this variable to the empty string ("") to suppress
43 signature generation.
44
45format.signatureFile::
46 Works just like format.signature except the contents of the
47 file specified by this variable will be used as the signature.
48
49format.suffix::
50 The default for format-patch is to output files with the suffix
51 `.patch`. Use this variable to change that suffix (make sure to
52 include the dot if you want it).
53
54format.pretty::
55 The default pretty format for log/show/whatchanged command,
56 See linkgit:git-log[1], linkgit:git-show[1],
57 linkgit:git-whatchanged[1].
58
59format.thread::
60 The default threading style for 'git format-patch'. Can be
61 a boolean value, or `shallow` or `deep`. `shallow` threading
62 makes every mail a reply to the head of the series,
63 where the head is chosen from the cover letter, the
64 `--in-reply-to`, and the first patch mail, in this order.
65 `deep` threading makes every mail a reply to the previous one.
66 A true boolean value is the same as `shallow`, and a false
67 value disables threading.
68
69format.signOff::
70 A boolean value which lets you enable the `-s/--signoff` option of
71 format-patch by default. *Note:* Adding the Signed-off-by: line to a
72 patch should be a conscious act and means that you certify you have
73 the rights to submit this work under the same open source license.
74 Please see the 'SubmittingPatches' document for further discussion.
75
76format.coverLetter::
77 A boolean that controls whether to generate a cover-letter when
78 format-patch is invoked, but in addition can be set to "auto", to
79 generate a cover-letter only when there's more than one patch.
80
81format.outputDirectory::
82 Set a custom directory to store the resulting files instead of the
83 current working directory.
84
85format.useAutoBase::
86 A boolean value which lets you enable the `--base=auto` option of
87 format-patch by default.
13cdf780
DL
88
89format.notes::
90 Provides the default value for the `--notes` option to
91 format-patch. Accepts a boolean value, or a ref which specifies
92 where to get notes. If false, format-patch defaults to
93 `--no-notes`. If true, format-patch defaults to `--notes`. If
94 set to a non-boolean value, format-patch defaults to
95 `--notes=<ref>`, where `ref` is the non-boolean value. Defaults
96 to false.
97+
98If one wishes to use the ref `ref/notes/true`, please use that literal
99instead.
100+
101This configuration can be specified multiple times in order to allow
102multiple notes refs to be included.