]>
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 | |
f7ade6c9 | 372 | include::config/man.txt[] |
7e8114c0 | 373 | |
7fb5ab4a | 374 | include::config/merge.txt[] |
b5412484 | 375 | |
ea24a76a | 376 | include::config/mergetool.txt[] |
682b451f | 377 | |
e50472d8 | 378 | include::config/notes.txt[] |
6956f858 | 379 | |
a168c5a2 | 380 | include::config/pack.txt[] |
ae4f07fb | 381 | |
87e1b41a | 382 | include::config/pager.txt[] |
4370c2d6 | 383 | |
cd967547 | 384 | include::config/pretty.txt[] |
8028184e | 385 | |
dd55172c | 386 | include::config/protocol.txt[] |
373d70ef | 387 | |
7f50a495 | 388 | include::config/pull.txt[] |
d8052750 | 389 | |
d15dc439 | 390 | include::config/push.txt[] |
b33a15b0 | 391 | |
946a9f20 | 392 | include::rebase-config.txt[] |
16cf51c7 | 393 | |
aaa3b458 | 394 | include::receive-config.txt[] |
0a1bc12b | 395 | |
da0005b8 | 396 | remote.pushDefault:: |
224c2171 | 397 | The remote to push to by default. Overrides |
9f765ce6 | 398 | `branch.<name>.remote` for all branches, and is overridden by |
da0005b8 | 399 | `branch.<name>.pushRemote` for specific branches. |
224c2171 | 400 | |
0cc6d346 | 401 | remote.<name>.url:: |
5162e697 DM |
402 | The URL of a remote repository. See linkgit:git-fetch[1] or |
403 | linkgit:git-push[1]. | |
0cc6d346 | 404 | |
20346234 MG |
405 | remote.<name>.pushurl:: |
406 | The push URL of a remote repository. See linkgit:git-push[1]. | |
407 | ||
14c98218 SV |
408 | remote.<name>.proxy:: |
409 | For remotes that require curl (http, https and ftp), the URL to | |
410 | the proxy to use for that remote. Set to the empty string to | |
411 | disable proxying for that remote. | |
412 | ||
ef976395 KF |
413 | remote.<name>.proxyAuthMethod:: |
414 | For remotes that require curl (http, https and ftp), the method to use for | |
415 | authenticating against the proxy in use (probably set in | |
416 | `remote.<name>.proxy`). See `http.proxyAuthMethod`. | |
417 | ||
0cc6d346 | 418 | remote.<name>.fetch:: |
5162e697 DM |
419 | The default set of "refspec" for linkgit:git-fetch[1]. See |
420 | linkgit:git-fetch[1]. | |
0cc6d346 SB |
421 | |
422 | remote.<name>.push:: | |
5162e697 DM |
423 | The default set of "refspec" for linkgit:git-push[1]. See |
424 | linkgit:git-push[1]. | |
0cc6d346 | 425 | |
84bb2dfd PB |
426 | remote.<name>.mirror:: |
427 | If true, pushing to this remote will automatically behave | |
6cf378f0 | 428 | as if the `--mirror` option was given on the command line. |
84bb2dfd | 429 | |
1918278e TT |
430 | remote.<name>.skipDefaultUpdate:: |
431 | If true, this remote will be skipped by default when updating | |
7cc91a2f BG |
432 | using linkgit:git-fetch[1] or the `update` subcommand of |
433 | linkgit:git-remote[1]. | |
434 | ||
435 | remote.<name>.skipFetchAll:: | |
436 | If true, this remote will be skipped by default when updating | |
437 | using linkgit:git-fetch[1] or the `update` subcommand of | |
438 | linkgit:git-remote[1]. | |
1918278e | 439 | |
060aafc1 | 440 | remote.<name>.receivepack:: |
5dee29ac | 441 | The default program to execute on the remote side when pushing. See |
1c262bb7 | 442 | option --receive-pack of linkgit:git-push[1]. |
060aafc1 | 443 | |
5dee29ac UKK |
444 | remote.<name>.uploadpack:: |
445 | The default program to execute on the remote side when fetching. See | |
1c262bb7 | 446 | option --upload-pack of linkgit:git-fetch-pack[1]. |
5dee29ac | 447 | |
da0005b8 | 448 | remote.<name>.tagOpt:: |
1c262bb7 JK |
449 | Setting this value to --no-tags disables automatic tag following when |
450 | fetching from remote <name>. Setting it to --tags will fetch every | |
944163a4 | 451 | tag from remote <name>, even if they are not reachable from remote |
ed368546 | 452 | branch heads. Passing these flags directly to linkgit:git-fetch[1] can |
1c262bb7 | 453 | override this setting. See options --tags and --no-tags of |
ed368546 | 454 | linkgit:git-fetch[1]. |
047f636d | 455 | |
c578f51d | 456 | remote.<name>.vcs:: |
2de9b711 | 457 | Setting this to a value <vcs> will cause Git to interact with |
c578f51d DB |
458 | the remote with the git-remote-<vcs> helper. |
459 | ||
737c5a9c MS |
460 | remote.<name>.prune:: |
461 | When set to true, fetching from this remote by default will also | |
0838bf47 MH |
462 | remove any remote-tracking references that no longer exist on the |
463 | remote (as if the `--prune` option was given on the command line). | |
737c5a9c MS |
464 | Overrides `fetch.prune` settings, if any. |
465 | ||
97716d21 ÆAB |
466 | remote.<name>.pruneTags:: |
467 | When set to true, fetching from this remote by default will also | |
468 | remove any local tags that no longer exist on the remote if pruning | |
469 | is activated in general via `remote.<name>.prune`, `fetch.prune` or | |
470 | `--prune`. Overrides `fetch.pruneTags` settings, if any. | |
627a129b ÆAB |
471 | + |
472 | See also `remote.<name>.prune` and the PRUNING section of | |
473 | linkgit:git-fetch[1]. | |
737c5a9c | 474 | |
1918278e TT |
475 | remotes.<group>:: |
476 | The list of remotes which are fetched by "git remote update | |
5162e697 | 477 | <group>". See linkgit:git-remote[1]. |
1918278e | 478 | |
da0005b8 | 479 | repack.useDeltaBaseOffset:: |
22c79eab NP |
480 | By default, linkgit:git-repack[1] creates packs that use |
481 | delta-base offset. If you need to share your repository with | |
2de9b711 | 482 | Git older than version 1.4.4, either directly or via a dumb |
22c79eab | 483 | protocol such as http, then you need to set this option to |
2de9b711 | 484 | "false" and repack. Access from old Git versions over the |
22c79eab | 485 | native protocol are unaffected by this option. |
b6945f57 | 486 | |
ee34a2be JK |
487 | repack.packKeptObjects:: |
488 | If set to true, makes `git repack` act as if | |
489 | `--pack-kept-objects` was passed. See linkgit:git-repack[1] for | |
490 | details. Defaults to `false` normally, but `true` if a bitmap | |
491 | index is being written (either via `--write-bitmap-index` or | |
71d76cb4 JK |
492 | `repack.writeBitmaps`). |
493 | ||
16d75fa4 JK |
494 | repack.useDeltaIslands:: |
495 | If set to true, makes `git repack` act as if `--delta-islands` | |
496 | was passed. Defaults to `false`. | |
497 | ||
71d76cb4 JK |
498 | repack.writeBitmaps:: |
499 | When true, git will write a bitmap index when packing all | |
500 | objects to disk (e.g., when `git repack -a` is run). This | |
501 | index can speed up the "counting objects" phase of subsequent | |
502 | packs created for clones and fetches, at the cost of some disk | |
9cea46cd EW |
503 | space and extra time spent on the initial repack. This has |
504 | no effect if multiple packfiles are created. | |
505 | Defaults to false. | |
ee34a2be | 506 | |
da0005b8 | 507 | rerere.autoUpdate:: |
b0f34c3d MM |
508 | When set to true, `git-rerere` updates the index with the |
509 | resulting contents after it cleanly resolves conflicts using | |
510 | previously recorded resolution. Defaults to false. | |
511 | ||
512 | rerere.enabled:: | |
513 | Activate recording of resolved conflicts, so that identical | |
07b88a00 TR |
514 | conflict hunks can be resolved automatically, should they be |
515 | encountered again. By default, linkgit:git-rerere[1] is | |
516 | enabled if there is an `rr-cache` directory under the | |
b6fb7fed JH |
517 | `$GIT_DIR`, e.g. if "rerere" was previously used in the |
518 | repository. | |
b0f34c3d | 519 | |
4c3abd05 BP |
520 | reset.quiet:: |
521 | When set to true, 'git reset' will default to the '--quiet' option. | |
522 | ||
701137ee | 523 | include::sendemail-config.txt[] |
5453b83b | 524 | |
8dc9d22d NTND |
525 | sequence.editor:: |
526 | Text editor used by `git rebase -i` for editing the rebase instruction file. | |
527 | The value is meant to be interpreted by the shell when it is used. | |
528 | It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. | |
529 | When not configured the default commit message editor is used instead. | |
530 | ||
8da2f489 | 531 | showBranch.default:: |
5162e697 DM |
532 | The default set of branches for linkgit:git-show-branch[1]. |
533 | See linkgit:git-show-branch[1]. | |
1ab661dd | 534 | |
e77cf4ee CC |
535 | splitIndex.maxPercentChange:: |
536 | When the split index feature is used, this specifies the | |
537 | percent of entries the split index can contain compared to the | |
538 | total number of entries in both the split index and the shared | |
539 | index before a new shared index is written. | |
540 | The value should be between 0 and 100. If the value is 0 then | |
541 | a new shared index is always written, if it is 100 a new | |
542 | shared index is never written. | |
543 | By default the value is 20, so a new shared index is written | |
544 | if the number of entries in the split index would be greater | |
545 | than 20 percent of the total number of entries. | |
546 | See linkgit:git-update-index[1]. | |
547 | ||
b2dd1c5c CC |
548 | splitIndex.sharedIndexExpire:: |
549 | When the split index feature is used, shared index files that | |
550 | were not modified since the time this variable specifies will | |
551 | be removed when a new shared index file is created. The value | |
552 | "now" expires all entries immediately, and "never" suppresses | |
553 | expiration altogether. | |
554 | The default value is "2.weeks.ago". | |
555 | Note that a shared index file is considered modified (for the | |
556 | purpose of expiration) each time a new split-index file is | |
b4601395 | 557 | either created based on it or read from it. |
b2dd1c5c CC |
558 | See linkgit:git-update-index[1]. |
559 | ||
12e60249 NTND |
560 | include::config/ssh.txt[] |
561 | ||
46f721c8 | 562 | status.relativePaths:: |
5162e697 | 563 | By default, linkgit:git-status[1] shows paths relative to the |
46f721c8 | 564 | current directory. Setting this variable to `false` shows paths |
2de9b711 | 565 | relative to the repository root (this was the default for Git |
46f721c8 JK |
566 | prior to v1.5.4). |
567 | ||
4fb5166a JJGG |
568 | status.short:: |
569 | Set to true to enable --short by default in linkgit:git-status[1]. | |
570 | The option --no-short takes precedence over this variable. | |
571 | ||
ec85d070 JJGG |
572 | status.branch:: |
573 | Set to true to enable --branch by default in linkgit:git-status[1]. | |
574 | The option --no-branch takes precedence over this variable. | |
575 | ||
2556b996 MM |
576 | status.displayCommentPrefix:: |
577 | If set to true, linkgit:git-status[1] will insert a comment | |
578 | prefix before each output line (starting with | |
579 | `core.commentChar`, i.e. `#` by default). This was the | |
580 | behavior of linkgit:git-status[1] in Git 1.8.4 and previous. | |
581 | Defaults to false. | |
582 | ||
e8b2dc2c BP |
583 | status.renameLimit:: |
584 | The number of files to consider when performing rename detection | |
585 | in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to | |
586 | the value of diff.renameLimit. | |
587 | ||
588 | status.renames:: | |
589 | Whether and how Git detects renames in linkgit:git-status[1] and | |
590 | linkgit:git-commit[1] . If set to "false", rename detection is | |
591 | disabled. If set to "true", basic rename detection is enabled. | |
592 | If set to "copies" or "copy", Git will detect copies, as well. | |
593 | Defaults to the value of diff.renames. | |
594 | ||
c1b5d019 LB |
595 | status.showStash:: |
596 | If set to true, linkgit:git-status[1] will display the number of | |
597 | entries currently stashed away. | |
598 | Defaults to false. | |
599 | ||
d6293d1f MSO |
600 | status.showUntrackedFiles:: |
601 | By default, linkgit:git-status[1] and linkgit:git-commit[1] show | |
602 | files which are not currently tracked by Git. Directories which | |
603 | contain only untracked files, are shown with the directory name | |
604 | only. Showing untracked files means that Git needs to lstat() all | |
71069cdf | 605 | the files in the whole repository, which might be slow on some |
d6293d1f MSO |
606 | systems. So, this variable controls how the commands displays |
607 | the untracked files. Possible values are: | |
608 | + | |
609 | -- | |
9373bdc4 CF |
610 | * `no` - Show no untracked files. |
611 | * `normal` - Show untracked files and directories. | |
612 | * `all` - Show also individual files in untracked directories. | |
d6293d1f MSO |
613 | -- |
614 | + | |
615 | If this variable is not specified, it defaults to 'normal'. | |
616 | This variable can be overridden with the -u|--untracked-files option | |
617 | of linkgit:git-status[1] and linkgit:git-commit[1]. | |
618 | ||
da0005b8 | 619 | status.submoduleSummary:: |
4b2343fa MG |
620 | Defaults to false. |
621 | If this is set to a non zero number or true (identical to -1 or an | |
622 | unlimited number), the submodule summary will be enabled and a | |
623 | summary of commits for modified submodules will be shown (see | |
bb58b696 JL |
624 | --summary-limit option of linkgit:git-submodule[1]). Please note |
625 | that the summary output command will be suppressed for all | |
626 | submodules when `diff.ignoreSubmodules` is set to 'all' or only | |
1d2f393a JL |
627 | for those submodules where `submodule.<name>.ignore=all`. The only |
628 | exception to that rule is that status and commit will show staged | |
629 | submodule changes. To | |
bb58b696 | 630 | also view the summary for ignored submodules you can either use |
06ab60c0 | 631 | the --ignore-submodules=dirty command-line option or the 'git |
bb58b696 JL |
632 | submodule summary' command, which shows a similar output but does |
633 | not honor these settings. | |
4b2343fa | 634 | |
3086c064 NK |
635 | stash.showPatch:: |
636 | If this is set to true, the `git stash show` command without an | |
e01db917 | 637 | option will show the stash entry in patch form. Defaults to false. |
3086c064 NK |
638 | See description of 'show' command in linkgit:git-stash[1]. |
639 | ||
640 | stash.showStat:: | |
641 | If this is set to true, the `git stash show` command without an | |
e01db917 | 642 | option will show diffstat of the stash entry. Defaults to true. |
3086c064 NK |
643 | See description of 'show' command in linkgit:git-stash[1]. |
644 | ||
6014363f | 645 | include::submodule-config.txt[] |
31224cbd | 646 | |
61c2fe0c LA |
647 | tag.forceSignAnnotated:: |
648 | A boolean to specify whether annotated tags created should be GPG signed. | |
649 | If `--annotate` is specified on the command line, it takes | |
650 | precedence over this option. | |
651 | ||
b150794d JK |
652 | tag.sort:: |
653 | This variable controls the sort ordering of tags when displayed by | |
654 | linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the | |
655 | value of this variable will be used as the default. | |
656 | ||
ce1a79b6 | 657 | tar.umask:: |
687157c7 RS |
658 | This variable can be used to restrict the permission bits of |
659 | tar archive entries. The default is 0002, which turns off the | |
660 | world write bit. The special value "user" indicates that the | |
661 | archiving user's umask will be used instead. See umask(2) and | |
5162e697 | 662 | linkgit:git-archive[1]. |
ce1a79b6 | 663 | |
dab76d3a JH |
664 | transfer.fsckObjects:: |
665 | When `fetch.fsckObjects` or `receive.fsckObjects` are | |
666 | not set, the value of this variable is used instead. | |
667 | Defaults to false. | |
5180dd2e ÆAB |
668 | + |
669 | When set, the fetch or receive will abort in the case of a malformed | |
456bab87 ÆAB |
670 | object or a link to a nonexistent object. In addition, various other |
671 | issues are checked for, including legacy issues (see `fsck.<msg-id>`), | |
672 | and potential security issues like the existence of a `.GIT` directory | |
673 | or a malicious `.gitmodules` file (see the release notes for v2.2.1 | |
674 | and v2.17.1 for details). Other sanity and security checks may be | |
675 | added in future releases. | |
676 | + | |
677 | On the receiving side, failing fsckObjects will make those objects | |
678 | unreachable, see "QUARANTINE ENVIRONMENT" in | |
679 | linkgit:git-receive-pack[1]. On the fetch side, malformed objects will | |
680 | instead be left unreferenced in the repository. | |
720dae5a ÆAB |
681 | + |
682 | Due to the non-quarantine nature of the `fetch.fsckObjects` | |
683 | implementation it can not be relied upon to leave the object store | |
684 | clean like `receive.fsckObjects` can. | |
685 | + | |
686 | As objects are unpacked they're written to the object store, so there | |
687 | can be cases where malicious objects get introduced even though the | |
688 | "fetch" failed, only to have a subsequent "fetch" succeed because only | |
689 | new incoming objects are checked, not those that have already been | |
690 | written to the object store. That difference in behavior should not be | |
691 | relied upon. In the future, such objects may be quarantined for | |
692 | "fetch" as well. | |
693 | + | |
694 | For now, the paranoid need to find some way to emulate the quarantine | |
695 | environment if they'd like the same protection as "push". E.g. in the | |
696 | case of an internal mirror do the mirroring in two steps, one to fetch | |
697 | the untrusted objects, and then do a second "push" (which will use the | |
698 | quarantine) to another internal repo, and have internal clients | |
699 | consume this pushed-to repository, or embargo internal fetches and | |
700 | only allow them once a full "fsck" has run (and no new fetches have | |
701 | happened in the meantime). | |
dab76d3a | 702 | |
da0005b8 | 703 | transfer.hideRefs:: |
cc118a65 JK |
704 | String(s) `receive-pack` and `upload-pack` use to decide which |
705 | refs to omit from their initial advertisements. Use more than | |
706 | one definition to specify multiple prefix strings. A ref that is | |
707 | under the hierarchies listed in the value of this variable is | |
708 | excluded, and is hidden when responding to `git push` or `git | |
709 | fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for | |
710 | program-specific versions of this config. | |
2bc31d16 JK |
711 | + |
712 | You may also include a `!` in front of the ref name to negate the entry, | |
713 | explicitly exposing it, even if an earlier entry marked it as hidden. | |
714 | If you have multiple hideRefs values, later entries override earlier ones | |
715 | (and entries in more-specific config files override less-specific ones). | |
92cab492 LF |
716 | + |
717 | If a namespace is in use, the namespace prefix is stripped from each | |
718 | reference before it is matched against `transfer.hiderefs` patterns. | |
719 | For example, if `refs/heads/master` is specified in `transfer.hideRefs` and | |
720 | the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master` | |
721 | is omitted from the advertisements but `refs/heads/master` and | |
722 | `refs/namespaces/bar/refs/heads/master` are still advertised as so-called | |
78a766ab LF |
723 | "have" lines. In order to match refs before stripping, add a `^` in front of |
724 | the ref name. If you combine `!` and `^`, `!` must be specified first. | |
235ec243 MM |
725 | + |
726 | Even if you hide refs, a client may still be able to steal the target | |
727 | objects via the techniques described in the "SECURITY" section of the | |
728 | linkgit:gitnamespaces[7] man page; it's best to keep private data in a | |
729 | separate repository. | |
daebaa78 | 730 | |
b0f34c3d MM |
731 | transfer.unpackLimit:: |
732 | When `fetch.unpackLimit` or `receive.unpackLimit` are | |
733 | not set, the value of this variable is used instead. | |
734 | The default value is 100. | |
735 | ||
7671b632 SG |
736 | uploadarchive.allowUnreachable:: |
737 | If true, allow clients to use `git archive --remote` to request | |
738 | any tree, whether reachable from the ref tips or not. See the | |
235ec243 | 739 | discussion in the "SECURITY" section of |
7671b632 SG |
740 | linkgit:git-upload-archive[1] for more details. Defaults to |
741 | `false`. | |
742 | ||
da0005b8 | 743 | uploadpack.hideRefs:: |
cc118a65 JK |
744 | This variable is the same as `transfer.hideRefs`, but applies |
745 | only to `upload-pack` (and so affects only fetches, not pushes). | |
746 | An attempt to fetch a hidden ref by `git fetch` will fail. See | |
747 | also `uploadpack.allowTipSHA1InWant`. | |
390eb36b | 748 | |
bc0a4741 | 749 | uploadpack.allowTipSHA1InWant:: |
da0005b8 | 750 | When `uploadpack.hideRefs` is in effect, allow `upload-pack` |
390eb36b JH |
751 | to accept a fetch request that asks for an object at the tip |
752 | of a hidden ref (by default, such a request is rejected). | |
235ec243 MM |
753 | See also `uploadpack.hideRefs`. Even if this is false, a client |
754 | may be able to steal objects via the techniques described in the | |
755 | "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's | |
756 | best to keep private data in a separate repository. | |
daebaa78 | 757 | |
68ee6289 FM |
758 | uploadpack.allowReachableSHA1InWant:: |
759 | Allow `upload-pack` to accept a fetch request that asks for an | |
760 | object that is reachable from any ref tip. However, note that | |
761 | calculating object reachability is computationally expensive. | |
235ec243 MM |
762 | Defaults to `false`. Even if this is false, a client may be able |
763 | to steal objects via the techniques described in the "SECURITY" | |
764 | section of the linkgit:gitnamespaces[7] man page; it's best to | |
765 | keep private data in a separate repository. | |
68ee6289 | 766 | |
f8edeaa0 DT |
767 | uploadpack.allowAnySHA1InWant:: |
768 | Allow `upload-pack` to accept a fetch request that asks for any | |
769 | object at all. | |
770 | Defaults to `false`. | |
771 | ||
da0005b8 | 772 | uploadpack.keepAlive:: |
05e95155 JK |
773 | When `upload-pack` has started `pack-objects`, there may be a |
774 | quiet period while `pack-objects` prepares the pack. Normally | |
775 | it would output progress information, but if `--quiet` was used | |
776 | for the fetch, `pack-objects` will output nothing at all until | |
777 | the pack data begins. Some clients and networks may consider | |
778 | the server to be hung and give up. Setting this option instructs | |
779 | `upload-pack` to send an empty keepalive packet every | |
da0005b8 | 780 | `uploadpack.keepAlive` seconds. Setting this option to 0 |
115dedd7 | 781 | disables keepalive packets entirely. The default is 5 seconds. |
05e95155 | 782 | |
20b20a22 JK |
783 | uploadpack.packObjectsHook:: |
784 | If this option is set, when `upload-pack` would run | |
785 | `git pack-objects` to create a packfile for a client, it will | |
786 | run this shell command instead. The `pack-objects` command and | |
787 | arguments it _would_ have run (including the `git pack-objects` | |
788 | at the beginning) are appended to the shell command. The stdin | |
789 | and stdout of the hook are treated as if `pack-objects` itself | |
790 | was run. I.e., `upload-pack` will feed input intended for | |
791 | `pack-objects` to the hook, and expects a completed packfile on | |
792 | stdout. | |
793 | + | |
794 | Note that this configuration variable is ignored if it is seen in the | |
795 | repository-level config (this is a safety measure against fetching from | |
796 | untrusted repositories). | |
797 | ||
e56b5355 NTND |
798 | uploadpack.allowFilter:: |
799 | If this option is set, `upload-pack` will support partial | |
800 | clone and partial fetch object filtering. | |
801 | ||
516e2b76 BW |
802 | uploadpack.allowRefInWant:: |
803 | If this option is set, `upload-pack` will support the `ref-in-want` | |
804 | feature of the protocol version 2 `fetch` command. This feature | |
805 | is intended for the benefit of load-balanced servers which may | |
806 | not have the same view of what OIDs their refs point to due to | |
807 | replication delay. | |
808 | ||
55029ae4 DB |
809 | url.<base>.insteadOf:: |
810 | Any URL that starts with this value will be rewritten to | |
811 | start, instead, with <base>. In cases where some site serves a | |
812 | large number of repositories, and serves them with multiple | |
813 | access methods, and some users need to use different access | |
814 | methods, this feature allows people to specify any of the | |
2de9b711 | 815 | equivalent URLs and have Git automatically rewrite the URL to |
55029ae4 | 816 | the best alternative for the particular user, even for a |
844112ca JH |
817 | never-before-seen repository on the site. When more than one |
818 | insteadOf strings match a given URL, the longest match is used. | |
2c9a2ae2 JK |
819 | + |
820 | Note that any protocol restrictions will be applied to the rewritten | |
821 | URL. If the rewrite changes the URL to use a custom protocol or remote | |
822 | helper, you may need to adjust the `protocol.*.allow` config to permit | |
823 | the request. In particular, protocols you expect to use for submodules | |
824 | must be set to `always` rather than the default of `user`. See the | |
825 | description of `protocol.allow` above. | |
55029ae4 | 826 | |
1c2eafb8 JT |
827 | url.<base>.pushInsteadOf:: |
828 | Any URL that starts with this value will not be pushed to; | |
829 | instead, it will be rewritten to start with <base>, and the | |
830 | resulting URL will be pushed to. In cases where some site serves | |
831 | a large number of repositories, and serves them with multiple | |
832 | access methods, some of which do not allow push, this feature | |
2de9b711 | 833 | allows people to specify a pull-only URL and have Git |
1c2eafb8 JT |
834 | automatically use an appropriate URL to push, even for a |
835 | never-before-seen repository on the site. When more than one | |
836 | pushInsteadOf strings match a given URL, the longest match is | |
2de9b711 | 837 | used. If a remote has an explicit pushurl, Git will ignore this |
1c2eafb8 JT |
838 | setting for that remote. |
839 | ||
1ab661dd PB |
840 | user.email:: |
841 | Your email address to be recorded in any newly created commits. | |
eee7f4a2 | 842 | Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and |
47d81b5c | 843 | `EMAIL` environment variables. See linkgit:git-commit-tree[1]. |
1ab661dd PB |
844 | |
845 | user.name:: | |
846 | Your full name to be recorded in any newly created commits. | |
eee7f4a2 | 847 | Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME` |
5162e697 | 848 | environment variables. See linkgit:git-commit-tree[1]. |
1ab661dd | 849 | |
4d5c2956 | 850 | user.useConfigOnly:: |
ae9f6311 TR |
851 | Instruct Git to avoid trying to guess defaults for `user.email` |
852 | and `user.name`, and instead retrieve the values only from the | |
4d5c2956 DA |
853 | configuration. For example, if you have multiple email addresses |
854 | and would like to use a different one for each repository, then | |
855 | with this configuration option set to `true` in the global config | |
856 | along with a name, Git will prompt you to set up an email before | |
857 | making new commits in a newly cloned repository. | |
858 | Defaults to `false`. | |
859 | ||
da0005b8 | 860 | user.signingKey:: |
f0551693 NV |
861 | If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the |
862 | key you want it to automatically when creating a signed tag or | |
863 | commit, you can override the default selection with this variable. | |
864 | This option is passed unchanged to gpg's --local-user parameter, | |
865 | so you may specify a key using any method that gpg supports. | |
d67778ec | 866 | |
c026557a SG |
867 | versionsort.prereleaseSuffix (deprecated):: |
868 | Deprecated alias for `versionsort.suffix`. Ignored if | |
869 | `versionsort.suffix` is set. | |
870 | ||
871 | versionsort.suffix:: | |
872 | Even when version sort is used in linkgit:git-tag[1], tagnames | |
873 | with the same base version but different suffixes are still sorted | |
874 | lexicographically, resulting e.g. in prerelease tags appearing | |
875 | after the main release (e.g. "1.0-rc1" after "1.0"). This | |
876 | variable can be specified to determine the sorting order of tags | |
877 | with different suffixes. | |
878 | + | |
879 | By specifying a single suffix in this variable, any tagname containing | |
880 | that suffix will appear before the corresponding main release. E.g. if | |
881 | the variable is set to "-rc", then all "1.0-rcX" tags will appear before | |
882 | "1.0". If specified multiple times, once per suffix, then the order of | |
883 | suffixes in the configuration will determine the sorting order of tagnames | |
884 | with those suffixes. E.g. if "-pre" appears before "-rc" in the | |
885 | configuration, then all "1.0-preX" tags will be listed before any | |
886 | "1.0-rcX" tags. The placement of the main release tag relative to tags | |
887 | with various suffixes can be determined by specifying the empty suffix | |
888 | among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and | |
889 | "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags | |
890 | are listed first, followed by "v4.8", then "v4.8-ckX" and finally | |
891 | "v4.8-bfsX". | |
892 | + | |
b8231660 | 893 | If more than one suffixes match the same tagname, then that tagname will |
51acfa9d SG |
894 | be sorted according to the suffix which starts at the earliest position in |
895 | the tagname. If more than one different matching suffixes start at | |
896 | that earliest position, then that tagname will be sorted according to the | |
897 | longest of those suffixes. | |
b8231660 SG |
898 | The sorting order between different suffixes is undefined if they are |
899 | in multiple config files. | |
d811c8e1 | 900 | |
983a9eeb CC |
901 | web.browser:: |
902 | Specify a web browser that may be used by some commands. | |
903 | Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] | |
904 | may use it. | |
e92445a7 TG |
905 | |
906 | worktree.guessRemote:: | |
907 | With `add`, if no branch argument, and neither of `-b` nor | |
908 | `-B` nor `--detach` are given, the command defaults to | |
909 | creating a new branch from HEAD. If `worktree.guessRemote` is | |
910 | set to true, `worktree add` tries to find a remote-tracking | |
911 | branch whose name uniquely matches the new branch name. If | |
912 | such a branch exists, it is checked out and set as "upstream" | |
913 | for the new branch. If no such match can be found, it falls | |
914 | back to creating a new branch from the current HEAD. |