Skip to content

Commit e108551

Browse files
pcloudsgitster
authored andcommitted
config.txt: move format part out to a separate file
Signed-off-by: Nguyễn Thái Ngọc Duy <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent ca0e61c commit e108551

File tree

2 files changed

+88
-87
lines changed

2 files changed

+88
-87
lines changed

Documentation/config.txt

Lines changed: 1 addition & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1509,93 +1509,7 @@ fastimport.unpackLimit::
15091509

15101510
include::fetch-config.txt[]
15111511

1512-
format.attach::
1513-
Enable multipart/mixed attachments as the default for
1514-
'format-patch'. The value can also be a double quoted string
1515-
which will enable attachments as the default and set the
1516-
value as the boundary. See the --attach option in
1517-
linkgit:git-format-patch[1].
1518-
1519-
format.from::
1520-
Provides the default value for the `--from` option to format-patch.
1521-
Accepts a boolean value, or a name and email address. If false,
1522-
format-patch defaults to `--no-from`, using commit authors directly in
1523-
the "From:" field of patch mails. If true, format-patch defaults to
1524-
`--from`, using your committer identity in the "From:" field of patch
1525-
mails and including a "From:" field in the body of the patch mail if
1526-
different. If set to a non-boolean value, format-patch uses that
1527-
value instead of your committer identity. Defaults to false.
1528-
1529-
format.numbered::
1530-
A boolean which can enable or disable sequence numbers in patch
1531-
subjects. It defaults to "auto" which enables it only if there
1532-
is more than one patch. It can be enabled or disabled for all
1533-
messages by setting it to "true" or "false". See --numbered
1534-
option in linkgit:git-format-patch[1].
1535-
1536-
format.headers::
1537-
Additional email headers to include in a patch to be submitted
1538-
by mail. See linkgit:git-format-patch[1].
1539-
1540-
format.to::
1541-
format.cc::
1542-
Additional recipients to include in a patch to be submitted
1543-
by mail. See the --to and --cc options in
1544-
linkgit:git-format-patch[1].
1545-
1546-
format.subjectPrefix::
1547-
The default for format-patch is to output files with the '[PATCH]'
1548-
subject prefix. Use this variable to change that prefix.
1549-
1550-
format.signature::
1551-
The default for format-patch is to output a signature containing
1552-
the Git version number. Use this variable to change that default.
1553-
Set this variable to the empty string ("") to suppress
1554-
signature generation.
1555-
1556-
format.signatureFile::
1557-
Works just like format.signature except the contents of the
1558-
file specified by this variable will be used as the signature.
1559-
1560-
format.suffix::
1561-
The default for format-patch is to output files with the suffix
1562-
`.patch`. Use this variable to change that suffix (make sure to
1563-
include the dot if you want it).
1564-
1565-
format.pretty::
1566-
The default pretty format for log/show/whatchanged command,
1567-
See linkgit:git-log[1], linkgit:git-show[1],
1568-
linkgit:git-whatchanged[1].
1569-
1570-
format.thread::
1571-
The default threading style for 'git format-patch'. Can be
1572-
a boolean value, or `shallow` or `deep`. `shallow` threading
1573-
makes every mail a reply to the head of the series,
1574-
where the head is chosen from the cover letter, the
1575-
`--in-reply-to`, and the first patch mail, in this order.
1576-
`deep` threading makes every mail a reply to the previous one.
1577-
A true boolean value is the same as `shallow`, and a false
1578-
value disables threading.
1579-
1580-
format.signOff::
1581-
A boolean value which lets you enable the `-s/--signoff` option of
1582-
format-patch by default. *Note:* Adding the Signed-off-by: line to a
1583-
patch should be a conscious act and means that you certify you have
1584-
the rights to submit this work under the same open source license.
1585-
Please see the 'SubmittingPatches' document for further discussion.
1586-
1587-
format.coverLetter::
1588-
A boolean that controls whether to generate a cover-letter when
1589-
format-patch is invoked, but in addition can be set to "auto", to
1590-
generate a cover-letter only when there's more than one patch.
1591-
1592-
format.outputDirectory::
1593-
Set a custom directory to store the resulting files instead of the
1594-
current working directory.
1595-
1596-
format.useAutoBase::
1597-
A boolean value which lets you enable the `--base=auto` option of
1598-
format-patch by default.
1512+
include::format-config.txt[]
15991513

16001514
filter.<driver>.clean::
16011515
The command which is used to convert the content of a worktree

Documentation/format-config.txt

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
format.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+
8+
format.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+
18+
format.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+
25+
format.headers::
26+
Additional email headers to include in a patch to be submitted
27+
by mail. See linkgit:git-format-patch[1].
28+
29+
format.to::
30+
format.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+
35+
format.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+
39+
format.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+
45+
format.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+
49+
format.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+
54+
format.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+
59+
format.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+
69+
format.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+
76+
format.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+
81+
format.outputDirectory::
82+
Set a custom directory to store the resulting files instead of the
83+
current working directory.
84+
85+
format.useAutoBase::
86+
A boolean value which lets you enable the `--base=auto` option of
87+
format-patch by default.

0 commit comments

Comments
 (0)