Skip to content

Commit 3ba371f

Browse files
committed
Merge branch 'nd/config-split'
Split Documentation/config.txt for easier maintenance. * nd/config-split: config.txt: move submodule part out to a separate file config.txt: move sequence.editor out of "core" part config.txt: move sendemail part out to a separate file config.txt: move receive part out to a separate file config.txt: move push part out to a separate file config.txt: move pull part out to a separate file config.txt: move gui part out to a separate file config.txt: move gitcvs part out to a separate file config.txt: move format part out to a separate file config.txt: move fetch part out to a separate file config.txt: follow camelCase naming
2 parents 2efbb7f + 6014363 commit 3ba371f

10 files changed

+711
-702
lines changed

Documentation/config.txt

Lines changed: 18 additions & 702 deletions
Large diffs are not rendered by default.

Documentation/fetch-config.txt

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
fetch.recurseSubmodules::
2+
This option can be either set to a boolean value or to 'on-demand'.
3+
Setting it to a boolean changes the behavior of fetch and pull to
4+
unconditionally recurse into submodules when set to true or to not
5+
recurse at all when set to false. When set to 'on-demand' (the default
6+
value), fetch and pull will only recurse into a populated submodule
7+
when its superproject retrieves a commit that updates the submodule's
8+
reference.
9+
10+
fetch.fsckObjects::
11+
If it is set to true, git-fetch-pack will check all fetched
12+
objects. See `transfer.fsckObjects` for what's
13+
checked. Defaults to false. If not set, the value of
14+
`transfer.fsckObjects` is used instead.
15+
16+
fetch.fsck.<msg-id>::
17+
Acts like `fsck.<msg-id>`, but is used by
18+
linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
19+
the `fsck.<msg-id>` documentation for details.
20+
21+
fetch.fsck.skipList::
22+
Acts like `fsck.skipList`, but is used by
23+
linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
24+
the `fsck.skipList` documentation for details.
25+
26+
fetch.unpackLimit::
27+
If the number of objects fetched over the Git native
28+
transfer is below this
29+
limit, then the objects will be unpacked into loose object
30+
files. However if the number of received objects equals or
31+
exceeds this limit then the received pack will be stored as
32+
a pack, after adding any missing delta bases. Storing the
33+
pack from a push can make the push operation complete faster,
34+
especially on slow filesystems. If not set, the value of
35+
`transfer.unpackLimit` is used instead.
36+
37+
fetch.prune::
38+
If true, fetch will automatically behave as if the `--prune`
39+
option was given on the command line. See also `remote.<name>.prune`
40+
and the PRUNING section of linkgit:git-fetch[1].
41+
42+
fetch.pruneTags::
43+
If true, fetch will automatically behave as if the
44+
`refs/tags/*:refs/tags/*` refspec was provided when pruning,
45+
if not set already. This allows for setting both this option
46+
and `fetch.prune` to maintain a 1=1 mapping to upstream
47+
refs. See also `remote.<name>.pruneTags` and the PRUNING
48+
section of linkgit:git-fetch[1].
49+
50+
fetch.output::
51+
Control how ref update status is printed. Valid values are
52+
`full` and `compact`. Default value is `full`. See section
53+
OUTPUT in linkgit:git-fetch[1] for detail.
54+
55+
fetch.negotiationAlgorithm::
56+
Control how information about the commits in the local repository is
57+
sent when negotiating the contents of the packfile to be sent by the
58+
server. Set to "skipping" to use an algorithm that skips commits in an
59+
effort to converge faster, but may result in a larger-than-necessary
60+
packfile; The default is "default" which instructs Git to use the default algorithm
61+
that never skips commits (unless the server has acknowledged it or one
62+
of its descendants).
63+
Unknown values will cause 'git fetch' to error out.
64+
+
65+
See also the `--negotiation-tip` option for linkgit:git-fetch[1].

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.

