Git fork
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]. To countermand an earlier
7 value, set it to an empty string.
8
9format.from::
10 Provides the default value for the `--from` option to format-patch.
11 Accepts a boolean value, or a name and email address. If false,
12 format-patch defaults to `--no-from`, using commit authors directly in
13 the "From:" field of patch mails. If true, format-patch defaults to
14 `--from`, using your committer identity in the "From:" field of patch
15 mails and including a "From:" field in the body of the patch mail if
16 different. If set to a non-boolean value, format-patch uses that
17 value instead of your committer identity. Defaults to false.
18
19format.forceInBodyFrom::
20 Provides the default value for the `--[no-]force-in-body-from`
21 option to format-patch. Defaults to false.
22
23format.numbered::
24 A boolean which can enable or disable sequence numbers in patch
25 subjects. It defaults to "auto" which enables it only if there
26 is more than one patch. It can be enabled or disabled for all
27 messages by setting it to "true" or "false". See --numbered
28 option in linkgit:git-format-patch[1].
29
30format.headers::
31 Additional email headers to include in a patch to be submitted
32 by mail. See linkgit:git-format-patch[1].
33
34format.to::
35format.cc::
36 Additional recipients to include in a patch to be submitted
37 by mail. See the --to and --cc options in
38 linkgit:git-format-patch[1].
39
40format.subjectPrefix::
41 The default for format-patch is to output files with the '[PATCH]'
42 subject prefix. Use this variable to change that prefix.
43
44format.coverFromDescription::
45 The default mode for format-patch to determine which parts of
46 the cover letter will be populated using the branch's
47 description. See the `--cover-from-description` option in
48 linkgit:git-format-patch[1].
49
50format.signature::
51 The default for format-patch is to output a signature containing
52 the Git version number. Use this variable to change that default.
53 Set this variable to the empty string ("") to suppress
54 signature generation.
55
56format.signatureFile::
57 Works just like format.signature except the contents of the
58 file specified by this variable will be used as the signature.
59
60format.suffix::
61 The default for format-patch is to output files with the suffix
62 `.patch`. Use this variable to change that suffix (make sure to
63 include the dot if you want it).
64
65format.encodeEmailHeaders::
66 Encode email headers that have non-ASCII characters with
67 "Q-encoding" (described in RFC 2047) for email transmission.
68 Defaults to true.
69
70format.pretty::
71ifndef::with-breaking-changes[]
72 The default pretty format for log/show/whatchanged command.
73 See linkgit:git-log[1], linkgit:git-show[1],
74 linkgit:git-whatchanged[1].
75endif::with-breaking-changes[]
76ifdef::with-breaking-changes[]
77 The default pretty format for log/show command.
78 See linkgit:git-log[1], linkgit:git-show[1].
79endif::with-breaking-changes[]
80
81format.thread::
82 The default threading style for 'git format-patch'. Can be
83 a boolean value, or `shallow` or `deep`. `shallow` threading
84 makes every mail a reply to the head of the series,
85 where the head is chosen from the cover letter, the
86 `--in-reply-to`, and the first patch mail, in this order.
87 `deep` threading makes every mail a reply to the previous one.
88 A true boolean value is the same as `shallow`, and a false
89 value disables threading.
90
91format.signOff::
92 A boolean value which lets you enable the `-s/--signoff` option of
93 format-patch by default. *Note:* Adding the `Signed-off-by` trailer to a
94 patch should be a conscious act and means that you certify you have
95 the rights to submit this work under the same open source license.
96 Please see the 'SubmittingPatches' document for further discussion.
97
98format.coverLetter::
99 A boolean that controls whether to generate a cover-letter when
100 format-patch is invoked, but in addition can be set to "auto", to
101 generate a cover-letter only when there's more than one patch.
102 Default is false.
103
104format.outputDirectory::
105 Set a custom directory to store the resulting files instead of the
106 current working directory. All directory components will be created.
107
108format.filenameMaxLength::
109 The maximum length of the output filenames generated by the
110 `format-patch` command; defaults to 64. Can be overridden
111 by the `--filename-max-length=<n>` command line option.
112
113format.useAutoBase::
114 A boolean value which lets you enable the `--base=auto` option of
115 format-patch by default. Can also be set to "whenAble" to allow
116 enabling `--base=auto` if a suitable base is available, but to skip
117 adding base info otherwise without the format dying.
118
119format.notes::
120 Provides the default value for the `--notes` option to
121 format-patch. Accepts a boolean value, or a ref which specifies
122 where to get notes. If false, format-patch defaults to
123 `--no-notes`. If true, format-patch defaults to `--notes`. If
124 set to a non-boolean value, format-patch defaults to
125 `--notes=<ref>`, where `ref` is the non-boolean value. Defaults
126 to false.
127+
128If one wishes to use the ref `refs/notes/true`, please use that literal
129instead.
130+
131This configuration can be specified multiple times in order to allow
132multiple notes refs to be included. In that case, it will behave
133similarly to multiple `--[no-]notes[=]` options passed in. That is, a
134value of `true` will show the default notes, a value of `<ref>` will
135also show notes from that notes ref and a value of `false` will negate
136previous configurations and not show notes.
137+
138For example,
139+
140------------
141[format]
142 notes = true
143 notes = foo
144 notes = false
145 notes = bar
146------------
147+
148will only show notes from `refs/notes/bar`.
149
150format.mboxrd::
151 A boolean value which enables the robust "mboxrd" format when
152 `--stdout` is in use to escape "^>+From " lines.
153
154format.noprefix::
155 If set, do not show any source or destination prefix in patches.
156 This is equivalent to the `diff.noprefix` option used by `git
157 diff` (but which is not respected by `format-patch`). Note that
158 by setting this, the receiver of any patches you generate will
159 have to apply them using the `-p0` option.