]>
Commit | Line | Data |
---|---|---|
1ab661dd PB |
1 | CONFIGURATION FILE |
2 | ------------------ | |
3 | ||
2de9b711 TA |
4 | The Git configuration file contains a number of variables that affect |
5 | the Git commands' behavior. The `.git/config` file in each repository | |
66e35fcb SB |
6 | is used to store the configuration for that repository, and |
7 | `$HOME/.gitconfig` is used to store a per-user configuration as | |
773002a7 | 8 | fallback values for the `.git/config` file. The file `/etc/gitconfig` |
66e35fcb | 9 | can be used to store a system-wide default configuration. |
5ea5621f | 10 | |
2de9b711 | 11 | The configuration variables are used by both the Git plumbing |
b7ee2266 SB |
12 | and the porcelains. The variables are divided into sections, wherein |
13 | the fully qualified variable name of the variable itself is the last | |
1ab661dd | 14 | dot-separated segment and the section name is everything before the last |
e0a4aae8 LP |
15 | dot. The variable names are case-insensitive, allow only alphanumeric |
16 | characters and `-`, and must start with an alphabetic character. Some | |
a5285b6c JH |
17 | variables may appear multiple times; we say then that the variable is |
18 | multivalued. | |
1ab661dd | 19 | |
e136f33b JN |
20 | Syntax |
21 | ~~~~~~ | |
22 | ||
1ab661dd | 23 | The syntax is fairly flexible and permissive; whitespaces are mostly |
e136f33b JN |
24 | ignored. The '#' and ';' characters begin comments to the end of line, |
25 | blank lines are ignored. | |
26 | ||
27 | The file consists of sections and variables. A section begins with | |
28 | the name of the section in square brackets and continues until the next | |
05c3e5c7 | 29 | section begins. Section names are case-insensitive. Only alphanumeric |
dcb11263 | 30 | characters, `-` and `.` are allowed in section names. Each variable |
773002a7 SB |
31 | must belong to some section, which means that there must be a section |
32 | header before the first setting of a variable. | |
e136f33b JN |
33 | |
34 | Sections can be further divided into subsections. To begin a subsection | |
35 | put its name in double quotes, separated by space from the section name, | |
773002a7 | 36 | in the section header, like in the example below: |
e136f33b JN |
37 | |
38 | -------- | |
39 | [section "subsection"] | |
40 | ||
41 | -------- | |
42 | ||
b7ee2266 | 43 | Subsection names are case sensitive and can contain any characters except |
1feb0617 DB |
44 | newline and the null byte. Doublequote `"` and backslash can be included |
45 | by escaping them as `\"` and `\\`, respectively. Backslashes preceding | |
46 | other characters are dropped when reading; for example, `\t` is read as | |
47 | `t` and `\0` is read as `0` Section headers cannot span multiple lines. | |
48 | Variables may belong directly to a section or to a given subsection. You | |
49 | can have `[section]` if you have `[section "subsection"]`, but you don't | |
50 | need to. | |
e136f33b | 51 | |
f7376329 CMN |
52 | There is also a deprecated `[section.subsection]` syntax. With this |
53 | syntax, the subsection name is converted to lower-case and is also | |
54 | compared case sensitively. These subsection names follow the same | |
55 | restrictions as section names. | |
e136f33b | 56 | |
2ceb639f NS |
57 | All the other lines (and the remainder of the line after the section |
58 | header) are recognized as setting variables, in the form | |
1c448b3b JH |
59 | 'name = value' (or just 'name', which is a short-hand to say that |
60 | the variable is the boolean "true"). | |
e0a4aae8 | 61 | The variable names are case-insensitive, allow only alphanumeric characters |
a5285b6c | 62 | and `-`, and must start with an alphabetic character. |
e136f33b | 63 | |
ff5507ed JH |
64 | A line that defines a value can be continued to the next line by |
65 | ending it with a `\`; the backquote and the end-of-line are | |
66 | stripped. Leading whitespaces after 'name =', the remainder of the | |
67 | line after the first comment character '#' or ';', and trailing | |
68 | whitespaces of the line are discarded unless they are enclosed in | |
69 | double quotes. Internal whitespaces within the value are retained | |
70 | verbatim. | |
e136f33b | 71 | |
ff5507ed JH |
72 | Inside double quotes, double quote `"` and backslash `\` characters |
73 | must be escaped: use `\"` for `"` and `\\` for `\`. | |
e136f33b | 74 | |
dcb11263 CJ |
75 | The following escape sequences (beside `\"` and `\\`) are recognized: |
76 | `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) | |
a58088ab JL |
77 | and `\b` for backspace (BS). Other char escape sequences (including octal |
78 | escape sequences) are invalid. | |
e136f33b | 79 | |
1ab661dd | 80 | |
9b25a0b5 JK |
81 | Includes |
82 | ~~~~~~~~ | |
83 | ||
9d71d94d JK |
84 | The `include` and `includeIf` sections allow you to include config |
85 | directives from another source. These sections behave identically to | |
86 | each other with the exception that `includeIf` sections may be ignored | |
87 | if their condition does not evaluate to true; see "Conditional includes" | |
88 | below. | |
89 | ||
df0233be | 90 | You can include a config file from another by setting the special |
9d71d94d JK |
91 | `include.path` (or `includeIf.*.path`) variable to the name of the file |
92 | to be included. The variable takes a pathname as its value, and is | |
93 | subject to tilde expansion. These variables can be given multiple times. | |
dca83abd | 94 | |
a076df28 JK |
95 | The contents of the included file are inserted immediately, as if they |
96 | had been found at the location of the include directive. If the value of the | |
9d71d94d | 97 | variable is a relative path, the path is considered to |
1050e987 NTND |
98 | be relative to the configuration file in which the include directive |
99 | was found. See below for examples. | |
dca83abd | 100 | |
3efd0bed NTND |
101 | Conditional includes |
102 | ~~~~~~~~~~~~~~~~~~~~ | |
103 | ||
104 | You can include a config file from another conditionally by setting a | |
105 | `includeIf.<condition>.path` variable to the name of the file to be | |
9d71d94d | 106 | included. |
3efd0bed NTND |
107 | |
108 | The condition starts with a keyword followed by a colon and some data | |
109 | whose format and meaning depends on the keyword. Supported keywords | |
110 | are: | |
111 | ||
112 | `gitdir`:: | |
113 | ||
114 | The data that follows the keyword `gitdir:` is used as a glob | |
115 | pattern. If the location of the .git directory matches the | |
116 | pattern, the include condition is met. | |
117 | + | |
118 | The .git location may be auto-discovered, or come from `$GIT_DIR` | |
119 | environment variable. If the repository is auto discovered via a .git | |
120 | file (e.g. from submodules, or a linked worktree), the .git location | |
121 | would be the final location where the .git directory is, not where the | |
122 | .git file is. | |
123 | + | |
124 | The pattern can contain standard globbing wildcards and two additional | |
125 | ones, `**/` and `/**`, that can match multiple path components. Please | |
126 | refer to linkgit:gitignore[5] for details. For convenience: | |
127 | ||
128 | * If the pattern starts with `~/`, `~` will be substituted with the | |
129 | content of the environment variable `HOME`. | |
130 | ||
131 | * If the pattern starts with `./`, it is replaced with the directory | |
132 | containing the current config file. | |
133 | ||
134 | * If the pattern does not start with either `~/`, `./` or `/`, `**/` | |
135 | will be automatically prepended. For example, the pattern `foo/bar` | |
136 | becomes `**/foo/bar` and would match `/any/path/to/foo/bar`. | |
137 | ||
138 | * If the pattern ends with `/`, `**` will be automatically added. For | |
139 | example, the pattern `foo/` becomes `foo/**`. In other words, it | |
140 | matches "foo" and everything inside, recursively. | |
141 | ||
142 | `gitdir/i`:: | |
143 | This is the same as `gitdir` except that matching is done | |
144 | case-insensitively (e.g. on case-insensitive file sytems) | |
145 | ||
146 | A few more notes on matching via `gitdir` and `gitdir/i`: | |
147 | ||
148 | * Symlinks in `$GIT_DIR` are not resolved before matching. | |
149 | ||
0624c63c ÆAB |
150 | * Both the symlink & realpath versions of paths will be matched |
151 | outside of `$GIT_DIR`. E.g. if ~/git is a symlink to | |
152 | /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git` | |
153 | will match. | |
154 | + | |
155 | This was not the case in the initial release of this feature in | |
156 | v2.13.0, which only matched the realpath version. Configuration that | |
157 | wants to be compatible with the initial release of this feature needs | |
158 | to either specify only the realpath version, or both versions. | |
159 | ||
3efd0bed NTND |
160 | * Note that "../" is not special and will match literally, which is |
161 | unlikely what you want. | |
9b25a0b5 | 162 | |
1ab661dd PB |
163 | Example |
164 | ~~~~~~~ | |
165 | ||
166 | # Core variables | |
167 | [core] | |
168 | ; Don't trust file modes | |
169 | filemode = false | |
170 | ||
171 | # Our diff algorithm | |
172 | [diff] | |
6bb9e51b | 173 | external = /usr/local/bin/diff-wrapper |
1ab661dd PB |
174 | renames = true |
175 | ||
910c00c8 AK |
176 | [branch "devel"] |
177 | remote = origin | |
178 | merge = refs/heads/devel | |
179 | ||
e136f33b JN |
180 | # Proxy settings |
181 | [core] | |
29093c28 | 182 | gitProxy="ssh" for "kernel.org" |
e136f33b | 183 | gitProxy=default-proxy ; for the rest |
910c00c8 | 184 | |
9b25a0b5 JK |
185 | [include] |
186 | path = /path/to/foo.inc ; include by absolute path | |
ce933ebd JK |
187 | path = foo.inc ; find "foo.inc" relative to the current file |
188 | path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory | |
9b25a0b5 | 189 | |
3efd0bed NTND |
190 | ; include if $GIT_DIR is /path/to/foo/.git |
191 | [includeIf "gitdir:/path/to/foo/.git"] | |
192 | path = /path/to/foo.inc | |
193 | ||
194 | ; include for all repositories inside /path/to/group | |
195 | [includeIf "gitdir:/path/to/group/"] | |
196 | path = /path/to/foo.inc | |
197 | ||
198 | ; include for all repositories inside $HOME/to/group | |
199 | [includeIf "gitdir:~/to/group/"] | |
200 | path = /path/to/foo.inc | |
5f7b91ba | 201 | |
994cd6c7 JK |
202 | ; relative paths are always relative to the including |
203 | ; file (if the condition is true); their location is not | |
204 | ; affected by the condition | |
205 | [includeIf "gitdir:/path/to/group/"] | |
206 | path = foo.inc | |
207 | ||
5f7b91ba JH |
208 | Values |
209 | ~~~~~~ | |
210 | ||
211 | Values of many variables are treated as a simple string, but there | |
212 | are variables that take values of specific types and there are rules | |
213 | as to how to spell them. | |
214 | ||
215 | boolean:: | |
216 | ||
217 | When a variable is said to take a boolean value, many | |
218 | synonyms are accepted for 'true' and 'false'; these are all | |
219 | case-insensitive. | |
220 | ||
7f0a02be AH |
221 | true;; Boolean true literals are `yes`, `on`, `true`, |
222 | and `1`. Also, a variable defined without `= <value>` | |
5f7b91ba JH |
223 | is taken as true. |
224 | ||
7f0a02be AH |
225 | false;; Boolean false literals are `no`, `off`, `false`, |
226 | `0` and the empty string. | |
5f7b91ba | 227 | + |
ed3bb3df | 228 | When converting a value to its canonical form using the `--type=bool` type |
7f0a02be | 229 | specifier, 'git config' will ensure that the output is "true" or |
5f7b91ba JH |
230 | "false" (spelled in lowercase). |
231 | ||
232 | integer:: | |
233 | The value for many variables that specify various sizes can | |
234 | be suffixed with `k`, `M`,... to mean "scale the number by | |
235 | 1024", "by 1024x1024", etc. | |
236 | ||
b92c1a28 | 237 | color:: |
adb33566 JK |
238 | The value for a variable that takes a color is a list of |
239 | colors (at most two, one for foreground and one for background) | |
240 | and attributes (as many as you want), separated by spaces. | |
5f456b3c | 241 | + |
adb33566 JK |
242 | The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`, |
243 | `blue`, `magenta`, `cyan` and `white`. The first color given is the | |
244 | foreground; the second is the background. | |
5ee87585 | 245 | + |
adb33566 JK |
246 | Colors may also be given as numbers between 0 and 255; these use ANSI |
247 | 256-color mode (but note that not all terminals may support this). If | |
248 | your terminal supports it, you may also specify 24-bit RGB values as | |
249 | hex, like `#ff0ab3`. | |
250 | + | |
9dc3515c JK |
251 | The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`, |
252 | `italic`, and `strike` (for crossed-out or "strikethrough" letters). | |
253 | The position of any attributes with respect to the colors | |
54590a0e JK |
254 | (before, after, or in between), doesn't matter. Specific attributes may |
255 | be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, | |
256 | `no-ul`, etc). | |
adb33566 | 257 | + |
512aba26 JK |
258 | An empty color string produces no color effect at all. This can be used |
259 | to avoid coloring specific elements without disabling color entirely. | |
260 | + | |
adb33566 JK |
261 | For git's pre-defined color slots, the attributes are meant to be reset |
262 | at the beginning of each item in the colored output. So setting | |
263 | `color.decorate.branch` to `black` will paint that branch name in a | |
264 | plain `black`, even if the previous thing on the same output line (e.g. | |
265 | opening parenthesis before the list of branch names in `log --decorate` | |
266 | output) is set to be painted with `bold` or some other attribute. | |
267 | However, custom log formats may do more complicated and layered | |
268 | coloring, and the negated forms may be useful there. | |
b92c1a28 | 269 | |
dca83abd JH |
270 | pathname:: |
271 | A variable that takes a pathname value can be given a | |
272 | string that begins with "`~/`" or "`~user/`", and the usual | |
273 | tilde expansion happens to such a string: `~/` | |
274 | is expanded to the value of `$HOME`, and `~user/` to the | |
275 | specified user's home directory. | |
276 | ||
5f7b91ba | 277 | |
1ab661dd PB |
278 | Variables |
279 | ~~~~~~~~~ | |
280 | ||
281 | Note that this list is non-comprehensive and not necessarily complete. | |
b8936cf0 | 282 | For command-specific variables, you will find a more detailed description |
93728b23 CA |
283 | in the appropriate manual page. |
284 | ||
285 | Other git-related tools may and do use their own variables. When | |
286 | inventing new variables for use in your own tool, make sure their | |
287 | names do not conflict with those that are used by Git itself and | |
288 | other popular tools, and describe them in your documentation. | |
289 | ||
838ef420 | 290 | include::config/advice.txt[] |
75194438 | 291 | |
1a394fa9 | 292 | include::config/core.txt[] |
dce96489 | 293 | |
29120d8e | 294 | include::config/add.txt[] |
13bd2134 | 295 | |
f740c8f1 | 296 | include::config/alias.txt[] |
dfd42a3c | 297 | |
d293ffef | 298 | include::config/am.txt[] |
e97a5e76 | 299 | |
696d4796 | 300 | include::config/apply.txt[] |
1ab661dd | 301 | |
d09467b6 | 302 | include::config/blame.txt[] |
8578037b | 303 | |
7273b95d | 304 | include::config/branch.txt[] |
a5ba2cbe | 305 | |
6b0b9740 | 306 | include::config/browser.txt[] |
584627b4 | 307 | |
9140b410 | 308 | include::config/checkout.txt[] |
fa655d84 | 309 | |
328e629c | 310 | include::config/clean.txt[] |
2122591b | 311 | |
0a7839e3 | 312 | include::config/color.txt[] |
6b2f2d98 | 313 | |
dbfc949f | 314 | include::config/column.txt[] |
d96e3c15 | 315 | |
5453d236 | 316 | include::config/commit.txt[] |
aaab8420 | 317 | |
3a49be6d | 318 | include::config/credential.txt[] |
7f4d4746 | 319 | |
2b4b7305 | 320 | include::config/completion.txt[] |
6532f374 | 321 | |
fa922d74 | 322 | include::config/diff.txt[] |
afcbc8e7 | 323 | |
9155f6f6 | 324 | include::config/difftool.txt[] |
a904392e | 325 | |
f2e58246 | 326 | include::config/fastimport.txt[] |
d9545c7f | 327 | |
561fda20 | 328 | include::config/fetch.txt[] |
42cc7485 | 329 | |
ab14f494 | 330 | include::config/format.txt[] |
bb52995f | 331 | |
734dfebb | 332 | include::config/filter.txt[] |
26488f59 | 333 | |
f80ccccb | 334 | include::config/fsck.txt[] |
1335f732 | 335 | |
8daf3271 | 336 | include::config/gc.txt[] |
48c32424 | 337 | |
996f66eb | 338 | include::config/gitcvs.txt[] |
04752868 | 339 | |
0648b769 | 340 | include::config/gitweb.txt[] |
cd82323f | 341 | |
434e6e75 | 342 | include::config/grep.txt[] |
ecd9ba61 | 343 | |
ea555d04 | 344 | include::config/gpg.txt[] |
b02f51b1 | 345 | |
d864cf8b | 346 | include::config/gui.txt[] |
a2df1fb2 | 347 | |
2c31a830 | 348 | include::config/guitool.txt[] |
390c3480 | 349 | |
d3df4270 | 350 | include::config/help.txt[] |
b1f809d0 | 351 | |
ad308479 | 352 | include::config/http.txt[] |
6a56993b | 353 | |
8fc3f75f | 354 | include::config/i18n.txt[] |
d2c11a38 | 355 | |
ae461026 | 356 | include::config/imap.txt[] |
b0f34c3d | 357 | |
c1b342ad | 358 | include::config/index.txt[] |
3c09d684 | 359 | |
ec335607 | 360 | include::config/init.txt[] |
d8a8488d | 361 | |
cef9b951 | 362 | include::config/instaweb.txt[] |
983a9eeb | 363 | |
630c2738 | 364 | include::config/interactive.txt[] |
01143847 | 365 | |
83009762 | 366 | include::config/log.txt[] |
e6bb5f78 | 367 | |
55e51cd7 | 368 | include::config/mailinfo.txt[] |
d5c4b185 | 369 | |
4a9f0c52 | 370 | include::config/mailmap.txt[] |
08610900 | 371 | |
b5578f33 | 372 | man.viewer:: |
b8322ea8 | 373 | Specify the programs that may be used to display help in the |
b5578f33 CC |
374 | 'man' format. See linkgit:git-help[1]. |
375 | ||
0bb64009 CC |
376 | man.<tool>.cmd:: |
377 | Specify the command to invoke the specified man viewer. The | |
378 | specified command is evaluated in shell with the man page | |
379 | passed as argument. (See linkgit:git-help[1].) | |
380 | ||
7e8114c0 CC |
381 | man.<tool>.path:: |
382 | Override the path for the given tool that may be used to | |
383 | display help in the 'man' format. See linkgit:git-help[1]. | |
384 | ||
b0f34c3d | 385 | include::merge-config.txt[] |
b5412484 | 386 | |
77680caa JS |
387 | mergetool.<tool>.path:: |
388 | Override the path for the given tool. This is useful in case | |
389 | your tool is not in the PATH. | |
390 | ||
964473a0 CB |
391 | mergetool.<tool>.cmd:: |
392 | Specify the command to invoke the specified merge tool. The | |
393 | specified command is evaluated in shell with the following | |
394 | variables available: 'BASE' is the name of a temporary file | |
395 | containing the common base of the files to be merged, if available; | |
396 | 'LOCAL' is the name of a temporary file containing the contents of | |
397 | the file on the current branch; 'REMOTE' is the name of a temporary | |
398 | file containing the contents of the file from the branch being | |
399 | merged; 'MERGED' contains the name of the file to which the merge | |
400 | tool should write the results of a successful merge. | |
401 | ||
402 | mergetool.<tool>.trustExitCode:: | |
403 | For a custom merge command, specify whether the exit code of | |
404 | the merge command can be used to determine whether the merge was | |
405 | successful. If this is not set to true then the merge target file | |
406 | timestamp is checked and the merge assumed to have been successful | |
407 | if the file has been updated, otherwise the user is prompted to | |
408 | indicate the success of the merge. | |
409 | ||
b12d0450 DA |
410 | mergetool.meld.hasOutput:: |
411 | Older versions of `meld` do not support the `--output` option. | |
412 | Git will attempt to detect whether `meld` supports `--output` | |
413 | by inspecting the output of `meld --help`. Configuring | |
414 | `mergetool.meld.hasOutput` will make Git skip these checks and | |
415 | use the configured value instead. Setting `mergetool.meld.hasOutput` | |
416 | to `true` tells Git to unconditionally use the `--output` option, | |
417 | and `false` avoids using `--output`. | |
418 | ||
44c36d1c CB |
419 | mergetool.keepBackup:: |
420 | After performing a merge, the original file with conflict markers | |
421 | can be saved as a file with a `.orig` extension. If this variable | |
422 | is set to `false` then this file is not preserved. Defaults to | |
423 | `true` (i.e. keep the backup files). | |
424 | ||
162eba8b | 425 | mergetool.keepTemporaries:: |
2de9b711 | 426 | When invoking a custom merge tool, Git uses a set of temporary |
162eba8b CB |
427 | files to pass to the tool. If the tool returns an error and this |
428 | variable is set to `true`, then these temporary files will be | |
429 | preserved, otherwise they will be removed after the tool has | |
430 | exited. Defaults to `false`. | |
431 | ||
8f0cb41d DA |
432 | mergetool.writeToTemp:: |
433 | Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of | |
434 | conflicting files in the worktree by default. Git will attempt | |
435 | to use a temporary directory for these files when set `true`. | |
436 | Defaults to `false`. | |
437 | ||
682b451f CB |
438 | mergetool.prompt:: |
439 | Prompt before each invocation of the merge resolution program. | |
440 | ||
d2d68d99 JK |
441 | notes.mergeStrategy:: |
442 | Which merge strategy to choose by default when resolving notes | |
443 | conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or | |
444 | `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES" | |
445 | section of linkgit:git-notes[1] for more information on each strategy. | |
446 | ||
4f655e22 JK |
447 | notes.<name>.mergeStrategy:: |
448 | Which merge strategy to choose when doing a notes merge into | |
449 | refs/notes/<name>. This overrides the more general | |
450 | "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in | |
451 | linkgit:git-notes[1] for more information on the available strategies. | |
452 | ||
894a9d33 TR |
453 | notes.displayRef:: |
454 | The (fully qualified) refname from which to show notes when | |
455 | showing commit messages. The value of this variable can be set | |
456 | to a glob, in which case notes from all matching refs will be | |
457 | shown. You may also specify this configuration variable | |
458 | several times. A warning will be issued for refs that do not | |
459 | exist, but a glob that does not match any refs is silently | |
460 | ignored. | |
461 | + | |
462 | This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` | |
463 | environment variable, which must be a colon separated list of refs or | |
464 | globs. | |
465 | + | |
466 | The effective value of "core.notesRef" (possibly overridden by | |
467 | GIT_NOTES_REF) is also implicitly added to the list of refs to be | |
468 | displayed. | |
469 | ||
6956f858 TR |
470 | notes.rewrite.<command>:: |
471 | When rewriting commits with <command> (currently `amend` or | |
2de9b711 | 472 | `rebase`) and this variable is set to `true`, Git |
6956f858 TR |
473 | automatically copies your notes from the original to the |
474 | rewritten commit. Defaults to `true`, but see | |
475 | "notes.rewriteRef" below. | |
6956f858 TR |
476 | |
477 | notes.rewriteMode:: | |
478 | When copying notes during a rewrite (see the | |
479 | "notes.rewrite.<command>" option), determines what to do if | |
480 | the target commit already has a note. Must be one of | |
e48ad1b9 JK |
481 | `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`. |
482 | Defaults to `concatenate`. | |
6956f858 TR |
483 | + |
484 | This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` | |
485 | environment variable. | |
486 | ||
487 | notes.rewriteRef:: | |
488 | When copying notes during a rewrite, specifies the (fully | |
489 | qualified) ref whose notes should be copied. The ref may be a | |
490 | glob, in which case notes in all matching refs will be copied. | |
491 | You may also specify this configuration several times. | |
492 | + | |
493 | Does not have a default value; you must configure this variable to | |
2b4aa89c TR |
494 | enable note rewriting. Set it to `refs/notes/commits` to enable |
495 | rewriting for the default commit notes. | |
cfb88e9a LAS |
496 | + |
497 | This setting can be overridden with the `GIT_NOTES_REWRITE_REF` | |
498 | environment variable, which must be a colon separated list of refs or | |
499 | globs. | |
6956f858 | 500 | |
4812a93a | 501 | pack.window:: |
5162e697 | 502 | The size of the window used by linkgit:git-pack-objects[1] when no |
4812a93a JK |
503 | window size is given on the command line. Defaults to 10. |
504 | ||
842aaf93 | 505 | pack.depth:: |
5162e697 | 506 | The maximum delta depth used by linkgit:git-pack-objects[1] when no |
618e613a | 507 | maximum depth is given on the command line. Defaults to 50. |
b5c0cbd8 | 508 | Maximum value is 4095. |
842aaf93 | 509 | |
e93b15cd | 510 | pack.windowMemory:: |
f4694a8c RB |
511 | The maximum size of memory that is consumed by each thread |
512 | in linkgit:git-pack-objects[1] for pack window memory when | |
513 | no limit is given on the command line. The value can be | |
514 | suffixed with "k", "m", or "g". When left unconfigured (or | |
515 | set explicitly to 0), there will be no limit. | |
e93b15cd | 516 | |
960ccca6 DH |
517 | pack.compression:: |
518 | An integer -1..9, indicating the compression level for objects | |
519 | in a pack file. -1 is the zlib default. 0 means no | |
520 | compression, and 1..9 are various speed/size tradeoffs, 9 being | |
521 | slowest. If not set, defaults to core.compression. If that is | |
dec92309 BD |
522 | not set, defaults to -1, the zlib default, which is "a default |
523 | compromise between speed and compression (currently equivalent | |
524 | to level 6)." | |
89d71f75 JK |
525 | + |
526 | Note that changing the compression level will not automatically recompress | |
527 | all existing objects. You can force recompression by passing the -F option | |
528 | to linkgit:git-repack[1]. | |
960ccca6 | 529 | |
28b8a730 JK |
530 | pack.island:: |
531 | An extended regular expression configuring a set of delta | |
532 | islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1] | |
533 | for details. | |
534 | ||
535 | pack.islandCore:: | |
536 | Specify an island name which gets to have its objects be | |
537 | packed first. This creates a kind of pseudo-pack at the front | |
538 | of one pack, so that the objects from the specified island are | |
539 | hopefully faster to copy into any pack that should be served | |
540 | to a user requesting these objects. In practice this means | |
541 | that the island specified should likely correspond to what is | |
542 | the most commonly cloned in the repo. See also "DELTA ISLANDS" | |
543 | in linkgit:git-pack-objects[1]. | |
544 | ||
074b2eea | 545 | pack.deltaCacheSize:: |
02783075 | 546 | The maximum memory in bytes used for caching deltas in |
5749b0b2 NP |
547 | linkgit:git-pack-objects[1] before writing them out to a pack. |
548 | This cache is used to speed up the writing object phase by not | |
549 | having to recompute the final delta result once the best match | |
550 | for all objects is found. Repacking large repositories on machines | |
551 | which are tight with memory might be badly impacted by this though, | |
552 | especially if this cache pushes the system into swapping. | |
553 | A value of 0 means no limit. The smallest size of 1 byte may be | |
554 | used to virtually disable this cache. Defaults to 256 MiB. | |
074b2eea | 555 | |
e3dfddb3 | 556 | pack.deltaCacheLimit:: |
693b86ff | 557 | The maximum size of a delta, that is cached in |
5749b0b2 NP |
558 | linkgit:git-pack-objects[1]. This cache is used to speed up the |
559 | writing object phase by not having to recompute the final delta | |
0cb3c142 NTND |
560 | result once the best match for all objects is found. |
561 | Defaults to 1000. Maximum value is 65535. | |
e3dfddb3 | 562 | |
693b86ff NP |
563 | pack.threads:: |
564 | Specifies the number of threads to spawn when searching for best | |
5162e697 | 565 | delta matches. This requires that linkgit:git-pack-objects[1] |
693b86ff NP |
566 | be compiled with pthreads otherwise this option is ignored with a |
567 | warning. This is meant to reduce packing time on multiprocessor | |
568 | machines. The required amount of memory for the delta search window | |
569 | is however multiplied by the number of threads. | |
2de9b711 | 570 | Specifying 0 will cause Git to auto-detect the number of CPU's |
833e3df1 | 571 | and set the number of threads accordingly. |
693b86ff | 572 | |
4d00bda2 NP |
573 | pack.indexVersion:: |
574 | Specify the default pack index version. Valid values are 1 for | |
575 | legacy pack index used by Git versions prior to 1.5.2, and 2 for | |
576 | the new pack index with capabilities for packs larger than 4 GB | |
577 | as well as proper protection against the repacking of corrupted | |
c0a5e2d4 NP |
578 | packs. Version 2 is the default. Note that version 2 is enforced |
579 | and this config option ignored whenever the corresponding pack is | |
580 | larger than 2 GB. | |
581 | + | |
2de9b711 | 582 | If you have an old Git that does not understand the version 2 `*.idx` file, |
0d0bac67 | 583 | cloning or fetching over a non native protocol (e.g. "http") |
6cf378f0 | 584 | that will copy both `*.pack` file and corresponding `*.idx` file from the |
c0a5e2d4 | 585 | other side may give you a repository that cannot be accessed with your |
2de9b711 | 586 | older version of Git. If the `*.pack` file is smaller than 2 GB, however, |
c0a5e2d4 | 587 | you can use linkgit:git-index-pack[1] on the *.pack file to regenerate |
6cf378f0 | 588 | the `*.idx` file. |
4d00bda2 | 589 | |
dbdbfec4 | 590 | pack.packSizeLimit:: |
07cf0f24 NP |
591 | The maximum size of a pack. This setting only affects |
592 | packing to a file when repacking, i.e. the git:// protocol | |
6cf378f0 | 593 | is unaffected. It can be overridden by the `--max-pack-size` |
9cea46cd EW |
594 | option of linkgit:git-repack[1]. Reaching this limit results |
595 | in the creation of multiple packfiles; which in turn prevents | |
596 | bitmaps from being created. | |
597 | The minimum size allowed is limited to 1 MiB. | |
598 | The default is unlimited. | |
07cf0f24 NP |
599 | Common unit suffixes of 'k', 'm', or 'g' are |
600 | supported. | |
2b84b5a8 | 601 | |
6b8fda2d VM |
602 | pack.useBitmaps:: |
603 | When true, git will use pack bitmaps (if available) when packing | |
604 | to stdout (e.g., during the server side of a fetch). Defaults to | |
605 | true. You should not generally need to turn this off unless | |
606 | you are debugging pack bitmaps. | |
607 | ||
da0005b8 | 608 | pack.writeBitmaps (deprecated):: |
71d76cb4 | 609 | This is a deprecated synonym for `repack.writeBitmaps`. |
7cc8f971 | 610 | |
ae4f07fb VM |
611 | pack.writeBitmapHashCache:: |
612 | When true, git will include a "hash cache" section in the bitmap | |
613 | index (if one is written). This cache can be used to feed git's | |
614 | delta heuristics, potentially leading to better deltas between | |
615 | bitmapped and non-bitmapped objects (e.g., when serving a fetch | |
616 | between an older, bitmapped pack and objects that have been | |
617 | pushed since the last gc). The downside is that it consumes 4 | |
618 | bytes per object of disk space, and that JGit's bitmap | |
619 | implementation does not understand it, causing it to complain if | |
620 | Git and JGit are used on the same repository. Defaults to false. | |
621 | ||
4370c2d6 | 622 | pager.<cmd>:: |
9bad7233 | 623 | If the value is boolean, turns on or off pagination of the |
2de9b711 | 624 | output of a particular Git subcommand when writing to a tty. |
9bad7233 | 625 | Otherwise, turns on pagination for the subcommand using the |
6cf378f0 JK |
626 | pager specified by the value of `pager.<cmd>`. If `--paginate` |
627 | or `--no-pager` is specified on the command line, it takes | |
9bad7233 JK |
628 | precedence over this option. To disable pagination for all |
629 | commands, set `core.pager` or `GIT_PAGER` to `cat`. | |
4370c2d6 | 630 | |
8028184e WP |
631 | pretty.<name>:: |
632 | Alias for a --pretty= format string, as specified in | |
633 | linkgit:git-log[1]. Any aliases defined here can be used just | |
634 | as the built-in pretty formats could. For example, | |
6cf378f0 | 635 | running `git config pretty.changelog "format:* %H %s"` |
8028184e | 636 | would cause the invocation `git log --pretty=changelog` |
6cf378f0 | 637 | to be equivalent to running `git log "--pretty=format:* %H %s"`. |
8028184e WP |
638 | Note that an alias with the same name as a built-in format |
639 | will be silently ignored. | |
640 | ||
f1762d77 BW |
641 | protocol.allow:: |
642 | If set, provide a user defined default policy for all protocols which | |
643 | don't explicitly have a policy (`protocol.<name>.allow`). By default, | |
644 | if unset, known-safe protocols (http, https, git, ssh, file) have a | |
645 | default policy of `always`, known-dangerous protocols (ext) have a | |
646 | default policy of `never`, and all other protocols have a default | |
647 | policy of `user`. Supported policies: | |
648 | + | |
649 | -- | |
650 | ||
651 | * `always` - protocol is always able to be used. | |
652 | ||
653 | * `never` - protocol is never able to be used. | |
654 | ||
655 | * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is | |
656 | either unset or has a value of 1. This policy should be used when you want a | |
657 | protocol to be directly usable by the user but don't want it used by commands which | |
658 | execute clone/fetch/push commands without user input, e.g. recursive | |
659 | submodule initialization. | |
660 | ||
661 | -- | |
662 | ||
663 | protocol.<name>.allow:: | |
664 | Set a policy to be used by protocol `<name>` with clone/fetch/push | |
665 | commands. See `protocol.allow` above for the available policies. | |
666 | + | |
667 | The protocol names currently used by git are: | |
668 | + | |
669 | -- | |
670 | - `file`: any local file-based path (including `file://` URLs, | |
671 | or local paths) | |
672 | ||
673 | - `git`: the anonymous git protocol over a direct TCP | |
674 | connection (or proxy, if configured) | |
675 | ||
676 | - `ssh`: git over ssh (including `host:path` syntax, | |
677 | `ssh://`, etc). | |
678 | ||
679 | - `http`: git over http, both "smart http" and "dumb http". | |
680 | Note that this does _not_ include `https`; if you want to configure | |
681 | both, you must do so individually. | |
682 | ||
683 | - any external helpers are named by their protocol (e.g., use | |
684 | `hg` to allow the `git-remote-hg` helper) | |
685 | -- | |
686 | ||
373d70ef BW |
687 | protocol.version:: |
688 | Experimental. If set, clients will attempt to communicate with a | |
689 | server using the specified protocol version. If unset, no | |
690 | attempt will be made by the client to communicate using a | |
691 | particular protocol version, this results in protocol version 0 | |
692 | being used. | |
693 | Supported versions: | |
694 | + | |
695 | -- | |
696 | ||
697 | * `0` - the original wire protocol. | |
698 | ||
699 | * `1` - the original wire protocol with the addition of a version string | |
700 | in the initial response from the server. | |
701 | ||
db2d36fa BW |
702 | * `2` - link:technical/protocol-v2.html[wire protocol version 2]. |
703 | ||
373d70ef BW |
704 | -- |
705 | ||
04750299 | 706 | include::pull-config.txt[] |
d8052750 | 707 | |
41b651d6 | 708 | include::push-config.txt[] |
b33a15b0 | 709 | |
946a9f20 | 710 | include::rebase-config.txt[] |
16cf51c7 | 711 | |
aaa3b458 | 712 | include::receive-config.txt[] |
0a1bc12b | 713 | |
da0005b8 | 714 | remote.pushDefault:: |
224c2171 | 715 | The remote to push to by default. Overrides |
9f765ce6 | 716 | `branch.<name>.remote` for all branches, and is overridden by |
da0005b8 | 717 | `branch.<name>.pushRemote` for specific branches. |
224c2171 | 718 | |
0cc6d346 | 719 | remote.<name>.url:: |
5162e697 DM |
720 | The URL of a remote repository. See linkgit:git-fetch[1] or |
721 | linkgit:git-push[1]. | |
0cc6d346 | 722 | |
20346234 MG |
723 | remote.<name>.pushurl:: |
724 | The push URL of a remote repository. See linkgit:git-push[1]. | |
725 | ||
14c98218 SV |
726 | remote.<name>.proxy:: |
727 | For remotes that require curl (http, https and ftp), the URL to | |
728 | the proxy to use for that remote. Set to the empty string to | |
729 | disable proxying for that remote. | |
730 | ||
ef976395 KF |
731 | remote.<name>.proxyAuthMethod:: |
732 | For remotes that require curl (http, https and ftp), the method to use for | |
733 | authenticating against the proxy in use (probably set in | |
734 | `remote.<name>.proxy`). See `http.proxyAuthMethod`. | |
735 | ||
0cc6d346 | 736 | remote.<name>.fetch:: |
5162e697 DM |
737 | The default set of "refspec" for linkgit:git-fetch[1]. See |
738 | linkgit:git-fetch[1]. | |
0cc6d346 SB |
739 | |
740 | remote.<name>.push:: | |
5162e697 DM |
741 | The default set of "refspec" for linkgit:git-push[1]. See |
742 | linkgit:git-push[1]. | |
0cc6d346 | 743 | |
84bb2dfd PB |
744 | remote.<name>.mirror:: |
745 | If true, pushing to this remote will automatically behave | |
6cf378f0 | 746 | as if the `--mirror` option was given on the command line. |
84bb2dfd | 747 | |
1918278e TT |
748 | remote.<name>.skipDefaultUpdate:: |
749 | If true, this remote will be skipped by default when updating | |
7cc91a2f BG |
750 | using linkgit:git-fetch[1] or the `update` subcommand of |
751 | linkgit:git-remote[1]. | |
752 | ||
753 | remote.<name>.skipFetchAll:: | |
754 | If true, this remote will be skipped by default when updating | |
755 | using linkgit:git-fetch[1] or the `update` subcommand of | |
756 | linkgit:git-remote[1]. | |
1918278e | 757 | |
060aafc1 | 758 | remote.<name>.receivepack:: |
5dee29ac | 759 | The default program to execute on the remote side when pushing. See |
1c262bb7 | 760 | option --receive-pack of linkgit:git-push[1]. |
060aafc1 | 761 | |
5dee29ac UKK |
762 | remote.<name>.uploadpack:: |
763 | The default program to execute on the remote side when fetching. See | |
1c262bb7 | 764 | option --upload-pack of linkgit:git-fetch-pack[1]. |
5dee29ac | 765 | |
da0005b8 | 766 | remote.<name>.tagOpt:: |
1c262bb7 JK |
767 | Setting this value to --no-tags disables automatic tag following when |
768 | fetching from remote <name>. Setting it to --tags will fetch every | |
944163a4 | 769 | tag from remote <name>, even if they are not reachable from remote |
ed368546 | 770 | branch heads. Passing these flags directly to linkgit:git-fetch[1] can |
1c262bb7 | 771 | override this setting. See options --tags and --no-tags of |
ed368546 | 772 | linkgit:git-fetch[1]. |
047f636d | 773 | |
c578f51d | 774 | remote.<name>.vcs:: |
2de9b711 | 775 | Setting this to a value <vcs> will cause Git to interact with |
c578f51d DB |
776 | the remote with the git-remote-<vcs> helper. |
777 | ||
737c5a9c MS |
778 | remote.<name>.prune:: |
779 | When set to true, fetching from this remote by default will also | |
0838bf47 MH |
780 | remove any remote-tracking references that no longer exist on the |
781 | remote (as if the `--prune` option was given on the command line). | |
737c5a9c MS |
782 | Overrides `fetch.prune` settings, if any. |
783 | ||
97716d21 ÆAB |
784 | remote.<name>.pruneTags:: |
785 | When set to true, fetching from this remote by default will also | |
786 | remove any local tags that no longer exist on the remote if pruning | |
787 | is activated in general via `remote.<name>.prune`, `fetch.prune` or | |
788 | `--prune`. Overrides `fetch.pruneTags` settings, if any. | |
627a129b ÆAB |
789 | + |
790 | See also `remote.<name>.prune` and the PRUNING section of | |
791 | linkgit:git-fetch[1]. | |
737c5a9c | 792 | |
1918278e TT |
793 | remotes.<group>:: |
794 | The list of remotes which are fetched by "git remote update | |
5162e697 | 795 | <group>". See linkgit:git-remote[1]. |
1918278e | 796 | |
da0005b8 | 797 | repack.useDeltaBaseOffset:: |
22c79eab NP |
798 | By default, linkgit:git-repack[1] creates packs that use |
799 | delta-base offset. If you need to share your repository with | |
2de9b711 | 800 | Git older than version 1.4.4, either directly or via a dumb |
22c79eab | 801 | protocol such as http, then you need to set this option to |
2de9b711 | 802 | "false" and repack. Access from old Git versions over the |
22c79eab | 803 | native protocol are unaffected by this option. |
b6945f57 | 804 | |
ee34a2be JK |
805 | repack.packKeptObjects:: |
806 | If set to true, makes `git repack` act as if | |
807 | `--pack-kept-objects` was passed. See linkgit:git-repack[1] for | |
808 | details. Defaults to `false` normally, but `true` if a bitmap | |
809 | index is being written (either via `--write-bitmap-index` or | |
71d76cb4 JK |
810 | `repack.writeBitmaps`). |
811 | ||
16d75fa4 JK |
812 | repack.useDeltaIslands:: |
813 | If set to true, makes `git repack` act as if `--delta-islands` | |
814 | was passed. Defaults to `false`. | |
815 | ||
71d76cb4 JK |
816 | repack.writeBitmaps:: |
817 | When true, git will write a bitmap index when packing all | |
818 | objects to disk (e.g., when `git repack -a` is run). This | |
819 | index can speed up the "counting objects" phase of subsequent | |
820 | packs created for clones and fetches, at the cost of some disk | |
9cea46cd EW |
821 | space and extra time spent on the initial repack. This has |
822 | no effect if multiple packfiles are created. | |
823 | Defaults to false. | |
ee34a2be | 824 | |
da0005b8 | 825 | rerere.autoUpdate:: |
b0f34c3d MM |
826 | When set to true, `git-rerere` updates the index with the |
827 | resulting contents after it cleanly resolves conflicts using | |
828 | previously recorded resolution. Defaults to false. | |
829 | ||
830 | rerere.enabled:: | |
831 | Activate recording of resolved conflicts, so that identical | |
07b88a00 TR |
832 | conflict hunks can be resolved automatically, should they be |
833 | encountered again. By default, linkgit:git-rerere[1] is | |
834 | enabled if there is an `rr-cache` directory under the | |
b6fb7fed JH |
835 | `$GIT_DIR`, e.g. if "rerere" was previously used in the |
836 | repository. | |
b0f34c3d | 837 | |
4c3abd05 BP |
838 | reset.quiet:: |
839 | When set to true, 'git reset' will default to the '--quiet' option. | |
840 | ||
701137ee | 841 | include::sendemail-config.txt[] |
5453b83b | 842 | |
8dc9d22d NTND |
843 | sequence.editor:: |
844 | Text editor used by `git rebase -i` for editing the rebase instruction file. | |
845 | The value is meant to be interpreted by the shell when it is used. | |
846 | It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. | |
847 | When not configured the default commit message editor is used instead. | |
848 | ||
8da2f489 | 849 | showBranch.default:: |
5162e697 DM |
850 | The default set of branches for linkgit:git-show-branch[1]. |
851 | See linkgit:git-show-branch[1]. | |
1ab661dd | 852 | |
e77cf4ee CC |
853 | splitIndex.maxPercentChange:: |
854 | When the split index feature is used, this specifies the | |
855 | percent of entries the split index can contain compared to the | |
856 | total number of entries in both the split index and the shared | |
857 | index before a new shared index is written. | |
858 | The value should be between 0 and 100. If the value is 0 then | |
859 | a new shared index is always written, if it is 100 a new | |
860 | shared index is never written. | |
861 | By default the value is 20, so a new shared index is written | |
862 | if the number of entries in the split index would be greater | |
863 | than 20 percent of the total number of entries. | |
864 | See linkgit:git-update-index[1]. | |
865 | ||
b2dd1c5c CC |
866 | splitIndex.sharedIndexExpire:: |
867 | When the split index feature is used, shared index files that | |
868 | were not modified since the time this variable specifies will | |
869 | be removed when a new shared index file is created. The value | |
870 | "now" expires all entries immediately, and "never" suppresses | |
871 | expiration altogether. | |
872 | The default value is "2.weeks.ago". | |
873 | Note that a shared index file is considered modified (for the | |
874 | purpose of expiration) each time a new split-index file is | |
b4601395 | 875 | either created based on it or read from it. |
b2dd1c5c CC |
876 | See linkgit:git-update-index[1]. |
877 | ||
12e60249 NTND |
878 | include::config/ssh.txt[] |
879 | ||
46f721c8 | 880 | status.relativePaths:: |
5162e697 | 881 | By default, linkgit:git-status[1] shows paths relative to the |
46f721c8 | 882 | current directory. Setting this variable to `false` shows paths |
2de9b711 | 883 | relative to the repository root (this was the default for Git |
46f721c8 JK |
884 | prior to v1.5.4). |
885 | ||
4fb5166a JJGG |
886 | status.short:: |
887 | Set to true to enable --short by default in linkgit:git-status[1]. | |
888 | The option --no-short takes precedence over this variable. | |
889 | ||
ec85d070 JJGG |
890 | status.branch:: |
891 | Set to true to enable --branch by default in linkgit:git-status[1]. | |
892 | The option --no-branch takes precedence over this variable. | |
893 | ||
2556b996 MM |
894 | status.displayCommentPrefix:: |
895 | If set to true, linkgit:git-status[1] will insert a comment | |
896 | prefix before each output line (starting with | |
897 | `core.commentChar`, i.e. `#` by default). This was the | |
898 | behavior of linkgit:git-status[1] in Git 1.8.4 and previous. | |
899 | Defaults to false. | |
900 | ||
e8b2dc2c BP |
901 | status.renameLimit:: |
902 | The number of files to consider when performing rename detection | |
903 | in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to | |
904 | the value of diff.renameLimit. | |
905 | ||
906 | status.renames:: | |
907 | Whether and how Git detects renames in linkgit:git-status[1] and | |
908 | linkgit:git-commit[1] . If set to "false", rename detection is | |
909 | disabled. If set to "true", basic rename detection is enabled. | |
910 | If set to "copies" or "copy", Git will detect copies, as well. | |
911 | Defaults to the value of diff.renames. | |
912 | ||
c1b5d019 LB |
913 | status.showStash:: |
914 | If set to true, linkgit:git-status[1] will display the number of | |
915 | entries currently stashed away. | |
916 | Defaults to false. | |
917 | ||
d6293d1f MSO |
918 | status.showUntrackedFiles:: |
919 | By default, linkgit:git-status[1] and linkgit:git-commit[1] show | |
920 | files which are not currently tracked by Git. Directories which | |
921 | contain only untracked files, are shown with the directory name | |
922 | only. Showing untracked files means that Git needs to lstat() all | |
71069cdf | 923 | the files in the whole repository, which might be slow on some |
d6293d1f MSO |
924 | systems. So, this variable controls how the commands displays |
925 | the untracked files. Possible values are: | |
926 | + | |
927 | -- | |
9373bdc4 CF |
928 | * `no` - Show no untracked files. |
929 | * `normal` - Show untracked files and directories. | |
930 | * `all` - Show also individual files in untracked directories. | |
d6293d1f MSO |
931 | -- |
932 | + | |
933 | If this variable is not specified, it defaults to 'normal'. | |
934 | This variable can be overridden with the -u|--untracked-files option | |
935 | of linkgit:git-status[1] and linkgit:git-commit[1]. | |
936 | ||
da0005b8 | 937 | status.submoduleSummary:: |
4b2343fa MG |
938 | Defaults to false. |
939 | If this is set to a non zero number or true (identical to -1 or an | |
940 | unlimited number), the submodule summary will be enabled and a | |
941 | summary of commits for modified submodules will be shown (see | |
bb58b696 JL |
942 | --summary-limit option of linkgit:git-submodule[1]). Please note |
943 | that the summary output command will be suppressed for all | |
944 | submodules when `diff.ignoreSubmodules` is set to 'all' or only | |
1d2f393a JL |
945 | for those submodules where `submodule.<name>.ignore=all`. The only |
946 | exception to that rule is that status and commit will show staged | |
947 | submodule changes. To | |
bb58b696 | 948 | also view the summary for ignored submodules you can either use |
06ab60c0 | 949 | the --ignore-submodules=dirty command-line option or the 'git |
bb58b696 JL |
950 | submodule summary' command, which shows a similar output but does |
951 | not honor these settings. | |
4b2343fa | 952 | |
3086c064 NK |
953 | stash.showPatch:: |
954 | If this is set to true, the `git stash show` command without an | |
e01db917 | 955 | option will show the stash entry in patch form. Defaults to false. |
3086c064 NK |
956 | See description of 'show' command in linkgit:git-stash[1]. |
957 | ||
958 | stash.showStat:: | |
959 | If this is set to true, the `git stash show` command without an | |
e01db917 | 960 | option will show diffstat of the stash entry. Defaults to true. |
3086c064 NK |
961 | See description of 'show' command in linkgit:git-stash[1]. |
962 | ||
6014363f | 963 | include::submodule-config.txt[] |
31224cbd | 964 | |
61c2fe0c LA |
965 | tag.forceSignAnnotated:: |
966 | A boolean to specify whether annotated tags created should be GPG signed. | |
967 | If `--annotate` is specified on the command line, it takes | |
968 | precedence over this option. | |
969 | ||
b150794d JK |
970 | tag.sort:: |
971 | This variable controls the sort ordering of tags when displayed by | |
972 | linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the | |
973 | value of this variable will be used as the default. | |
974 | ||
ce1a79b6 | 975 | tar.umask:: |
687157c7 RS |
976 | This variable can be used to restrict the permission bits of |
977 | tar archive entries. The default is 0002, which turns off the | |
978 | world write bit. The special value "user" indicates that the | |
979 | archiving user's umask will be used instead. See umask(2) and | |
5162e697 | 980 | linkgit:git-archive[1]. |
ce1a79b6 | 981 | |
dab76d3a JH |
982 | transfer.fsckObjects:: |
983 | When `fetch.fsckObjects` or `receive.fsckObjects` are | |
984 | not set, the value of this variable is used instead. | |
985 | Defaults to false. | |
5180dd2e ÆAB |
986 | + |
987 | When set, the fetch or receive will abort in the case of a malformed | |
456bab87 ÆAB |
988 | object or a link to a nonexistent object. In addition, various other |
989 | issues are checked for, including legacy issues (see `fsck.<msg-id>`), | |
990 | and potential security issues like the existence of a `.GIT` directory | |
991 | or a malicious `.gitmodules` file (see the release notes for v2.2.1 | |
992 | and v2.17.1 for details). Other sanity and security checks may be | |
993 | added in future releases. | |
994 | + | |
995 | On the receiving side, failing fsckObjects will make those objects | |
996 | unreachable, see "QUARANTINE ENVIRONMENT" in | |
997 | linkgit:git-receive-pack[1]. On the fetch side, malformed objects will | |
998 | instead be left unreferenced in the repository. | |
720dae5a ÆAB |
999 | + |
1000 | Due to the non-quarantine nature of the `fetch.fsckObjects` | |
1001 | implementation it can not be relied upon to leave the object store | |
1002 | clean like `receive.fsckObjects` can. | |
1003 | + | |
1004 | As objects are unpacked they're written to the object store, so there | |
1005 | can be cases where malicious objects get introduced even though the | |
1006 | "fetch" failed, only to have a subsequent "fetch" succeed because only | |
1007 | new incoming objects are checked, not those that have already been | |
1008 | written to the object store. That difference in behavior should not be | |
1009 | relied upon. In the future, such objects may be quarantined for | |
1010 | "fetch" as well. | |
1011 | + | |
1012 | For now, the paranoid need to find some way to emulate the quarantine | |
1013 | environment if they'd like the same protection as "push". E.g. in the | |
1014 | case of an internal mirror do the mirroring in two steps, one to fetch | |
1015 | the untrusted objects, and then do a second "push" (which will use the | |
1016 | quarantine) to another internal repo, and have internal clients | |
1017 | consume this pushed-to repository, or embargo internal fetches and | |
1018 | only allow them once a full "fsck" has run (and no new fetches have | |
1019 | happened in the meantime). | |
dab76d3a | 1020 | |
da0005b8 | 1021 | transfer.hideRefs:: |
cc118a65 JK |
1022 | String(s) `receive-pack` and `upload-pack` use to decide which |
1023 | refs to omit from their initial advertisements. Use more than | |
1024 | one definition to specify multiple prefix strings. A ref that is | |
1025 | under the hierarchies listed in the value of this variable is | |
1026 | excluded, and is hidden when responding to `git push` or `git | |
1027 | fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for | |
1028 | program-specific versions of this config. | |
2bc31d16 JK |
1029 | + |
1030 | You may also include a `!` in front of the ref name to negate the entry, | |
1031 | explicitly exposing it, even if an earlier entry marked it as hidden. | |
1032 | If you have multiple hideRefs values, later entries override earlier ones | |
1033 | (and entries in more-specific config files override less-specific ones). | |
92cab492 LF |
1034 | + |
1035 | If a namespace is in use, the namespace prefix is stripped from each | |
1036 | reference before it is matched against `transfer.hiderefs` patterns. | |
1037 | For example, if `refs/heads/master` is specified in `transfer.hideRefs` and | |
1038 | the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master` | |
1039 | is omitted from the advertisements but `refs/heads/master` and | |
1040 | `refs/namespaces/bar/refs/heads/master` are still advertised as so-called | |
78a766ab LF |
1041 | "have" lines. In order to match refs before stripping, add a `^` in front of |
1042 | the ref name. If you combine `!` and `^`, `!` must be specified first. | |
235ec243 MM |
1043 | + |
1044 | Even if you hide refs, a client may still be able to steal the target | |
1045 | objects via the techniques described in the "SECURITY" section of the | |
1046 | linkgit:gitnamespaces[7] man page; it's best to keep private data in a | |
1047 | separate repository. | |
daebaa78 | 1048 | |
b0f34c3d MM |
1049 | transfer.unpackLimit:: |
1050 | When `fetch.unpackLimit` or `receive.unpackLimit` are | |
1051 | not set, the value of this variable is used instead. | |
1052 | The default value is 100. | |
1053 | ||
7671b632 SG |
1054 | uploadarchive.allowUnreachable:: |
1055 | If true, allow clients to use `git archive --remote` to request | |
1056 | any tree, whether reachable from the ref tips or not. See the | |
235ec243 | 1057 | discussion in the "SECURITY" section of |
7671b632 SG |
1058 | linkgit:git-upload-archive[1] for more details. Defaults to |
1059 | `false`. | |
1060 | ||
da0005b8 | 1061 | uploadpack.hideRefs:: |
cc118a65 JK |
1062 | This variable is the same as `transfer.hideRefs`, but applies |
1063 | only to `upload-pack` (and so affects only fetches, not pushes). | |
1064 | An attempt to fetch a hidden ref by `git fetch` will fail. See | |
1065 | also `uploadpack.allowTipSHA1InWant`. | |
390eb36b | 1066 | |
bc0a4741 | 1067 | uploadpack.allowTipSHA1InWant:: |
da0005b8 | 1068 | When `uploadpack.hideRefs` is in effect, allow `upload-pack` |
390eb36b JH |
1069 | to accept a fetch request that asks for an object at the tip |
1070 | of a hidden ref (by default, such a request is rejected). | |
235ec243 MM |
1071 | See also `uploadpack.hideRefs`. Even if this is false, a client |
1072 | may be able to steal objects via the techniques described in the | |
1073 | "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's | |
1074 | best to keep private data in a separate repository. | |
daebaa78 | 1075 | |
68ee6289 FM |
1076 | uploadpack.allowReachableSHA1InWant:: |
1077 | Allow `upload-pack` to accept a fetch request that asks for an | |
1078 | object that is reachable from any ref tip. However, note that | |
1079 | calculating object reachability is computationally expensive. | |
235ec243 MM |
1080 | Defaults to `false`. Even if this is false, a client may be able |
1081 | to steal objects via the techniques described in the "SECURITY" | |
1082 | section of the linkgit:gitnamespaces[7] man page; it's best to | |
1083 | keep private data in a separate repository. | |
68ee6289 | 1084 | |
f8edeaa0 DT |
1085 | uploadpack.allowAnySHA1InWant:: |
1086 | Allow `upload-pack` to accept a fetch request that asks for any | |
1087 | object at all. | |
1088 | Defaults to `false`. | |
1089 | ||
da0005b8 | 1090 | uploadpack.keepAlive:: |
05e95155 JK |
1091 | When `upload-pack` has started `pack-objects`, there may be a |
1092 | quiet period while `pack-objects` prepares the pack. Normally | |
1093 | it would output progress information, but if `--quiet` was used | |
1094 | for the fetch, `pack-objects` will output nothing at all until | |
1095 | the pack data begins. Some clients and networks may consider | |
1096 | the server to be hung and give up. Setting this option instructs | |
1097 | `upload-pack` to send an empty keepalive packet every | |
da0005b8 | 1098 | `uploadpack.keepAlive` seconds. Setting this option to 0 |
115dedd7 | 1099 | disables keepalive packets entirely. The default is 5 seconds. |
05e95155 | 1100 | |
20b20a22 JK |
1101 | uploadpack.packObjectsHook:: |
1102 | If this option is set, when `upload-pack` would run | |
1103 | `git pack-objects` to create a packfile for a client, it will | |
1104 | run this shell command instead. The `pack-objects` command and | |
1105 | arguments it _would_ have run (including the `git pack-objects` | |
1106 | at the beginning) are appended to the shell command. The stdin | |
1107 | and stdout of the hook are treated as if `pack-objects` itself | |
1108 | was run. I.e., `upload-pack` will feed input intended for | |
1109 | `pack-objects` to the hook, and expects a completed packfile on | |
1110 | stdout. | |
1111 | + | |
1112 | Note that this configuration variable is ignored if it is seen in the | |
1113 | repository-level config (this is a safety measure against fetching from | |
1114 | untrusted repositories). | |
1115 | ||
e56b5355 NTND |
1116 | uploadpack.allowFilter:: |
1117 | If this option is set, `upload-pack` will support partial | |
1118 | clone and partial fetch object filtering. | |
1119 | ||
516e2b76 BW |
1120 | uploadpack.allowRefInWant:: |
1121 | If this option is set, `upload-pack` will support the `ref-in-want` | |
1122 | feature of the protocol version 2 `fetch` command. This feature | |
1123 | is intended for the benefit of load-balanced servers which may | |
1124 | not have the same view of what OIDs their refs point to due to | |
1125 | replication delay. | |
1126 | ||
55029ae4 DB |
1127 | url.<base>.insteadOf:: |
1128 | Any URL that starts with this value will be rewritten to | |
1129 | start, instead, with <base>. In cases where some site serves a | |
1130 | large number of repositories, and serves them with multiple | |
1131 | access methods, and some users need to use different access | |
1132 | methods, this feature allows people to specify any of the | |
2de9b711 | 1133 | equivalent URLs and have Git automatically rewrite the URL to |
55029ae4 | 1134 | the best alternative for the particular user, even for a |
844112ca JH |
1135 | never-before-seen repository on the site. When more than one |
1136 | insteadOf strings match a given URL, the longest match is used. | |
2c9a2ae2 JK |
1137 | + |
1138 | Note that any protocol restrictions will be applied to the rewritten | |
1139 | URL. If the rewrite changes the URL to use a custom protocol or remote | |
1140 | helper, you may need to adjust the `protocol.*.allow` config to permit | |
1141 | the request. In particular, protocols you expect to use for submodules | |
1142 | must be set to `always` rather than the default of `user`. See the | |
1143 | description of `protocol.allow` above. | |
55029ae4 | 1144 | |
1c2eafb8 JT |
1145 | url.<base>.pushInsteadOf:: |
1146 | Any URL that starts with this value will not be pushed to; | |
1147 | instead, it will be rewritten to start with <base>, and the | |
1148 | resulting URL will be pushed to. In cases where some site serves | |
1149 | a large number of repositories, and serves them with multiple | |
1150 | access methods, some of which do not allow push, this feature | |
2de9b711 | 1151 | allows people to specify a pull-only URL and have Git |
1c2eafb8 JT |
1152 | automatically use an appropriate URL to push, even for a |
1153 | never-before-seen repository on the site. When more than one | |
1154 | pushInsteadOf strings match a given URL, the longest match is | |
2de9b711 | 1155 | used. If a remote has an explicit pushurl, Git will ignore this |
1c2eafb8 JT |
1156 | setting for that remote. |
1157 | ||
1ab661dd PB |
1158 | user.email:: |
1159 | Your email address to be recorded in any newly created commits. | |
eee7f4a2 | 1160 | Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and |
47d81b5c | 1161 | `EMAIL` environment variables. See linkgit:git-commit-tree[1]. |
1ab661dd PB |
1162 | |
1163 | user.name:: | |
1164 | Your full name to be recorded in any newly created commits. | |
eee7f4a2 | 1165 | Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME` |
5162e697 | 1166 | environment variables. See linkgit:git-commit-tree[1]. |
1ab661dd | 1167 | |
4d5c2956 | 1168 | user.useConfigOnly:: |
ae9f6311 TR |
1169 | Instruct Git to avoid trying to guess defaults for `user.email` |
1170 | and `user.name`, and instead retrieve the values only from the | |
4d5c2956 DA |
1171 | configuration. For example, if you have multiple email addresses |
1172 | and would like to use a different one for each repository, then | |
1173 | with this configuration option set to `true` in the global config | |
1174 | along with a name, Git will prompt you to set up an email before | |
1175 | making new commits in a newly cloned repository. | |
1176 | Defaults to `false`. | |
1177 | ||
da0005b8 | 1178 | user.signingKey:: |
f0551693 NV |
1179 | If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the |
1180 | key you want it to automatically when creating a signed tag or | |
1181 | commit, you can override the default selection with this variable. | |
1182 | This option is passed unchanged to gpg's --local-user parameter, | |
1183 | so you may specify a key using any method that gpg supports. | |
d67778ec | 1184 | |
c026557a SG |
1185 | versionsort.prereleaseSuffix (deprecated):: |
1186 | Deprecated alias for `versionsort.suffix`. Ignored if | |
1187 | `versionsort.suffix` is set. | |
1188 | ||
1189 | versionsort.suffix:: | |
1190 | Even when version sort is used in linkgit:git-tag[1], tagnames | |
1191 | with the same base version but different suffixes are still sorted | |
1192 | lexicographically, resulting e.g. in prerelease tags appearing | |
1193 | after the main release (e.g. "1.0-rc1" after "1.0"). This | |
1194 | variable can be specified to determine the sorting order of tags | |
1195 | with different suffixes. | |
1196 | + | |
1197 | By specifying a single suffix in this variable, any tagname containing | |
1198 | that suffix will appear before the corresponding main release. E.g. if | |
1199 | the variable is set to "-rc", then all "1.0-rcX" tags will appear before | |
1200 | "1.0". If specified multiple times, once per suffix, then the order of | |
1201 | suffixes in the configuration will determine the sorting order of tagnames | |
1202 | with those suffixes. E.g. if "-pre" appears before "-rc" in the | |
1203 | configuration, then all "1.0-preX" tags will be listed before any | |
1204 | "1.0-rcX" tags. The placement of the main release tag relative to tags | |
1205 | with various suffixes can be determined by specifying the empty suffix | |
1206 | among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and | |
1207 | "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags | |
1208 | are listed first, followed by "v4.8", then "v4.8-ckX" and finally | |
1209 | "v4.8-bfsX". | |
1210 | + | |
b8231660 | 1211 | If more than one suffixes match the same tagname, then that tagname will |
51acfa9d SG |
1212 | be sorted according to the suffix which starts at the earliest position in |
1213 | the tagname. If more than one different matching suffixes start at | |
1214 | that earliest position, then that tagname will be sorted according to the | |
1215 | longest of those suffixes. | |
b8231660 SG |
1216 | The sorting order between different suffixes is undefined if they are |
1217 | in multiple config files. | |
d811c8e1 | 1218 | |
983a9eeb CC |
1219 | web.browser:: |
1220 | Specify a web browser that may be used by some commands. | |
1221 | Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] | |
1222 | may use it. | |
e92445a7 TG |
1223 | |
1224 | worktree.guessRemote:: | |
1225 | With `add`, if no branch argument, and neither of `-b` nor | |
1226 | `-B` nor `--detach` are given, the command defaults to | |
1227 | creating a new branch from HEAD. If `worktree.guessRemote` is | |
1228 | set to true, `worktree add` tries to find a remote-tracking | |
1229 | branch whose name uniquely matches the new branch name. If | |
1230 | such a branch exists, it is checked out and set as "upstream" | |
1231 | for the new branch. If no such match can be found, it falls | |
1232 | back to creating a new branch from the current HEAD. |