]>
Commit | Line | Data |
---|---|---|
1ab661dd PB |
1 | CONFIGURATION FILE |
2 | ------------------ | |
3 | ||
4 | The git configuration file contains a number of variables that affect | |
5ea5621f JH |
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 | |
32043c9f JS |
8 | fallback values for `.git/config` file. The file `/etc/gitconfig` |
9 | can be used to store system-wide defaults. | |
5ea5621f JH |
10 | |
11 | They can be used by both the git plumbing | |
b8936cf0 | 12 | and the porcelains. The variables are divided into sections, where |
1ab661dd PB |
13 | in the fully qualified variable name the variable itself is the last |
14 | dot-separated segment and the section name is everything before the last | |
15 | dot. The variable names are case-insensitive and only alphanumeric | |
16 | characters are allowed. Some variables may appear multiple times. | |
17 | ||
e136f33b JN |
18 | Syntax |
19 | ~~~~~~ | |
20 | ||
1ab661dd | 21 | The syntax is fairly flexible and permissive; whitespaces are mostly |
e136f33b JN |
22 | ignored. The '#' and ';' characters begin comments to the end of line, |
23 | blank lines are ignored. | |
24 | ||
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. | |
31 | ||
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: | |
35 | ||
36 | -------- | |
37 | [section "subsection"] | |
38 | ||
39 | -------- | |
40 | ||
191453f6 JN |
41 | Subsection names can contain any characters except newline (doublequote |
42 | '`"`' and backslash have to be escaped as '`\"`' and '`\\`', | |
3dff5379 | 43 | respectively) and are case sensitive. Section header cannot span multiple |
e136f33b JN |
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 | |
46 | don't need to. | |
47 | ||
48 | There is also (case insensitive) alternative `[section.subsection]` syntax. | |
49 | In this syntax subsection names follow the same restrictions as for section | |
50 | name. | |
51 | ||
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. | |
58 | ||
59 | Leading and trailing whitespace in a variable value is discarded. | |
60 | Internal whitespace within a variable value is retained verbatim. | |
61 | ||
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; | |
e0d10e1c | 66 | `git-config` will ensure that the output is "true" or "false". |
e136f33b JN |
67 | |
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 '`\`'. | |
74 | ||
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. | |
79 | ||
80 | Variable value ending in a '`\`' is continued on the next line in the | |
81 | customary UNIX fashion. | |
82 | ||
83 | Some variables may require special value format. | |
1ab661dd PB |
84 | |
85 | Example | |
86 | ~~~~~~~ | |
87 | ||
88 | # Core variables | |
89 | [core] | |
90 | ; Don't trust file modes | |
91 | filemode = false | |
92 | ||
93 | # Our diff algorithm | |
94 | [diff] | |
95 | external = "/usr/local/bin/gnu-diff -u" | |
96 | renames = true | |
97 | ||
910c00c8 AK |
98 | [branch "devel"] |
99 | remote = origin | |
100 | merge = refs/heads/devel | |
101 | ||
e136f33b JN |
102 | # Proxy settings |
103 | [core] | |
29093c28 | 104 | gitProxy="ssh" for "kernel.org" |
e136f33b | 105 | gitProxy=default-proxy ; for the rest |
910c00c8 | 106 | |
1ab661dd PB |
107 | Variables |
108 | ~~~~~~~~~ | |
109 | ||
110 | Note that this list is non-comprehensive and not necessarily complete. | |
b8936cf0 FD |
111 | For command-specific variables, you will find a more detailed description |
112 | in the appropriate manual page. You will find a description of non-core | |
1ab661dd PB |
113 | porcelain configuration variables in the respective porcelain documentation. |
114 | ||
115 | core.fileMode:: | |
116 | If false, the executable bit differences between the index and | |
117 | the working copy are ignored; useful on broken filesystems like FAT. | |
118 | See gitlink:git-update-index[1]. True by default. | |
119 | ||
9378c161 JH |
120 | core.quotepath:: |
121 | The commands that output paths (e.g. `ls-files`, | |
122 | `diff`), when not given the `-z` option, will quote | |
123 | "unusual" characters in the pathname by enclosing the | |
124 | pathname in a double-quote pair and with backslashes the | |
125 | same way strings in C source code are quoted. If this | |
126 | variable is set to false, the bytes higher than 0x80 are | |
127 | not quoted but output as verbatim. Note that double | |
128 | quote, backslash and control characters are always | |
129 | quoted without `-z` regardless of the setting of this | |
130 | variable. | |
131 | ||
5cb71f82 FL |
132 | core.autocrlf:: |
133 | If true, makes git convert `CRLF` at the end of lines in text files to | |
134 | `LF` when reading from the filesystem, and convert in reverse when | |
135 | writing to the filesystem. The variable can be set to | |
136 | 'input', in which case the conversion happens only while | |
137 | reading from the filesystem but files are written out with | |
138 | `LF` at the end of lines. Currently, which paths to consider | |
139 | "text" (i.e. be subjected to the autocrlf mechanism) is | |
140 | decided purely based on the contents. | |
141 | ||
78a8d641 JS |
142 | core.symlinks:: |
143 | If false, symbolic links are checked out as small plain files that | |
144 | contain the link text. gitlink:git-update-index[1] and | |
145 | gitlink:git-add[1] will not change the recorded type to regular | |
146 | file. Useful on filesystems like FAT that do not support | |
147 | symbolic links. True by default. | |
148 | ||
1ab661dd PB |
149 | core.gitProxy:: |
150 | A "proxy command" to execute (as 'command host port') instead | |
151 | of establishing direct connection to the remote server when | |
152 | using the git protocol for fetching. If the variable value is | |
153 | in the "COMMAND for DOMAIN" format, the command is applied only | |
154 | on hostnames ending with the specified domain string. This variable | |
155 | may be set multiple times and is matched in the given order; | |
156 | the first match wins. | |
b8936cf0 FD |
157 | + |
158 | Can be overridden by the 'GIT_PROXY_COMMAND' environment variable | |
159 | (which always applies universally, without the special "for" | |
160 | handling). | |
1ab661dd PB |
161 | |
162 | core.ignoreStat:: | |
163 | The working copy files are assumed to stay unchanged until you | |
164 | mark them otherwise manually - Git will not detect the file changes | |
165 | by lstat() calls. This is useful on systems where those are very | |
166 | slow, such as Microsoft Windows. See gitlink:git-update-index[1]. | |
167 | False by default. | |
168 | ||
9f0bb90d JH |
169 | core.preferSymlinkRefs:: |
170 | Instead of the default "symref" format for HEAD | |
171 | and other symbolic reference files, use symbolic links. | |
172 | This is sometimes needed to work with old scripts that | |
173 | expect HEAD to be a symbolic link. | |
1ab661dd | 174 | |
e4a15f40 SP |
175 | core.bare:: |
176 | If true this repository is assumed to be 'bare' and has no | |
177 | working directory associated with it. If this is the case a | |
178 | number of commands that require a working directory will be | |
179 | disabled, such as gitlink:git-add[1] or gitlink:git-merge[1]. | |
180 | + | |
181 | This setting is automatically guessed by gitlink:git-clone[1] or | |
182 | gitlink:git-init[1] when the repository was created. By default a | |
183 | repository that ends in "/.git" is assumed to be not bare (bare = | |
184 | false), while all other repositories are assumed to be bare (bare | |
185 | = true). | |
186 | ||
892c41b9 ML |
187 | core.worktree:: |
188 | Set the path to the working tree. The value will not be | |
189 | used in combination with repositories found automatically in | |
190 | a .git directory (i.e. $GIT_DIR is not set). | |
06ada152 | 191 | This can be overridden by the GIT_WORK_TREE environment |
892c41b9 ML |
192 | variable and the '--work-tree' command line option. |
193 | ||
6de08ae6 | 194 | core.logAllRefUpdates:: |
14cd5607 | 195 | Enable the reflog. Updates to a ref <ref> is logged to the file |
4057deb5 JH |
196 | "$GIT_DIR/logs/<ref>", by appending the new and old |
197 | SHA1, the date/time and the reason of the update, but | |
198 | only when the file exists. If this configuration | |
199 | variable is set to true, missing "$GIT_DIR/logs/<ref>" | |
200 | file is automatically created for branch heads. | |
a862f97e JH |
201 | + |
202 | This information can be used to determine what commit | |
203 | was the tip of a branch "2 days ago". | |
204 | + | |
205 | This value is true by default in a repository that has | |
206 | a working directory associated with it, and false by | |
207 | default in a bare repository. | |
6de08ae6 | 208 | |
1ab661dd PB |
209 | core.repositoryFormatVersion:: |
210 | Internal variable identifying the repository format and layout | |
211 | version. | |
212 | ||
213 | core.sharedRepository:: | |
d5dc6a76 JF |
214 | When 'group' (or 'true'), the repository is made shareable between |
215 | several users in a group (making sure all the files and objects are | |
216 | group-writable). When 'all' (or 'world' or 'everybody'), the | |
217 | repository will be readable by all users, additionally to being | |
218 | group-shareable. When 'umask' (or 'false'), git will use permissions | |
5c94f87e | 219 | reported by umask(2). See gitlink:git-init[1]. False by default. |
1ab661dd PB |
220 | |
221 | core.warnAmbiguousRefs:: | |
222 | If true, git will warn you if the ref name you passed it is ambiguous | |
223 | and might match multiple refs in the .git/refs/ tree. True by default. | |
224 | ||
3d3e95af | 225 | core.compression:: |
960ccca6 DH |
226 | An integer -1..9, indicating a default compression level. |
227 | -1 is the zlib default. 0 means no compression, | |
228 | and 1..9 are various speed/size tradeoffs, 9 being slowest. | |
dec92309 BD |
229 | If set, this provides a default to other compression variables, |
230 | such as 'core.loosecompression' and 'pack.compression'. | |
960ccca6 DH |
231 | |
232 | core.loosecompression:: | |
12f6c308 | 233 | An integer -1..9, indicating the compression level for objects that |
960ccca6 | 234 | are not in a pack file. -1 is the zlib default. 0 means no |
12f6c308 | 235 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
960ccca6 | 236 | slowest. If not set, defaults to core.compression. If that is |
de1b2460 | 237 | not set, defaults to 1 (best speed). |
12f6c308 | 238 | |
60bb8b14 SP |
239 | core.packedGitWindowSize:: |
240 | Number of bytes of a pack file to map into memory in a | |
241 | single mapping operation. Larger window sizes may allow | |
242 | your system to process a smaller number of large pack files | |
243 | more quickly. Smaller window sizes will negatively affect | |
eb92242f | 244 | performance due to increased calls to the operating system's |
60bb8b14 | 245 | memory manager, but may improve performance when accessing |
22bac0ea SP |
246 | a large number of large pack files. |
247 | + | |
248 | Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 | |
249 | MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should | |
250 | be reasonable for all users/operating systems. You probably do | |
251 | not need to adjust this value. | |
eb92242f SP |
252 | + |
253 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
60bb8b14 | 254 | |
77ccc5bb SP |
255 | core.packedGitLimit:: |
256 | Maximum number of bytes to map simultaneously into memory | |
257 | from pack files. If Git needs to access more than this many | |
258 | bytes at once to complete an operation it will unmap existing | |
259 | regions to reclaim virtual address space within the process. | |
22bac0ea SP |
260 | + |
261 | Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. | |
262 | This should be reasonable for all users/operating systems, except on | |
263 | the largest projects. You probably do not need to adjust this value. | |
eb92242f SP |
264 | + |
265 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
77ccc5bb | 266 | |
18bdec11 SP |
267 | core.deltaBaseCacheLimit:: |
268 | Maximum number of bytes to reserve for caching base objects | |
269 | that multiple deltafied objects reference. By storing the | |
270 | entire decompressed base objects in a cache Git is able | |
271 | to avoid unpacking and decompressing frequently used base | |
272 | objects multiple times. | |
273 | + | |
274 | Default is 16 MiB on all platforms. This should be reasonable | |
275 | for all users/operating systems, except on the largest projects. | |
276 | You probably do not need to adjust this value. | |
277 | + | |
278 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
279 | ||
e8964a5b | 280 | core.excludesfile:: |
0ba956d3 JS |
281 | In addition to '.gitignore' (per-directory) and |
282 | '.git/info/exclude', git looks into this file for patterns | |
cedb8d5d JT |
283 | of files which are not meant to be tracked. See |
284 | gitlink:gitignore[5]. | |
0ba956d3 | 285 | |
ef0c2abf AR |
286 | core.editor:: |
287 | Commands such as `commit` and `tag` that lets you edit | |
02783075 | 288 | messages by launching an editor uses the value of this |
ef0c2abf AR |
289 | variable when it is set, and the environment variable |
290 | `GIT_EDITOR` is not set. The order of preference is | |
a644ffde JH |
291 | `GIT_EDITOR` environment, `core.editor`, `VISUAL` and |
292 | `EDITOR` environment variables and then finally `vi`. | |
ef0c2abf | 293 | |
54adf370 BG |
294 | core.pager:: |
295 | The command that git will use to paginate output. Can be overridden | |
296 | with the `GIT_PAGER` environment variable. | |
297 | ||
4514ad4f PB |
298 | alias.*:: |
299 | Command aliases for the gitlink:git[1] command wrapper - e.g. | |
300 | after defining "alias.last = cat-file commit HEAD", the invocation | |
301 | "git last" is equivalent to "git cat-file commit HEAD". To avoid | |
99b41c84 PB |
302 | confusion and troubles with script usage, aliases that |
303 | hide existing git commands are ignored. Arguments are split by | |
304 | spaces, the usual shell quoting and escaping is supported. | |
305 | quote pair and a backslash can be used to quote them. | |
f368f5a6 JH |
306 | + |
307 | If the alias expansion is prefixed with an exclamation point, | |
308 | it will be treated as a shell command. For example, defining | |
309 | "alias.new = !gitk --all --not ORIG_HEAD", the invocation | |
310 | "git new" is equivalent to running the shell command | |
311 | "gitk --all --not ORIG_HEAD". | |
dfd42a3c | 312 | |
1ab661dd PB |
313 | apply.whitespace:: |
314 | Tells `git-apply` how to handle whitespaces, in the same way | |
315 | as the '--whitespace' option. See gitlink:git-apply[1]. | |
316 | ||
9902387d | 317 | branch.autosetupmerge:: |
5fdcf75c | 318 | Tells `git-branch` and `git-checkout` to setup new branches |
9902387d PB |
319 | so that gitlink:git-pull[1] will appropriately merge from that |
320 | remote branch. Note that even if this option is not set, | |
321 | this behavior can be chosen per-branch using the `--track` | |
6f084a56 | 322 | and `--no-track` options. This option defaults to false. |
9902387d | 323 | |
648ad18f SB |
324 | branch.<name>.remote:: |
325 | When in branch <name>, it tells `git fetch` which remote to fetch. | |
62b339a5 | 326 | If this option is not given, `git fetch` defaults to remote "origin". |
648ad18f | 327 | |
5372806a | 328 | branch.<name>.merge:: |
b888d61c DB |
329 | When in branch <name>, it tells `git fetch` the default |
330 | refspec to be marked for merging in FETCH_HEAD. The value is | |
331 | handled like the remote part of a refspec, and must match a | |
332 | ref which is fetched from the remote given by | |
333 | "branch.<name>.remote". | |
62b339a5 JW |
334 | The merge information is used by `git pull` (which at first calls |
335 | `git fetch`) to lookup the default branch for merging. Without | |
336 | this option, `git pull` defaults to merge the first refspec fetched. | |
337 | Specify multiple values to get an octopus merge. | |
9debc324 PB |
338 | If you wish to setup `git pull` so that it merges into <name> from |
339 | another branch in the local repository, you can point | |
340 | branch.<name>.merge to the desired branch, and use the special setting | |
341 | `.` (a period) for branch.<name>.remote. | |
5372806a | 342 | |
aec7b362 LH |
343 | branch.<name>.mergeoptions:: |
344 | Sets default options for merging into branch <name>. The syntax and | |
345 | supported options are equal to that of gitlink:git-merge[1], but | |
346 | option values containing whitespace characters are currently not | |
347 | supported. | |
348 | ||
cd67e4d4 JS |
349 | branch.<name>.rebase:: |
350 | When true, rebase the branch <name> on top of the fetched branch, | |
351 | instead of merging the default branch from the default remote. | |
352 | *NOTE*: this is a possibly dangerous operation; do *not* use | |
353 | it unless you understand the implications (see gitlink:git-rebase[1] | |
354 | for details). | |
355 | ||
2122591b | 356 | clean.requireForce:: |
562ca192 JH |
357 | A boolean to make git-clean do nothing unless given -f |
358 | or -n. Defaults to true. | |
2122591b | 359 | |
f3673988 BG |
360 | color.branch:: |
361 | A boolean to enable/disable color in the output of | |
362 | gitlink:git-branch[1]. May be set to `true` (or `always`), | |
363 | `false` (or `never`) or `auto`, in which case colors are used | |
364 | only when the output is to a terminal. Defaults to false. | |
365 | ||
366 | color.branch.<slot>:: | |
367 | Use customized color for branch coloration. `<slot>` is one of | |
368 | `current` (the current branch), `local` (a local branch), | |
369 | `remote` (a tracking branch in refs/remotes/), `plain` (other | |
4f193f20 MW |
370 | refs). |
371 | + | |
372 | The value for these configuration variables is a list of colors (at most | |
373 | two) and attributes (at most one), separated by spaces. The colors | |
374 | accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, | |
375 | `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, | |
376 | `blink` and `reverse`. The first color given is the foreground; the | |
377 | second is the background. The position of the attribute, if any, | |
378 | doesn't matter. | |
f3673988 | 379 | |
a159ca0c | 380 | color.diff:: |
b5376648 JH |
381 | When true (or `always`), always use colors in patch. |
382 | When false (or `never`), never. When set to `auto`, use | |
383 | colors only when the output is to the terminal. | |
384 | ||
a159ca0c | 385 | color.diff.<slot>:: |
4f193f20 MW |
386 | Use customized color for diff colorization. `<slot>` specifies |
387 | which part of the patch to use the specified color, and is one | |
388 | of `plain` (context text), `meta` (metainformation), `frag` | |
389 | (hunk header), `old` (removed lines), `new` (added lines), | |
390 | `commit` (commit headers), or `whitespace` (highlighting dubious | |
391 | whitespace). The values of these variables may be specified as | |
392 | in color.branch.<slot>. | |
b5376648 | 393 | |
1d77043b JH |
394 | color.pager:: |
395 | A boolean to enable/disable colored output when the pager is in | |
396 | use (default is true). | |
397 | ||
398 | color.status:: | |
399 | A boolean to enable/disable color in the output of | |
400 | gitlink:git-status[1]. May be set to `true` (or `always`), | |
401 | `false` (or `never`) or `auto`, in which case colors are used | |
402 | only when the output is to a terminal. Defaults to false. | |
403 | ||
404 | color.status.<slot>:: | |
405 | Use customized color for status colorization. `<slot>` is | |
406 | one of `header` (the header text of the status message), | |
82dca848 SP |
407 | `added` or `updated` (files which are added but not committed), |
408 | `changed` (files which are changed but not added in the index), | |
1d77043b | 409 | or `untracked` (files which are not tracked by git). The values of |
f3673988 | 410 | these variables may be specified as in color.branch.<slot>. |
1d77043b | 411 | |
383e45ce BG |
412 | commit.template:: |
413 | Specify a file to use as the template for new commit messages. | |
414 | ||
aecbf914 JH |
415 | diff.autorefreshindex:: |
416 | When using `git diff` to compare with work tree | |
417 | files, do not consider stat-only change as changed. | |
418 | Instead, silently run `git update-index --refresh` to | |
419 | update the cached stat information for paths whose | |
420 | contents in the work tree match the contents in the | |
421 | index. This option defaults to true. Note that this | |
422 | affects only `git diff` Porcelain, and not lower level | |
423 | `diff` commands, such as `git diff-files`. | |
424 | ||
1ab661dd PB |
425 | diff.renameLimit:: |
426 | The number of files to consider when performing the copy/rename | |
427 | detection; equivalent to the git diff option '-l'. | |
428 | ||
b68ea12e EW |
429 | diff.renames:: |
430 | Tells git to detect renames. If set to any boolean value, it | |
431 | will enable basic rename detection. If set to "copies" or | |
432 | "copy", it will detect copies, as well. | |
433 | ||
af7cf268 JH |
434 | fetch.unpackLimit:: |
435 | If the number of objects fetched over the git native | |
436 | transfer is below this | |
437 | limit, then the objects will be unpacked into loose object | |
438 | files. However if the number of received objects equals or | |
439 | exceeds this limit then the received pack will be stored as | |
440 | a pack, after adding any missing delta bases. Storing the | |
441 | pack from a push can make the push operation complete faster, | |
442 | especially on slow filesystems. | |
443 | ||
49604a4d BG |
444 | format.numbered:: |
445 | A boolean which can enable sequence numbers in patch subjects. | |
446 | Seting this option to "auto" will enable it only if there is | |
447 | more than one patch. See --numbered option in | |
448 | gitlink:git-format-patch[1]. | |
449 | ||
1ab661dd PB |
450 | format.headers:: |
451 | Additional email headers to include in a patch to be submitted | |
452 | by mail. See gitlink:git-format-patch[1]. | |
453 | ||
78cb59c8 JS |
454 | format.suffix:: |
455 | The default for format-patch is to output files with the suffix | |
456 | `.patch`. Use this variable to change that suffix (make sure to | |
457 | include the dot if you want it). | |
1ab661dd | 458 | |
0d7566a5 TT |
459 | gc.aggressiveWindow:: |
460 | The window size parameter used in the delta compression | |
461 | algorithm used by 'git gc --aggressive'. This defaults | |
462 | to 10. | |
463 | ||
e9831e83 JH |
464 | gc.auto:: |
465 | When there are approximately more than this many loose | |
466 | objects in the repository, `git gc --auto` will pack them. | |
467 | Some Porcelain commands use this command to perform a | |
468 | light-weight garbage collection from time to time. Setting | |
469 | this to 0 disables it. | |
470 | ||
17815501 JH |
471 | gc.autopacklimit:: |
472 | When there are more than this many packs that are not | |
473 | marked with `*.keep` file in the repository, `git gc | |
474 | --auto` consolidates them into one larger pack. Setting | |
475 | this to 0 disables this. | |
476 | ||
c2120e5e JS |
477 | gc.packrefs:: |
478 | `git gc` does not run `git pack-refs` in a bare repository by | |
479 | default so that older dumb-transport clients can still fetch | |
480 | from the repository. Setting this to `true` lets `git | |
481 | gc` to run `git pack-refs`. Setting this to `false` tells | |
482 | `git gc` never to run `git pack-refs`. The default setting is | |
483 | `notbare`. Enable it only when you know you do not have to | |
484 | support such clients. The default setting will change to `true` | |
485 | at some stage, and setting this to `false` will continue to | |
486 | prevent `git pack-refs` from being run from `git gc`. | |
487 | ||
4aec56d1 JH |
488 | gc.reflogexpire:: |
489 | `git reflog expire` removes reflog entries older than | |
490 | this time; defaults to 90 days. | |
491 | ||
492 | gc.reflogexpireunreachable:: | |
493 | `git reflog expire` removes reflog entries older than | |
494 | this time and are not reachable from the current tip; | |
495 | defaults to 30 days. | |
496 | ||
48c32424 JH |
497 | gc.rerereresolved:: |
498 | Records of conflicted merge you resolved earlier are | |
499 | kept for this many days when `git rerere gc` is run. | |
500 | The default is 60 days. See gitlink:git-rerere[1]. | |
501 | ||
502 | gc.rerereunresolved:: | |
503 | Records of conflicted merge you have not resolved are | |
504 | kept for this many days when `git rerere gc` is run. | |
505 | The default is 15 days. See gitlink:git-rerere[1]. | |
506 | ||
b4372ef1 JS |
507 | rerere.enabled:: |
508 | Activate recording of resolved conflicts, so that identical | |
509 | conflict hunks can be resolved automatically, should they | |
510 | be encountered again. See gitlink:git-rerere[1]. | |
511 | ||
1ab661dd | 512 | gitcvs.enabled:: |
db218723 | 513 | Whether the CVS server interface is enabled for this repository. |
1ab661dd PB |
514 | See gitlink:git-cvsserver[1]. |
515 | ||
516 | gitcvs.logfile:: | |
db218723 | 517 | Path to a log file where the CVS server interface well... logs |
1ab661dd PB |
518 | various stuff. See gitlink:git-cvsserver[1]. |
519 | ||
eabb0bfd FL |
520 | gitcvs.allbinary:: |
521 | If true, all files are sent to the client in mode '-kb'. This | |
522 | causes the client to treat all files as binary files which suppresses | |
523 | any newline munging it otherwise might do. A work-around for the | |
524 | fact that there is no way yet to set single files to mode '-kb'. | |
abbf5947 | 525 | |
04752868 FL |
526 | gitcvs.dbname:: |
527 | Database used by git-cvsserver to cache revision information | |
528 | derived from the git repository. The exact meaning depends on the | |
529 | used database driver, for SQLite (which is the default driver) this | |
530 | is a filename. Supports variable substitution (see | |
531 | gitlink:git-cvsserver[1] for details). May not contain semicolons (`;`). | |
532 | Default: '%Ggitcvs.%m.sqlite' | |
533 | ||
534 | gitcvs.dbdriver:: | |
535 | Used Perl DBI driver. You can specify any available driver | |
536 | for this here, but it might not work. git-cvsserver is tested | |
537 | with 'DBD::SQLite', reported to work with 'DBD::Pg', and | |
538 | reported *not* to work with 'DBD::mysql'. Experimental feature. | |
539 | May not contain double colons (`:`). Default: 'SQLite'. | |
eabb0bfd FL |
540 | See gitlink:git-cvsserver[1]. |
541 | ||
04752868 FL |
542 | gitcvs.dbuser, gitcvs.dbpass:: |
543 | Database user and password. Only useful if setting 'gitcvs.dbdriver', | |
544 | since SQLite has no concept of database users and/or passwords. | |
545 | 'gitcvs.dbuser' supports variable substitution (see | |
546 | gitlink:git-cvsserver[1] for details). | |
547 | ||
02783075 BH |
548 | All gitcvs variables except for 'gitcvs.allbinary' can also be |
549 | specified as 'gitcvs.<access_method>.<varname>' (where 'access_method' | |
550 | is one of "ext" and "pserver") to make them apply only for the given | |
551 | access method. | |
04752868 | 552 | |
9c5665aa SV |
553 | http.proxy:: |
554 | Override the HTTP proxy, normally configured using the 'http_proxy' | |
14c98218 SV |
555 | environment variable (see gitlink:curl[1]). This can be overridden |
556 | on a per-remote basis; see remote.<name>.proxy | |
9c5665aa | 557 | |
1ab661dd PB |
558 | http.sslVerify:: |
559 | Whether to verify the SSL certificate when fetching or pushing | |
37425065 | 560 | over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment |
1ab661dd PB |
561 | variable. |
562 | ||
563 | http.sslCert:: | |
564 | File containing the SSL certificate when fetching or pushing | |
37425065 | 565 | over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment |
1ab661dd PB |
566 | variable. |
567 | ||
568 | http.sslKey:: | |
569 | File containing the SSL private key when fetching or pushing | |
abda1ef5 | 570 | over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment |
1ab661dd PB |
571 | variable. |
572 | ||
573 | http.sslCAInfo:: | |
574 | File containing the certificates to verify the peer with when | |
abda1ef5 | 575 | fetching or pushing over HTTPS. Can be overridden by the |
1ab661dd PB |
576 | 'GIT_SSL_CAINFO' environment variable. |
577 | ||
578 | http.sslCAPath:: | |
579 | Path containing files with the CA certificates to verify the peer | |
37425065 | 580 | with when fetching or pushing over HTTPS. Can be overridden |
1ab661dd PB |
581 | by the 'GIT_SSL_CAPATH' environment variable. |
582 | ||
583 | http.maxRequests:: | |
abda1ef5 | 584 | How many HTTP requests to launch in parallel. Can be overridden |
1ab661dd PB |
585 | by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. |
586 | ||
587 | http.lowSpeedLimit, http.lowSpeedTime:: | |
588 | If the HTTP transfer speed is less than 'http.lowSpeedLimit' | |
589 | for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. | |
abda1ef5 | 590 | Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and |
1ab661dd PB |
591 | 'GIT_HTTP_LOW_SPEED_TIME' environment variables. |
592 | ||
3ea099d4 SK |
593 | http.noEPSV:: |
594 | A boolean which disables using of EPSV ftp command by curl. | |
befc9c42 | 595 | This can helpful with some "poor" ftp servers which don't |
3ea099d4 SK |
596 | support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' |
597 | environment variable. Default is false (curl will use EPSV). | |
598 | ||
1ab661dd PB |
599 | i18n.commitEncoding:: |
600 | Character encoding the commit messages are stored in; git itself | |
601 | does not care per se, but this information is necessary e.g. when | |
602 | importing commits from emails or in the gitk graphical history | |
603 | browser (and possibly at other places in the future or in other | |
604 | porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'. | |
605 | ||
d2c11a38 JH |
606 | i18n.logOutputEncoding:: |
607 | Character encoding the commit messages are converted to when | |
608 | running `git-log` and friends. | |
609 | ||
0f03ca94 PB |
610 | log.showroot:: |
611 | If true, the initial commit will be shown as a big creation event. | |
612 | This is equivalent to a diff against an empty tree. | |
613 | Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which | |
614 | normally hide the root commit will now show it. True by default. | |
615 | ||
1ab661dd PB |
616 | merge.summary:: |
617 | Whether to include summaries of merged commits in newly created | |
618 | merge commit messages. False by default. | |
619 | ||
c4b4a5af TT |
620 | merge.tool:: |
621 | Controls which merge resolution program is used by | |
6ea9c7eb | 622 | gitlink:git-mergetool[1]. Valid values are: "kdiff3", "tkdiff", |
730b5b45 | 623 | "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff". |
c4b4a5af | 624 | |
8c3275ab SP |
625 | merge.verbosity:: |
626 | Controls the amount of output shown by the recursive merge | |
627 | strategy. Level 0 outputs nothing except a final error | |
628 | message if conflicts were detected. Level 1 outputs only | |
629 | conflicts, 2 outputs conflicts and file changes. Level 5 and | |
630 | above outputs debugging information. The default is level 2. | |
06ada152 | 631 | Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable. |
8c3275ab | 632 | |
88e7fdf2 JH |
633 | merge.<driver>.name:: |
634 | Defines a human readable name for a custom low-level | |
635 | merge driver. See gitlink:gitattributes[5] for details. | |
636 | ||
637 | merge.<driver>.driver:: | |
638 | Defines the command that implements a custom low-level | |
639 | merge driver. See gitlink:gitattributes[5] for details. | |
640 | ||
641 | merge.<driver>.recursive:: | |
642 | Names a low-level merge driver to be used when | |
643 | performing an internal merge between common ancestors. | |
644 | See gitlink:gitattributes[5] for details. | |
645 | ||
4812a93a JK |
646 | pack.window:: |
647 | The size of the window used by gitlink:git-pack-objects[1] when no | |
648 | window size is given on the command line. Defaults to 10. | |
649 | ||
842aaf93 TT |
650 | pack.depth:: |
651 | The maximum delta depth used by gitlink:git-pack-objects[1] when no | |
618e613a | 652 | maximum depth is given on the command line. Defaults to 50. |
842aaf93 | 653 | |
e93b15cd BD |
654 | pack.windowMemory:: |
655 | The window memory size limit used by gitlink:git-pack-objects[1] | |
656 | when no limit is given on the command line. The value can be | |
657 | suffixed with "k", "m", or "g". Defaults to 0, meaning no | |
658 | limit. | |
659 | ||
960ccca6 DH |
660 | pack.compression:: |
661 | An integer -1..9, indicating the compression level for objects | |
662 | in a pack file. -1 is the zlib default. 0 means no | |
663 | compression, and 1..9 are various speed/size tradeoffs, 9 being | |
664 | slowest. If not set, defaults to core.compression. If that is | |
dec92309 BD |
665 | not set, defaults to -1, the zlib default, which is "a default |
666 | compromise between speed and compression (currently equivalent | |
667 | to level 6)." | |
960ccca6 | 668 | |
074b2eea | 669 | pack.deltaCacheSize:: |
02783075 | 670 | The maximum memory in bytes used for caching deltas in |
074b2eea MK |
671 | gitlink:git-pack-objects[1]. |
672 | A value of 0 means no limit. Defaults to 0. | |
673 | ||
e3dfddb3 | 674 | pack.deltaCacheLimit:: |
693b86ff | 675 | The maximum size of a delta, that is cached in |
e3dfddb3 MK |
676 | gitlink:git-pack-objects[1]. Defaults to 1000. |
677 | ||
693b86ff NP |
678 | pack.threads:: |
679 | Specifies the number of threads to spawn when searching for best | |
680 | delta matches. This requires that gitlink:git-pack-objects[1] | |
681 | be compiled with pthreads otherwise this option is ignored with a | |
682 | warning. This is meant to reduce packing time on multiprocessor | |
683 | machines. The required amount of memory for the delta search window | |
684 | is however multiplied by the number of threads. | |
685 | ||
4d00bda2 NP |
686 | pack.indexVersion:: |
687 | Specify the default pack index version. Valid values are 1 for | |
688 | legacy pack index used by Git versions prior to 1.5.2, and 2 for | |
689 | the new pack index with capabilities for packs larger than 4 GB | |
690 | as well as proper protection against the repacking of corrupted | |
691 | packs. Version 2 is selected and this config option ignored | |
692 | whenever the corresponding pack is larger than 2 GB. Otherwise | |
693 | the default is 1. | |
694 | ||
1ab661dd PB |
695 | pull.octopus:: |
696 | The default merge strategy to use when pulling multiple branches | |
697 | at once. | |
698 | ||
699 | pull.twohead:: | |
700 | The default merge strategy to use when pulling a single branch. | |
701 | ||
0cc6d346 SB |
702 | remote.<name>.url:: |
703 | The URL of a remote repository. See gitlink:git-fetch[1] or | |
704 | gitlink:git-push[1]. | |
705 | ||
14c98218 SV |
706 | remote.<name>.proxy:: |
707 | For remotes that require curl (http, https and ftp), the URL to | |
708 | the proxy to use for that remote. Set to the empty string to | |
709 | disable proxying for that remote. | |
710 | ||
0cc6d346 SB |
711 | remote.<name>.fetch:: |
712 | The default set of "refspec" for gitlink:git-fetch[1]. See | |
713 | gitlink:git-fetch[1]. | |
714 | ||
715 | remote.<name>.push:: | |
716 | The default set of "refspec" for gitlink:git-push[1]. See | |
717 | gitlink:git-push[1]. | |
718 | ||
1918278e TT |
719 | remote.<name>.skipDefaultUpdate:: |
720 | If true, this remote will be skipped by default when updating | |
721 | using the remote subcommand of gitlink:git-remote[1]. | |
722 | ||
060aafc1 | 723 | remote.<name>.receivepack:: |
5dee29ac | 724 | The default program to execute on the remote side when pushing. See |
060aafc1 UKK |
725 | option \--exec of gitlink:git-push[1]. |
726 | ||
5dee29ac UKK |
727 | remote.<name>.uploadpack:: |
728 | The default program to execute on the remote side when fetching. See | |
729 | option \--exec of gitlink:git-fetch-pack[1]. | |
730 | ||
047f636d AK |
731 | remote.<name>.tagopt:: |
732 | Setting this value to --no-tags disables automatic tag following when fetching | |
733 | from remote <name> | |
734 | ||
1918278e TT |
735 | remotes.<group>:: |
736 | The list of remotes which are fetched by "git remote update | |
737 | <group>". See gitlink:git-remote[1]. | |
738 | ||
b6945f57 JH |
739 | repack.usedeltabaseoffset:: |
740 | Allow gitlink:git-repack[1] to create packs that uses | |
741 | delta-base offset. Defaults to false. | |
742 | ||
1ab661dd PB |
743 | show.difftree:: |
744 | The default gitlink:git-diff-tree[1] arguments to be used | |
745 | for gitlink:git-show[1]. | |
746 | ||
747 | showbranch.default:: | |
748 | The default set of branches for gitlink:git-show-branch[1]. | |
749 | See gitlink:git-show-branch[1]. | |
750 | ||
ce1a79b6 | 751 | tar.umask:: |
687157c7 RS |
752 | This variable can be used to restrict the permission bits of |
753 | tar archive entries. The default is 0002, which turns off the | |
754 | world write bit. The special value "user" indicates that the | |
755 | archiving user's umask will be used instead. See umask(2) and | |
756 | gitlink:git-archive[1]. | |
ce1a79b6 | 757 | |
1ab661dd PB |
758 | user.email:: |
759 | Your email address to be recorded in any newly created commits. | |
28a94f88 JT |
760 | Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and |
761 | 'EMAIL' environment variables. See gitlink:git-commit-tree[1]. | |
1ab661dd PB |
762 | |
763 | user.name:: | |
764 | Your full name to be recorded in any newly created commits. | |
abda1ef5 | 765 | Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' |
1ab661dd PB |
766 | environment variables. See gitlink:git-commit-tree[1]. |
767 | ||
d67778ec AP |
768 | user.signingkey:: |
769 | If gitlink:git-tag[1] is not selecting the key you want it to | |
770 | automatically when creating a signed tag, you can override the | |
771 | default selection with this variable. This option is passed | |
772 | unchanged to gpg's --local-user parameter, so you may specify a key | |
773 | using any method that gpg supports. | |
774 | ||
1ab661dd PB |
775 | whatchanged.difftree:: |
776 | The default gitlink:git-diff-tree[1] arguments to be used | |
777 | for gitlink:git-whatchanged[1]. | |
778 | ||
779 | imap:: | |
780 | The configuration variables in the 'imap' section are described | |
781 | in gitlink:git-imap-send[1]. | |
199a9218 | 782 | |
fc04c412 SP |
783 | receive.unpackLimit:: |
784 | If the number of objects received in a push is below this | |
785 | limit then the objects will be unpacked into loose object | |
786 | files. However if the number of received objects equals or | |
787 | exceeds this limit then the received pack will be stored as | |
788 | a pack, after adding any missing delta bases. Storing the | |
789 | pack from a push can make the push operation complete faster, | |
790 | especially on slow filesystems. | |
791 | ||
792 | receive.denyNonFastForwards:: | |
199a9218 JS |
793 | If set to true, git-receive-pack will deny a ref update which is |
794 | not a fast forward. Use this to prevent such an update via a push, | |
795 | even if that push is forced. This configuration variable is | |
796 | set when initializing a shared repository. | |
797 | ||
e28714c5 JH |
798 | transfer.unpackLimit:: |
799 | When `fetch.unpackLimit` or `receive.unpackLimit` are | |
800 | not set, the value of this variable is used instead. |