Documentation/gitcvs-config.txt

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
gitcvs.commitMsgAnnotation::
2+
Append this string to each commit message. Set to empty string
3+
to disable this feature. Defaults to "via git-CVS emulator".
4+
5+
gitcvs.enabled::
6+
Whether the CVS server interface is enabled for this repository.
7+
See linkgit:git-cvsserver[1].
8+
9+
gitcvs.logFile::
10+
Path to a log file where the CVS server interface well... logs
11+
various stuff. See linkgit:git-cvsserver[1].
12+
13+
gitcvs.usecrlfattr::
14+
If true, the server will look up the end-of-line conversion
15+
attributes for files to determine the `-k` modes to use. If
16+
the attributes force Git to treat a file as text,
17+
the `-k` mode will be left blank so CVS clients will
18+
treat it as text. If they suppress text conversion, the file
19+
will be set with '-kb' mode, which suppresses any newline munging
20+
the client might otherwise do. If the attributes do not allow
21+
the file type to be determined, then `gitcvs.allBinary` is
22+
used. See linkgit:gitattributes[5].
23+
24+
gitcvs.allBinary::
25+
This is used if `gitcvs.usecrlfattr` does not resolve
26+
the correct '-kb' mode to use. If true, all
27+
unresolved files are sent to the client in
28+
mode '-kb'. This causes the client to treat them
29+
as binary files, which suppresses any newline munging it
30+
otherwise might do. Alternatively, if it is set to "guess",
31+
then the contents of the file are examined to decide if
32+
it is binary, similar to `core.autocrlf`.
33+
34+
gitcvs.dbName::
35+
Database used by git-cvsserver to cache revision information
36+
derived from the Git repository. The exact meaning depends on the
37+
used database driver, for SQLite (which is the default driver) this
38+
is a filename. Supports variable substitution (see
39+
linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
40+
Default: '%Ggitcvs.%m.sqlite'
41+
42+
gitcvs.dbDriver::
43+
Used Perl DBI driver. You can specify any available driver
44+
for this here, but it might not work. git-cvsserver is tested
45+
with 'DBD::SQLite', reported to work with 'DBD::Pg', and
46+
reported *not* to work with 'DBD::mysql'. Experimental feature.
47+
May not contain double colons (`:`). Default: 'SQLite'.
48+
See linkgit:git-cvsserver[1].
49+
50+
gitcvs.dbUser, gitcvs.dbPass::
51+
Database user and password. Only useful if setting `gitcvs.dbDriver`,
52+
since SQLite has no concept of database users and/or passwords.
53+
'gitcvs.dbUser' supports variable substitution (see
54+
linkgit:git-cvsserver[1] for details).
55+
56+
gitcvs.dbTableNamePrefix::
57+
Database table name prefix. Prepended to the names of any
58+
database tables used, allowing a single database to be used
59+
for several repositories. Supports variable substitution (see
60+
linkgit:git-cvsserver[1] for details). Any non-alphabetic
61+
characters will be replaced with underscores.
62+
63+
All gitcvs variables except for `gitcvs.usecrlfattr` and
64+
`gitcvs.allBinary` can also be specified as
65+
'gitcvs.<access_method>.<varname>' (where 'access_method'
66+
is one of "ext" and "pserver") to make them apply only for the given
67+
access method.

Documentation/gui-config.txt

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
gui.commitMsgWidth::
2+
Defines how wide the commit message window is in the
3+
linkgit:git-gui[1]. "75" is the default.
4+
5+
gui.diffContext::
6+
Specifies how many context lines should be used in calls to diff
7+
made by the linkgit:git-gui[1]. The default is "5".
8+
9+
gui.displayUntracked::
10+
Determines if linkgit:git-gui[1] shows untracked files
11+
in the file list. The default is "true".
12+
13+
gui.encoding::
14+
Specifies the default encoding to use for displaying of
15+
file contents in linkgit:git-gui[1] and linkgit:gitk[1].
16+
It can be overridden by setting the 'encoding' attribute
17+
for relevant files (see linkgit:gitattributes[5]).
18+
If this option is not set, the tools default to the
19+
locale encoding.
20+
21+
gui.matchTrackingBranch::
22+
Determines if new branches created with linkgit:git-gui[1] should
23+
default to tracking remote branches with matching names or
24+
not. Default: "false".
25+
26+
gui.newBranchTemplate::
27+
Is used as suggested name when creating new branches using the
28+
linkgit:git-gui[1].
29+
30+
gui.pruneDuringFetch::
31+
"true" if linkgit:git-gui[1] should prune remote-tracking branches when
32+
performing a fetch. The default value is "false".
33+
34+
gui.trustmtime::
35+
Determines if linkgit:git-gui[1] should trust the file modification
36+
timestamp or not. By default the timestamps are not trusted.
37+
38+
gui.spellingDictionary::
39+
Specifies the dictionary used for spell checking commit messages in
40+
the linkgit:git-gui[1]. When set to "none" spell checking is turned
41+
off.
42+
43+
gui.fastCopyBlame::
44+
If true, 'git gui blame' uses `-C` instead of `-C -C` for original
45+
location detection. It makes blame significantly faster on huge
46+
repositories at the expense of less thorough copy detection.
47+
48+
gui.copyBlameThreshold::
49+
Specifies the threshold to use in 'git gui blame' original location
50+
detection, measured in alphanumeric characters. See the
51+
linkgit:git-blame[1] manual for more information on copy detection.
52+
53+
gui.blamehistoryctx::
54+
Specifies the radius of history context in days to show in
55+
linkgit:gitk[1] for the selected commit, when the `Show History
56+
Context` menu item is invoked from 'git gui blame'. If this
57+
variable is set to zero, the whole history is shown.

Documentation/pull-config.txt

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
pull.ff::
2+
By default, Git does not create an extra merge commit when merging
3+
a commit that is a descendant of the current commit. Instead, the
4+
tip of the current branch is fast-forwarded. When set to `false`,
5+
this variable tells Git to create an extra merge commit in such
6+
a case (equivalent to giving the `--no-ff` option from the command
7+
line). When set to `only`, only such fast-forward merges are
8+
allowed (equivalent to giving the `--ff-only` option from the
9+
command line). This setting overrides `merge.ff` when pulling.
10+
11+
pull.rebase::
12+
When true, rebase branches on top of the fetched branch, instead
13+
of merging the default branch from the default remote when "git
14+
pull" is run. See "branch.<name>.rebase" for setting this on a
15+
per-branch basis.
16+
+
17+
When `merges`, pass the `--rebase-merges` option to 'git rebase'
18+
so that the local merge commits are included in the rebase (see
19+
linkgit:git-rebase[1] for details).
20+
+
21+
When preserve, also pass `--preserve-merges` along to 'git rebase'
22+
so that locally committed merge commits will not be flattened
23+
by running 'git pull'.
24+
+
25+
When the value is `interactive`, the rebase is run in interactive mode.
26+
+
27+
*NOTE*: this is a possibly dangerous operation; do *not* use
28+
it unless you understand the implications (see linkgit:git-rebase[1]
29+
for details).
30+
31+
pull.octopus::
32+
The default merge strategy to use when pulling multiple branches
33+
at once.
34+
35+
pull.twohead::
36+
The default merge strategy to use when pulling a single branch.

0 commit comments

Comments
 (0)