4
4
The git configuration file contains a number of variables that affect
5
the git command's behavior. They can be used by both the git plumbing
5
the git command's behavior. `.git/config` file for each repository
6
is used to store the information for that repository, and
7
`$HOME/.gitconfig` is used to store per user information to give
8
fallback values for `.git/config` file. The file `/etc/gitconfig`
9
can be used to store system-wide defaults.
11
They can be used by both the git plumbing
6
12
and the porcelains. The variables are divided into sections, where
7
13
in the fully qualified variable name the variable itself is the last
8
14
dot-separated segment and the section name is everything before the last
9
15
dot. The variable names are case-insensitive and only alphanumeric
10
16
characters are allowed. Some variables may appear multiple times.
12
21
The syntax is fairly flexible and permissive; whitespaces are mostly
13
ignored. The '#' and ';' characters begin comments to the end of line,
14
blank lines are ignored, lines containing strings enclosed in square
15
brackets start sections and all the other lines are recognized
16
as setting variables, in the form 'name = value'. If there is no equal
17
sign on the line, the entire line is taken as 'name' and the variable
18
is recognized as boolean "true". String values may be entirely or partially
19
enclosed in double quotes; some variables may require special value format.
22
ignored. The '#' and ';' characters begin comments to the end of line,
23
blank lines are ignored.
25
The file consists of sections and variables. A section begins with
26
the name of the section in square brackets and continues until the next
27
section begins. Section names are not case sensitive. Only alphanumeric
28
characters, '`-`' and '`.`' are allowed in section names. Each variable
29
must belong to some section, which means that there must be section
30
header before first setting of a variable.
32
Sections can be further divided into subsections. To begin a subsection
33
put its name in double quotes, separated by space from the section name,
34
in the section header, like in example below:
37
[section "subsection"]
41
Subsection names can contain any characters except newline (doublequote
42
'`"`' and backslash have to be escaped as '`\"`' and '`\\`',
43
respectively) and are case sensitive. Section header cannot span multiple
44
lines. Variables may belong directly to a section or to a given subsection.
45
You can have `[section]` if you have `[section "subsection"]`, but you
48
There is also (case insensitive) alternative `[section.subsection]` syntax.
49
In this syntax subsection names follow the same restrictions as for section
52
All the other lines are recognized as setting variables, in the form
53
'name = value'. If there is no equal sign on the line, the entire line
54
is taken as 'name' and the variable is recognized as boolean "true".
55
The variable names are case-insensitive and only alphanumeric
56
characters and '`-`' are allowed. There can be more than one value
57
for a given variable; we say then that variable is multivalued.
59
Leading and trailing whitespace in a variable value is discarded.
60
Internal whitespace within a variable value is retained verbatim.
62
The values following the equals sign in variable assign are all either
63
a string, an integer, or a boolean. Boolean values may be given as yes/no,
64
0/1 or true/false. Case is not significant in boolean values, when
65
converting value to the canonical form using '--bool' type specifier;
66
`git-config` will ensure that the output is "true" or "false".
68
String values may be entirely or partially enclosed in double quotes.
69
You need to enclose variable value in double quotes if you want to
70
preserve leading or trailing whitespace, or if variable value contains
71
beginning of comment characters (if it contains '#' or ';').
72
Double quote '`"`' and backslash '`\`' characters in variable value must
73
be escaped: use '`\"`' for '`"`' and '`\\`' for '`\`'.
75
The following escape sequences (beside '`\"`' and '`\\`') are recognized:
76
'`\n`' for newline character (NL), '`\t`' for horizontal tabulation (HT, TAB)
77
and '`\b`' for backspace (BS). No other char escape sequence, nor octal
78
char sequences are valid.
80
Variable value ending in a '`\`' is continued on the next line in the
81
customary UNIX fashion.
83
Some variables may require special value format.
44
117
the working copy are ignored; useful on broken filesystems like FAT.
45
118
See gitlink:git-update-index[1]. True by default.
121
If true, makes git convert `CRLF` at the end of lines in text files to
122
`LF` when reading from the filesystem, and convert in reverse when
123
writing to the filesystem. The variable can be set to
124
'input', in which case the conversion happens only while
125
reading from the filesystem but files are written out with
126
`LF` at the end of lines. Currently, which paths to consider
127
"text" (i.e. be subjected to the autocrlf mechanism) is
128
decided purely based on the contents.
131
If false, symbolic links are checked out as small plain files that
132
contain the link text. gitlink:git-update-index[1] and
133
gitlink:git-add[1] will not change the recorded type to regular
134
file. Useful on filesystems like FAT that do not support
135
symbolic links. True by default.
48
138
A "proxy command" to execute (as 'command host port') instead
49
139
of establishing direct connection to the remote server when
107
212
core.legacyheaders::
108
A boolean which enables the legacy object header format in case
109
you want to interoperate with old clients accessing the object
110
database directly (where the "http://" and "rsync://" protocols
111
count as direct access).
214
changes the format of loose objects so that they are more
215
efficient to pack and to send out of the repository over git
216
native protocol, since v1.4.2. However, loose objects
217
written in the new format cannot be read by git older than
218
that version; people fetching from your repository using
219
older versions of git over dumb transports (e.g. http)
220
will also be affected.
222
To let git use the new loose object format, you have to
223
set core.legacyheaders to false.
225
core.packedGitWindowSize::
226
Number of bytes of a pack file to map into memory in a
227
single mapping operation. Larger window sizes may allow
228
your system to process a smaller number of large pack files
229
more quickly. Smaller window sizes will negatively affect
230
performance due to increased calls to the operating system's
231
memory manager, but may improve performance when accessing
232
a large number of large pack files.
234
Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
235
MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
236
be reasonable for all users/operating systems. You probably do
237
not need to adjust this value.
239
Common unit suffixes of 'k', 'm', or 'g' are supported.
241
core.packedGitLimit::
242
Maximum number of bytes to map simultaneously into memory
243
from pack files. If Git needs to access more than this many
244
bytes at once to complete an operation it will unmap existing
245
regions to reclaim virtual address space within the process.
247
Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
248
This should be reasonable for all users/operating systems, except on
249
the largest projects. You probably do not need to adjust this value.
251
Common unit suffixes of 'k', 'm', or 'g' are supported.
253
core.deltaBaseCacheLimit::
254
Maximum number of bytes to reserve for caching base objects
255
that multiple deltafied objects reference. By storing the
256
entire decompressed base objects in a cache Git is able
257
to avoid unpacking and decompressing frequently used base
258
objects multiple times.
260
Default is 16 MiB on all platforms. This should be reasonable
261
for all users/operating systems, except on the largest projects.
262
You probably do not need to adjust this value.
264
Common unit suffixes of 'k', 'm', or 'g' are supported.
114
267
Command aliases for the gitlink:git[1] command wrapper - e.g.
119
272
spaces, the usual shell quoting and escaping is supported.
120
273
quote pair and a backslash can be used to quote them.
275
If the alias expansion is prefixed with an exclamation point,
276
it will be treated as a shell command. For example, defining
277
"alias.new = !gitk --all --not ORIG_HEAD", the invocation
278
"git new" is equivalent to running the shell command
279
"gitk --all --not ORIG_HEAD".
122
281
apply.whitespace::
123
282
Tells `git-apply` how to handle whitespaces, in the same way
124
283
as the '--whitespace' option. See gitlink:git-apply[1].
126
285
branch.<name>.remote::
127
286
When in branch <name>, it tells `git fetch` which remote to fetch.
287
If this option is not given, `git fetch` defaults to remote "origin".
129
289
branch.<name>.merge::
130
When in branch <name>, it tells `git fetch` the default remote branch
134
A boolean to enable/disable colored output when the pager is in
135
use (default is true).
290
When in branch <name>, it tells `git fetch` the default refspec to
291
be marked for merging in FETCH_HEAD. The value has exactly to match
292
a remote part of one of the refspecs which are fetched from the remote
293
given by "branch.<name>.remote".
294
The merge information is used by `git pull` (which at first calls
295
`git fetch`) to lookup the default branch for merging. Without
296
this option, `git pull` defaults to merge the first refspec fetched.
297
Specify multiple values to get an octopus merge.
298
If you wish to setup `git pull` so that it merges into <name> from
299
another branch in the local repository, you can point
300
branch.<name>.merge to the desired branch, and use the special setting
301
`.` (a period) for branch.<name>.remote.
304
A boolean to enable/disable color in the output of
305
gitlink:git-branch[1]. May be set to `true` (or `always`),
306
`false` (or `never`) or `auto`, in which case colors are used
307
only when the output is to a terminal. Defaults to false.
309
color.branch.<slot>::
310
Use customized color for branch coloration. `<slot>` is one of
311
`current` (the current branch), `local` (a local branch),
312
`remote` (a tracking branch in refs/remotes/), `plain` (other
315
The value for these configuration variables is a list of colors (at most
316
two) and attributes (at most one), separated by spaces. The colors
317
accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
318
`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
319
`blink` and `reverse`. The first color given is the foreground; the
320
second is the background. The position of the attribute, if any,
138
324
When true (or `always`), always use colors in patch.
139
325
When false (or `never`), never. When set to `auto`, use
140
326
colors only when the output is to the terminal.
143
Use customized color for diff colorization. `<slot>`
144
specifies which part of the patch to use the specified
145
color, and is one of `plain` (context text), `meta`
146
(metainformation), `frag` (hunk header), `old` (removed
147
lines), or `new` (added lines). The value for these
148
configuration variables can be one of: `normal`, `bold`,
149
`dim`, `ul`, `blink`, `reverse`, `reset`, `black`,
150
`red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, or
329
Use customized color for diff colorization. `<slot>` specifies
330
which part of the patch to use the specified color, and is one
331
of `plain` (context text), `meta` (metainformation), `frag`
332
(hunk header), `old` (removed lines), `new` (added lines),
333
`commit` (commit headers), or `whitespace` (highlighting dubious
334
whitespace). The values of these variables may be specified as
335
in color.branch.<slot>.
338
A boolean to enable/disable colored output when the pager is in
339
use (default is true).
342
A boolean to enable/disable color in the output of
343
gitlink:git-status[1]. May be set to `true` (or `always`),
344
`false` (or `never`) or `auto`, in which case colors are used
345
only when the output is to a terminal. Defaults to false.
347
color.status.<slot>::
348
Use customized color for status colorization. `<slot>` is
349
one of `header` (the header text of the status message),
350
`added` or `updated` (files which are added but not committed),
351
`changed` (files which are changed but not added in the index),
352
or `untracked` (files which are not tracked by git). The values of
353
these variables may be specified as in color.branch.<slot>.
153
355
diff.renameLimit::
154
356
The number of files to consider when performing the copy/rename
159
361
will enable basic rename detection. If set to "copies" or
160
362
"copy", it will detect copies, as well.
365
If the number of objects fetched over the git native
366
transfer is below this
367
limit, then the objects will be unpacked into loose object
368
files. However if the number of received objects equals or
369
exceeds this limit then the received pack will be stored as
370
a pack, after adding any missing delta bases. Storing the
371
pack from a push can make the push operation complete faster,
372
especially on slow filesystems.
163
375
Additional email headers to include in a patch to be submitted
164
376
by mail. See gitlink:git-format-patch[1].
379
The default for format-patch is to output files with the suffix
380
`.patch`. Use this variable to change that suffix (make sure to
381
include the dot if you want it).
384
`git gc` does not run `git pack-refs` in a bare repository by
385
default so that older dumb-transport clients can still fetch
386
from the repository. Setting this to `true` lets `git
387
gc` to run `git pack-refs`. Setting this to `false` tells
388
`git gc` never to run `git pack-refs`. The default setting is
389
`notbare`. Enable it only when you know you do not have to
390
support such clients. The default setting will change to `true`
391
at some stage, and setting this to `false` will continue to
392
prevent `git pack-refs` from being run from `git gc`.
395
`git reflog expire` removes reflog entries older than
396
this time; defaults to 90 days.
398
gc.reflogexpireunreachable::
399
`git reflog expire` removes reflog entries older than
400
this time and are not reachable from the current tip;
404
Records of conflicted merge you resolved earlier are
405
kept for this many days when `git rerere gc` is run.
406
The default is 60 days. See gitlink:git-rerere[1].
408
gc.rerereunresolved::
409
Records of conflicted merge you have not resolved are
410
kept for this many days when `git rerere gc` is run.
411
The default is 15 days. See gitlink:git-rerere[1].
167
Whether the cvs pserver interface is enabled for this repository.
414
Whether the cvs server interface is enabled for this repository.
168
415
See gitlink:git-cvsserver[1].
171
Path to a log file where the cvs pserver interface well... logs
418
Path to a log file where the cvs server interface well... logs
172
419
various stuff. See gitlink:git-cvsserver[1].
422
If true, all files are sent to the client in mode '-kb'. This
423
causes the client to treat all files as binary files which suppresses
424
any newline munging it otherwise might do. A work-around for the
425
fact that there is no way yet to set single files to mode '-kb'.
426
See gitlink:git-cvsserver[1].
175
429
Whether to verify the SSL certificate when fetching or pushing
176
430
over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
219
473
browser (and possibly at other places in the future or in other
220
474
porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
476
i18n.logOutputEncoding::
477
Character encoding the commit messages are converted to when
478
running `git-log` and friends.
481
If true, the initial commit will be shown as a big creation event.
482
This is equivalent to a diff against an empty tree.
483
Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
484
normally hide the root commit will now show it. True by default.
223
487
Whether to include summaries of merged commits in newly created
224
488
merge commit messages. False by default.
491
Controls which merge resolution program is used by
492
gitlink:git-mergetool[l]. Valid values are: "kdiff3", "tkdiff",
493
"meld", "xxdiff", "emerge", "vimdiff"
496
Controls the amount of output shown by the recursive merge
497
strategy. Level 0 outputs nothing except a final error
498
message if conflicts were detected. Level 1 outputs only
499
conflicts, 2 outputs conflicts and file changes. Level 5 and
500
above outputs debugging information. The default is level 2.
227
503
The size of the window used by gitlink:git-pack-objects[1] when no
228
504
window size is given on the command line. Defaults to 10.
246
522
The default set of "refspec" for gitlink:git-push[1]. See
247
523
gitlink:git-push[1].
525
remote.<name>.skipDefaultUpdate::
526
If true, this remote will be skipped by default when updating
527
using the remote subcommand of gitlink:git-remote[1].
529
remote.<name>.receivepack::
530
The default program to execute on the remote side when pushing. See
531
option \--exec of gitlink:git-push[1].
533
remote.<name>.uploadpack::
534
The default program to execute on the remote side when fetching. See
535
option \--exec of gitlink:git-fetch-pack[1].
537
remote.<name>.tagopt::
538
Setting this value to --no-tags disables automatic tag following when fetching
542
The list of remotes which are fetched by "git remote update
543
<group>". See gitlink:git-remote[1].
249
545
repack.usedeltabaseoffset::
250
546
Allow gitlink:git-repack[1] to create packs that uses
251
547
delta-base offset. Defaults to false.
258
554
The default set of branches for gitlink:git-show-branch[1].
259
555
See gitlink:git-show-branch[1].
262
A boolean to enable/disable color in the output of
263
gitlink:git-status[1]. May be set to `true` (or `always`),
264
`false` (or `never`) or `auto`, in which case colors are used
265
only when the output is to a terminal. Defaults to false.
267
status.color.<slot>::
268
Use customized color for status colorization. `<slot>` is
269
one of `header` (the header text of the status message),
270
`updated` (files which are updated but not committed),
271
`changed` (files which are changed but not updated in the index),
272
or `untracked` (files which are not tracked by git). The values of
273
these variables may be specified as in diff.color.<slot>.
276
558
By default, gitlink:git-tar-tree[1] sets file and directories modes
277
559
to 0666 or 0777. While this is both useful and acceptable for projects
added
removed
Documentation/config.txt
