]>
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 | |
17 | variables may appear multiple times. | |
1ab661dd | 18 | |
e136f33b JN |
19 | Syntax |
20 | ~~~~~~ | |
21 | ||
1ab661dd | 22 | The syntax is fairly flexible and permissive; whitespaces are mostly |
e136f33b JN |
23 | ignored. The '#' and ';' characters begin comments to the end of line, |
24 | blank lines are ignored. | |
25 | ||
26 | The file consists of sections and variables. A section begins with | |
27 | the name of the section in square brackets and continues until the next | |
28 | section begins. Section names are not case sensitive. Only alphanumeric | |
dcb11263 | 29 | characters, `-` and `.` are allowed in section names. Each variable |
773002a7 SB |
30 | must belong to some section, which means that there must be a section |
31 | header before the first setting of a variable. | |
e136f33b JN |
32 | |
33 | Sections can be further divided into subsections. To begin a subsection | |
34 | put its name in double quotes, separated by space from the section name, | |
773002a7 | 35 | in the section header, like in the example below: |
e136f33b JN |
36 | |
37 | -------- | |
38 | [section "subsection"] | |
39 | ||
40 | -------- | |
41 | ||
b7ee2266 SB |
42 | Subsection names are case sensitive and can contain any characters except |
43 | newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, | |
44 | respectively). Section headers cannot span multiple | |
e136f33b JN |
45 | lines. Variables may belong directly to a section or to a given subsection. |
46 | You can have `[section]` if you have `[section "subsection"]`, but you | |
47 | don't need to. | |
48 | ||
f7376329 CMN |
49 | There is also a deprecated `[section.subsection]` syntax. With this |
50 | syntax, the subsection name is converted to lower-case and is also | |
51 | compared case sensitively. These subsection names follow the same | |
52 | restrictions as section names. | |
e136f33b | 53 | |
2ceb639f NS |
54 | All the other lines (and the remainder of the line after the section |
55 | header) are recognized as setting variables, in the form | |
e136f33b JN |
56 | 'name = value'. If there is no equal sign on the line, the entire line |
57 | is taken as 'name' and the variable is recognized as boolean "true". | |
e0a4aae8 LP |
58 | The variable names are case-insensitive, allow only alphanumeric characters |
59 | and `-`, and must start with an alphabetic character. There can be more | |
60 | than one value for a given variable; we say then that the variable is | |
61 | multivalued. | |
e136f33b JN |
62 | |
63 | Leading and trailing whitespace in a variable value is discarded. | |
64 | Internal whitespace within a variable value is retained verbatim. | |
65 | ||
66 | The values following the equals sign in variable assign are all either | |
67 | a string, an integer, or a boolean. Boolean values may be given as yes/no, | |
18b19e44 | 68 | 1/0, true/false or on/off. Case is not significant in boolean values, when |
e136f33b | 69 | converting value to the canonical form using '--bool' type specifier; |
0b444cdb | 70 | 'git config' will ensure that the output is "true" or "false". |
e136f33b JN |
71 | |
72 | String values may be entirely or partially enclosed in double quotes. | |
773002a7 SB |
73 | You need to enclose variable values in double quotes if you want to |
74 | preserve leading or trailing whitespace, or if the variable value contains | |
75 | comment characters (i.e. it contains '#' or ';'). | |
76 | Double quote `"` and backslash `\` characters in variable values must | |
dcb11263 | 77 | be escaped: use `\"` for `"` and `\\` for `\`. |
e136f33b | 78 | |
dcb11263 CJ |
79 | The following escape sequences (beside `\"` and `\\`) are recognized: |
80 | `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) | |
a58088ab JL |
81 | and `\b` for backspace (BS). Other char escape sequences (including octal |
82 | escape sequences) are invalid. | |
e136f33b | 83 | |
773002a7 | 84 | Variable values ending in a `\` are continued on the next line in the |
e136f33b JN |
85 | customary UNIX fashion. |
86 | ||
773002a7 | 87 | Some variables may require a special value format. |
1ab661dd | 88 | |
9b25a0b5 JK |
89 | Includes |
90 | ~~~~~~~~ | |
91 | ||
92 | You can include one config file from another by setting the special | |
93 | `include.path` variable to the name of the file to be included. The | |
94 | included file is expanded immediately, as if its contents had been | |
95 | found at the location of the include directive. If the value of the | |
96 | `include.path` variable is a relative path, the path is considered to be | |
97 | relative to the configuration file in which the include directive was | |
9a7b0bca JK |
98 | found. The value of `include.path` is subject to tilde expansion: `~/` |
99 | is expanded to the value of `$HOME`, and `~user/` to the specified | |
4c0a89fc | 100 | user's home directory. See below for examples. |
9b25a0b5 | 101 | |
1ab661dd PB |
102 | Example |
103 | ~~~~~~~ | |
104 | ||
105 | # Core variables | |
106 | [core] | |
107 | ; Don't trust file modes | |
108 | filemode = false | |
109 | ||
110 | # Our diff algorithm | |
111 | [diff] | |
6bb9e51b | 112 | external = /usr/local/bin/diff-wrapper |
1ab661dd PB |
113 | renames = true |
114 | ||
910c00c8 AK |
115 | [branch "devel"] |
116 | remote = origin | |
117 | merge = refs/heads/devel | |
118 | ||
e136f33b JN |
119 | # Proxy settings |
120 | [core] | |
29093c28 | 121 | gitProxy="ssh" for "kernel.org" |
e136f33b | 122 | gitProxy=default-proxy ; for the rest |
910c00c8 | 123 | |
9b25a0b5 JK |
124 | [include] |
125 | path = /path/to/foo.inc ; include by absolute path | |
126 | path = foo ; expand "foo" relative to the current file | |
4c0a89fc | 127 | path = ~/foo ; expand "foo" in your $HOME directory |
9b25a0b5 | 128 | |
1ab661dd PB |
129 | Variables |
130 | ~~~~~~~~~ | |
131 | ||
132 | Note that this list is non-comprehensive and not necessarily complete. | |
b8936cf0 FD |
133 | For command-specific variables, you will find a more detailed description |
134 | in the appropriate manual page. You will find a description of non-core | |
1ab661dd PB |
135 | porcelain configuration variables in the respective porcelain documentation. |
136 | ||
75194438 | 137 | advice.*:: |
26e94af0 JH |
138 | These variables control various optional help messages designed to |
139 | aid new users. All 'advice.*' variables default to 'true', and you | |
140 | can tell Git that you do not need help by setting these to 'false': | |
75194438 JK |
141 | + |
142 | -- | |
1184564e | 143 | pushUpdateRejected:: |
f25950f3 | 144 | Set this variable to 'false' if you want to disable |
b4505682 | 145 | 'pushNonFFCurrent', 'pushNonFFDefault', |
75e5c0dc JH |
146 | 'pushNonFFMatching', 'pushAlreadyExists', |
147 | 'pushFetchFirst', and 'pushNeedsForce' | |
b4505682 | 148 | simultaneously. |
f25950f3 CT |
149 | pushNonFFCurrent:: |
150 | Advice shown when linkgit:git-push[1] fails due to a | |
151 | non-fast-forward update to the current branch. | |
152 | pushNonFFDefault:: | |
153 | Advice to set 'push.default' to 'upstream' or 'current' | |
154 | when you ran linkgit:git-push[1] and pushed 'matching | |
155 | refs' by default (i.e. you did not provide an explicit | |
156 | refspec, and no 'push.default' configuration was set) | |
157 | and it resulted in a non-fast-forward error. | |
158 | pushNonFFMatching:: | |
159 | Advice shown when you ran linkgit:git-push[1] and pushed | |
160 | 'matching refs' explicitly (i.e. you used ':', or | |
161 | specified a refspec that isn't your current branch) and | |
162 | it resulted in a non-fast-forward error. | |
b4505682 CR |
163 | pushAlreadyExists:: |
164 | Shown when linkgit:git-push[1] rejects an update that | |
165 | does not qualify for fast-forwarding (e.g., a tag.) | |
75e5c0dc JH |
166 | pushFetchFirst:: |
167 | Shown when linkgit:git-push[1] rejects an update that | |
168 | tries to overwrite a remote ref that points at an | |
169 | object we do not have. | |
170 | pushNeedsForce:: | |
171 | Shown when linkgit:git-push[1] rejects an update that | |
172 | tries to overwrite a remote ref that points at an | |
a8a5406a RH |
173 | object that is not a commit-ish, or make the remote |
174 | ref point at an object that is not a commit-ish. | |
edf563fb | 175 | statusHints:: |
83c750ac | 176 | Show directions on how to proceed from the current |
552755a8 | 177 | state in the output of linkgit:git-status[1], in |
83c750ac | 178 | the template shown when writing commit messages in |
552755a8 MM |
179 | linkgit:git-commit[1], and in the help message shown |
180 | by linkgit:git-checkout[1] when switching branch. | |
6a38ef2c NTND |
181 | statusUoption:: |
182 | Advise to consider using the `-u` option to linkgit:git-status[1] | |
183 | when the command takes more than 2 seconds to enumerate untracked | |
184 | files. | |
4c371f91 MM |
185 | commitBeforeMerge:: |
186 | Advice shown when linkgit:git-merge[1] refuses to | |
6b677a28 | 187 | merge to avoid overwriting local changes. |
d38a30df | 188 | resolveConflict:: |
4f021b34 | 189 | Advice shown by various commands when conflicts |
d38a30df | 190 | prevent the operation from being performed. |
b706fcfe JK |
191 | implicitIdentity:: |
192 | Advice on how to set your identity configuration when | |
193 | your information is guessed from the system username and | |
26e94af0 | 194 | domain name. |
13be3e31 | 195 | detachedHead:: |
26e94af0 | 196 | Advice shown when you used linkgit:git-checkout[1] to |
13be3e31 | 197 | move to the detach HEAD state, to instruct how to create |
26e94af0 | 198 | a local branch after the fact. |
14bf2d58 PG |
199 | amWorkDir:: |
200 | Advice that shows the location of the patch file when | |
201 | linkgit:git-am[1] fails to apply it. | |
7e309446 MLM |
202 | rmHints:: |
203 | In case of failure in the output of linkgit:git-rm[1], | |
204 | show directions on how to proceed from the current state. | |
75194438 JK |
205 | -- |
206 | ||
1ab661dd PB |
207 | core.fileMode:: |
208 | If false, the executable bit differences between the index and | |
f7d650c0 | 209 | the working tree are ignored; useful on broken filesystems like FAT. |
7b357240 MO |
210 | See linkgit:git-update-index[1]. |
211 | + | |
212 | The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] | |
213 | will probe and set core.fileMode false if appropriate when the | |
214 | repository is created. | |
1ab661dd | 215 | |
7b357240 MO |
216 | core.ignorecase:: |
217 | If true, this option enables various workarounds to enable | |
2de9b711 | 218 | Git to work better on filesystems that are not case sensitive, |
7b357240 | 219 | like FAT. For example, if a directory listing finds |
2de9b711 | 220 | "makefile" when Git expects "Makefile", Git will assume |
7b357240 MO |
221 | it is really the same file, and continue to remember it as |
222 | "Makefile". | |
223 | + | |
224 | The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] | |
225 | will probe and set core.ignorecase true if appropriate when the repository | |
226 | is created. | |
227 | ||
76759c7d | 228 | core.precomposeunicode:: |
2de9b711 TA |
229 | This option is only used by Mac OS implementation of Git. |
230 | When core.precomposeunicode=true, Git reverts the unicode decomposition | |
76759c7d TB |
231 | of filenames done by Mac OS. This is useful when sharing a repository |
232 | between Mac OS and Linux or Windows. | |
2de9b711 TA |
233 | (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7). |
234 | When false, file names are handled fully transparent by Git, | |
235 | which is backward compatible with older versions of Git. | |
76759c7d | 236 | |
1ce4790b AR |
237 | core.trustctime:: |
238 | If false, the ctime differences between the index and the | |
f7d650c0 | 239 | working tree are ignored; useful when the inode change time |
1ce4790b AR |
240 | is regularly modified by something outside Git (file system |
241 | crawlers and some backup systems). | |
242 | See linkgit:git-update-index[1]. True by default. | |
243 | ||
c08e4d5b RR |
244 | core.checkstat:: |
245 | Determines which stat fields to match between the index | |
246 | and work tree. The user can set this to 'default' or | |
247 | 'minimal'. Default (or explicitly 'default'), is to check | |
248 | all fields, including the sub-second part of mtime and ctime. | |
249 | ||
9378c161 | 250 | core.quotepath:: |
5833d730 JN |
251 | The commands that output paths (e.g. 'ls-files', |
252 | 'diff'), when not given the `-z` option, will quote | |
9378c161 JH |
253 | "unusual" characters in the pathname by enclosing the |
254 | pathname in a double-quote pair and with backslashes the | |
255 | same way strings in C source code are quoted. If this | |
256 | variable is set to false, the bytes higher than 0x80 are | |
257 | not quoted but output as verbatim. Note that double | |
258 | quote, backslash and control characters are always | |
259 | quoted without `-z` regardless of the setting of this | |
260 | variable. | |
261 | ||
942e7747 EB |
262 | core.eol:: |
263 | Sets the line ending type to use in the working directory for | |
264 | files that have the `text` property set. Alternatives are | |
265 | 'lf', 'crlf' and 'native', which uses the platform's native | |
266 | line ending. The default value is `native`. See | |
267 | linkgit:gitattributes[5] for more information on end-of-line | |
268 | conversion. | |
5cb71f82 | 269 | |
21e5ad50 | 270 | core.safecrlf:: |
2de9b711 | 271 | If true, makes Git check if converting `CRLF` is reversible when |
fd6cce9e | 272 | end-of-line conversion is active. Git will verify if a command |
21e5ad50 SP |
273 | modifies a file in the work tree either directly or indirectly. |
274 | For example, committing a file followed by checking out the | |
275 | same file should yield the original file in the work tree. If | |
276 | this is not the case for the current setting of | |
2de9b711 TA |
277 | `core.autocrlf`, Git will reject the file. The variable can |
278 | be set to "warn", in which case Git will only warn about an | |
21e5ad50 SP |
279 | irreversible conversion but continue the operation. |
280 | + | |
281 | CRLF conversion bears a slight chance of corrupting data. | |
2de9b711 | 282 | When it is enabled, Git will convert CRLF to LF during commit and LF to |
21e5ad50 | 283 | CRLF during checkout. A file that contains a mixture of LF and |
2de9b711 | 284 | CRLF before the commit cannot be recreated by Git. For text |
21e5ad50 SP |
285 | files this is the right thing to do: it corrects line endings |
286 | such that we have only LF line endings in the repository. | |
287 | But for binary files that are accidentally classified as text the | |
288 | conversion can corrupt data. | |
289 | + | |
290 | If you recognize such corruption early you can easily fix it by | |
291 | setting the conversion type explicitly in .gitattributes. Right | |
292 | after committing you still have the original file in your work | |
293 | tree and this file is not yet corrupted. You can explicitly tell | |
2de9b711 | 294 | Git that this file is binary and Git will handle the file |
21e5ad50 SP |
295 | appropriately. |
296 | + | |
297 | Unfortunately, the desired effect of cleaning up text files with | |
298 | mixed line endings and the undesired effect of corrupting binary | |
299 | files cannot be distinguished. In both cases CRLFs are removed | |
300 | in an irreversible way. For text files this is the right thing | |
301 | to do because CRLFs are line endings, while for binary files | |
302 | converting CRLFs corrupts data. | |
303 | + | |
304 | Note, this safety check does not mean that a checkout will generate a | |
305 | file identical to the original file for a different setting of | |
942e7747 EB |
306 | `core.eol` and `core.autocrlf`, but only for the current one. For |
307 | example, a text file with `LF` would be accepted with `core.eol=lf` | |
308 | and could later be checked out with `core.eol=crlf`, in which case the | |
21e5ad50 SP |
309 | resulting file would contain `CRLF`, although the original file |
310 | contained `LF`. However, in both work trees the line endings would be | |
311 | consistent, that is either all `LF` or all `CRLF`, but never mixed. A | |
312 | file with mixed line endings would be reported by the `core.safecrlf` | |
313 | mechanism. | |
314 | ||
942e7747 EB |
315 | core.autocrlf:: |
316 | Setting this variable to "true" is almost the same as setting | |
317 | the `text` attribute to "auto" on all files except that text | |
318 | files are not guaranteed to be normalized: files that contain | |
319 | `CRLF` in the repository will not be touched. Use this | |
320 | setting if you want to have `CRLF` line endings in your | |
321 | working directory even though the repository does not have | |
322 | normalized line endings. This variable can be set to 'input', | |
323 | in which case no output conversion is performed. | |
324 | ||
78a8d641 JS |
325 | core.symlinks:: |
326 | If false, symbolic links are checked out as small plain files that | |
5162e697 DM |
327 | contain the link text. linkgit:git-update-index[1] and |
328 | linkgit:git-add[1] will not change the recorded type to regular | |
78a8d641 | 329 | file. Useful on filesystems like FAT that do not support |
7b357240 MO |
330 | symbolic links. |
331 | + | |
332 | The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] | |
333 | will probe and set core.symlinks false if appropriate when the repository | |
334 | is created. | |
78a8d641 | 335 | |
1ab661dd PB |
336 | core.gitProxy:: |
337 | A "proxy command" to execute (as 'command host port') instead | |
338 | of establishing direct connection to the remote server when | |
2de9b711 | 339 | using the Git protocol for fetching. If the variable value is |
1ab661dd PB |
340 | in the "COMMAND for DOMAIN" format, the command is applied only |
341 | on hostnames ending with the specified domain string. This variable | |
342 | may be set multiple times and is matched in the given order; | |
343 | the first match wins. | |
b8936cf0 FD |
344 | + |
345 | Can be overridden by the 'GIT_PROXY_COMMAND' environment variable | |
346 | (which always applies universally, without the special "for" | |
347 | handling). | |
642d0844 ES |
348 | + |
349 | The special string `none` can be used as the proxy command to | |
350 | specify that no proxy be used for a given domain pattern. | |
351 | This is useful for excluding servers inside a firewall from | |
352 | proxy use, while defaulting to a common proxy for external domains. | |
1ab661dd PB |
353 | |
354 | core.ignoreStat:: | |
b7f685a7 MSO |
355 | If true, commands which modify both the working tree and the index |
356 | will mark the updated paths with the "assume unchanged" bit in the | |
357 | index. These marked files are then assumed to stay unchanged in the | |
f7d650c0 | 358 | working tree, until you mark them otherwise manually - Git will not |
b7f685a7 MSO |
359 | detect the file changes by lstat() calls. This is useful on systems |
360 | where those are very slow, such as Microsoft Windows. | |
361 | See linkgit:git-update-index[1]. | |
1ab661dd PB |
362 | False by default. |
363 | ||
9f0bb90d JH |
364 | core.preferSymlinkRefs:: |
365 | Instead of the default "symref" format for HEAD | |
366 | and other symbolic reference files, use symbolic links. | |
367 | This is sometimes needed to work with old scripts that | |
368 | expect HEAD to be a symbolic link. | |
1ab661dd | 369 | |
e4a15f40 SP |
370 | core.bare:: |
371 | If true this repository is assumed to be 'bare' and has no | |
372 | working directory associated with it. If this is the case a | |
373 | number of commands that require a working directory will be | |
5162e697 | 374 | disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. |
e4a15f40 | 375 | + |
5162e697 DM |
376 | This setting is automatically guessed by linkgit:git-clone[1] or |
377 | linkgit:git-init[1] when the repository was created. By default a | |
e4a15f40 SP |
378 | repository that ends in "/.git" is assumed to be not bare (bare = |
379 | false), while all other repositories are assumed to be bare (bare | |
380 | = true). | |
381 | ||
892c41b9 | 382 | core.worktree:: |
ea472c1e | 383 | Set the path to the root of the working tree. |
06ada152 | 384 | This can be overridden by the GIT_WORK_TREE environment |
ea472c1e | 385 | variable and the '--work-tree' command line option. |
d424a47e | 386 | The value can be an absolute path or relative to the path to |
ea472c1e JH |
387 | the .git directory, which is either specified by --git-dir |
388 | or GIT_DIR, or automatically discovered. | |
389 | If --git-dir or GIT_DIR is specified but none of | |
302cc11a | 390 | --work-tree, GIT_WORK_TREE and core.worktree is specified, |
ea472c1e | 391 | the current working directory is regarded as the top level |
98acf759 | 392 | of your working tree. |
ea472c1e JH |
393 | + |
394 | Note that this variable is honored even when set in a configuration | |
395 | file in a ".git" subdirectory of a directory and its value differs | |
396 | from the latter directory (e.g. "/path/to/.git/config" has | |
397 | core.worktree set to "/different/path"), which is most likely a | |
2de9b711 | 398 | misconfiguration. Running Git commands in the "/path/to" directory will |
ea472c1e JH |
399 | still use "/different/path" as the root of the work tree and can cause |
400 | confusion unless you know what you are doing (e.g. you are creating a | |
401 | read-only snapshot of the same index to a location different from the | |
402 | repository's usual working tree). | |
892c41b9 | 403 | |
6de08ae6 | 404 | core.logAllRefUpdates:: |
14cd5607 | 405 | Enable the reflog. Updates to a ref <ref> is logged to the file |
4057deb5 | 406 | "$GIT_DIR/logs/<ref>", by appending the new and old |
d5fa1f1a | 407 | SHA-1, the date/time and the reason of the update, but |
4057deb5 JH |
408 | only when the file exists. If this configuration |
409 | variable is set to true, missing "$GIT_DIR/logs/<ref>" | |
cd8e3711 BW |
410 | file is automatically created for branch heads (i.e. under |
411 | refs/heads/), remote refs (i.e. under refs/remotes/), | |
412 | note refs (i.e. under refs/notes/), and the symbolic ref HEAD. | |
a862f97e JH |
413 | + |
414 | This information can be used to determine what commit | |
415 | was the tip of a branch "2 days ago". | |
416 | + | |
417 | This value is true by default in a repository that has | |
418 | a working directory associated with it, and false by | |
419 | default in a bare repository. | |
6de08ae6 | 420 | |
1ab661dd PB |
421 | core.repositoryFormatVersion:: |
422 | Internal variable identifying the repository format and layout | |
423 | version. | |
424 | ||
425 | core.sharedRepository:: | |
d5dc6a76 JF |
426 | When 'group' (or 'true'), the repository is made shareable between |
427 | several users in a group (making sure all the files and objects are | |
428 | group-writable). When 'all' (or 'world' or 'everybody'), the | |
429 | repository will be readable by all users, additionally to being | |
2de9b711 | 430 | group-shareable. When 'umask' (or 'false'), Git will use permissions |
06cbe855 HO |
431 | reported by umask(2). When '0xxx', where '0xxx' is an octal number, |
432 | files in the repository will have this mode value. '0xxx' will override | |
098082fb JH |
433 | user's umask value (whereas the other options will only override |
434 | requested parts of the user's umask value). Examples: '0660' will make | |
435 | the repo read/write-able for the owner and group, but inaccessible to | |
436 | others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a | |
06cbe855 HO |
437 | repository that is group-readable but not group-writable. |
438 | See linkgit:git-init[1]. False by default. | |
1ab661dd PB |
439 | |
440 | core.warnAmbiguousRefs:: | |
2de9b711 | 441 | If true, Git will warn you if the ref name you passed it is ambiguous |
48dfe969 | 442 | and might match multiple refs in the repository. True by default. |
1ab661dd | 443 | |
3d3e95af | 444 | core.compression:: |
960ccca6 DH |
445 | An integer -1..9, indicating a default compression level. |
446 | -1 is the zlib default. 0 means no compression, | |
447 | and 1..9 are various speed/size tradeoffs, 9 being slowest. | |
dec92309 BD |
448 | If set, this provides a default to other compression variables, |
449 | such as 'core.loosecompression' and 'pack.compression'. | |
960ccca6 DH |
450 | |
451 | core.loosecompression:: | |
12f6c308 | 452 | An integer -1..9, indicating the compression level for objects that |
960ccca6 | 453 | are not in a pack file. -1 is the zlib default. 0 means no |
12f6c308 | 454 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
960ccca6 | 455 | slowest. If not set, defaults to core.compression. If that is |
de1b2460 | 456 | not set, defaults to 1 (best speed). |
12f6c308 | 457 | |
60bb8b14 SP |
458 | core.packedGitWindowSize:: |
459 | Number of bytes of a pack file to map into memory in a | |
460 | single mapping operation. Larger window sizes may allow | |
461 | your system to process a smaller number of large pack files | |
462 | more quickly. Smaller window sizes will negatively affect | |
eb92242f | 463 | performance due to increased calls to the operating system's |
60bb8b14 | 464 | memory manager, but may improve performance when accessing |
22bac0ea SP |
465 | a large number of large pack files. |
466 | + | |
467 | Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 | |
468 | MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should | |
469 | be reasonable for all users/operating systems. You probably do | |
470 | not need to adjust this value. | |
eb92242f SP |
471 | + |
472 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
60bb8b14 | 473 | |
77ccc5bb SP |
474 | core.packedGitLimit:: |
475 | Maximum number of bytes to map simultaneously into memory | |
476 | from pack files. If Git needs to access more than this many | |
477 | bytes at once to complete an operation it will unmap existing | |
478 | regions to reclaim virtual address space within the process. | |
22bac0ea SP |
479 | + |
480 | Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. | |
481 | This should be reasonable for all users/operating systems, except on | |
482 | the largest projects. You probably do not need to adjust this value. | |
eb92242f SP |
483 | + |
484 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
77ccc5bb | 485 | |
18bdec11 SP |
486 | core.deltaBaseCacheLimit:: |
487 | Maximum number of bytes to reserve for caching base objects | |
6b677a28 | 488 | that may be referenced by multiple deltified objects. By storing the |
18bdec11 SP |
489 | entire decompressed base objects in a cache Git is able |
490 | to avoid unpacking and decompressing frequently used base | |
491 | objects multiple times. | |
492 | + | |
493 | Default is 16 MiB on all platforms. This should be reasonable | |
494 | for all users/operating systems, except on the largest projects. | |
495 | You probably do not need to adjust this value. | |
496 | + | |
497 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
498 | ||
5eef828b SP |
499 | core.bigFileThreshold:: |
500 | Files larger than this size are stored deflated, without | |
501 | attempting delta compression. Storing large files without | |
502 | delta compression avoids excessive memory usage, at the | |
503 | slight expense of increased disk usage. | |
504 | + | |
505 | Default is 512 MiB on all platforms. This should be reasonable | |
506 | for most projects as source code and other text files can still | |
507 | be delta compressed, but larger binary media files won't be. | |
508 | + | |
509 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
5eef828b | 510 | |
e8964a5b | 511 | core.excludesfile:: |
0ba956d3 | 512 | In addition to '.gitignore' (per-directory) and |
2de9b711 | 513 | '.git/info/exclude', Git looks into this file for patterns |
6cf378f0 JK |
514 | of files which are not meant to be tracked. "`~/`" is expanded |
515 | to the value of `$HOME` and "`~user/`" to the specified user's | |
dc79687e HKNN |
516 | home directory. Its default value is $XDG_CONFIG_HOME/git/ignore. |
517 | If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore | |
518 | is used instead. See linkgit:gitignore[5]. | |
0ba956d3 | 519 | |
d3e7da89 AK |
520 | core.askpass:: |
521 | Some commands (e.g. svn and http interfaces) that interactively | |
522 | ask for a password can be told to use an external program given | |
453842c9 KF |
523 | via the value of this variable. Can be overridden by the 'GIT_ASKPASS' |
524 | environment variable. If not set, fall back to the value of the | |
525 | 'SSH_ASKPASS' environment variable or, failing that, a simple password | |
526 | prompt. The external program shall be given a suitable prompt as | |
527 | command line argument and write the password on its STDOUT. | |
d3e7da89 | 528 | |
6df42ab9 PO |
529 | core.attributesfile:: |
530 | In addition to '.gitattributes' (per-directory) and | |
2de9b711 | 531 | '.git/info/attributes', Git looks into this file for attributes |
6df42ab9 | 532 | (see linkgit:gitattributes[5]). Path expansions are made the same |
684e40f6 HKNN |
533 | way as for `core.excludesfile`. Its default value is |
534 | $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not | |
535 | set or empty, $HOME/.config/git/attributes is used instead. | |
6df42ab9 | 536 | |
ef0c2abf AR |
537 | core.editor:: |
538 | Commands such as `commit` and `tag` that lets you edit | |
02783075 | 539 | messages by launching an editor uses the value of this |
ef0c2abf | 540 | variable when it is set, and the environment variable |
b4479f07 | 541 | `GIT_EDITOR` is not set. See linkgit:git-var[1]. |
ef0c2abf | 542 | |
eff80a9f JH |
543 | core.commentchar:: |
544 | Commands such as `commit` and `tag` that lets you edit | |
545 | messages consider a line that begins with this character | |
546 | commented, and removes them after the editor returns | |
547 | (default '#'). | |
548 | ||
821881d8 | 549 | sequence.editor:: |
3322ad42 | 550 | Text editor used by `git rebase -i` for editing the rebase instruction file. |
821881d8 PO |
551 | The value is meant to be interpreted by the shell when it is used. |
552 | It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable. | |
553 | When not configured the default commit message editor is used instead. | |
554 | ||
54adf370 | 555 | core.pager:: |
97d01f2a JH |
556 | Text viewer for use by Git commands (e.g., 'less'). The value |
557 | is meant to be interpreted by the shell. The order of preference | |
558 | is the `$GIT_PAGER` environment variable, then `core.pager` | |
559 | configuration, then `$PAGER`, and then the default chosen at | |
560 | compile time (usually 'less'). | |
561 | + | |
562 | When the `LESS` environment variable is unset, Git sets it to `FRSX` | |
563 | (if `LESS` environment variable is set, Git does not change it at | |
564 | all). If you want to selectively override Git's default setting | |
565 | for `LESS`, you can set `core.pager` to e.g. `less -+S`. This will | |
566 | be passed to the shell by Git, which will translate the final | |
567 | command to `LESS=FRSX less -+S`. The environment tells the command | |
568 | to set the `S` option to chop long lines but the command line | |
569 | resets it to the default to fold long lines. | |
e54c1f2d JN |
570 | + |
571 | Likewise, when the `LV` environment variable is unset, Git sets it | |
572 | to `-c`. You can override this setting by exporting `LV` with | |
573 | another value or setting `core.pager` to `lv +c`. | |
54adf370 | 574 | |
91af7ae5 JH |
575 | core.whitespace:: |
576 | A comma separated list of common whitespace problems to | |
0b444cdb TR |
577 | notice. 'git diff' will use `color.diff.whitespace` to |
578 | highlight them, and 'git apply --whitespace=error' will | |
c921cc92 JH |
579 | consider them as errors. You can prefix `-` to disable |
580 | any of them (e.g. `-trailing-space`): | |
91af7ae5 | 581 | + |
aeb84b05 | 582 | * `blank-at-eol` treats trailing whitespaces at the end of the line |
91af7ae5 JH |
583 | as an error (enabled by default). |
584 | * `space-before-tab` treats a space character that appears immediately | |
585 | before a tab character in the initial indent part of the line as an | |
586 | error (enabled by default). | |
2ce4fee8 WL |
587 | * `indent-with-non-tab` treats a line that is indented with space |
588 | characters instead of the equivalent tabs as an error (not enabled by | |
589 | default). | |
3e3ec2ab CW |
590 | * `tab-in-indent` treats a tab character in the initial indent part of |
591 | the line as an error (not enabled by default). | |
77b15bbd JH |
592 | * `blank-at-eof` treats blank lines added at the end of file as an error |
593 | (enabled by default). | |
aeb84b05 JH |
594 | * `trailing-space` is a short-hand to cover both `blank-at-eol` and |
595 | `blank-at-eof`. | |
b2979ff5 JH |
596 | * `cr-at-eol` treats a carriage-return at the end of line as |
597 | part of the line terminator, i.e. with it, `trailing-space` | |
598 | does not trigger if the character before such a carriage-return | |
599 | is not a whitespace (not enabled by default). | |
f4b05a49 | 600 | * `tabwidth=<n>` tells how many character positions a tab occupies; this |
2de9b711 | 601 | is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent` |
f4b05a49 | 602 | errors. The default tab width is 8. Allowed values are 1 to 63. |
91af7ae5 | 603 | |
aafe9fba LT |
604 | core.fsyncobjectfiles:: |
605 | This boolean will enable 'fsync()' when writing object files. | |
606 | + | |
607 | This is a total waste of time and effort on a filesystem that orders | |
608 | data writes properly, but can be useful for filesystems that do not use | |
609 | journalling (traditional UNIX filesystems) or that only journal metadata | |
610 | and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). | |
611 | ||
671c9b7e LT |
612 | core.preloadindex:: |
613 | Enable parallel index preload for operations like 'git diff' | |
614 | + | |
615 | This can speed up operations like 'git diff' and 'git status' especially | |
616 | on filesystems like NFS that have weak caching semantics and thus | |
2de9b711 | 617 | relatively high IO latencies. With this set to 'true', Git will do the |
671c9b7e LT |
618 | index comparison to the filesystem data in parallel, allowing |
619 | overlapping IO's. | |
620 | ||
348df166 JS |
621 | core.createObject:: |
622 | You can set this to 'link', in which case a hardlink followed by | |
623 | a delete of the source are used to make sure that object creation | |
624 | will not overwrite existing objects. | |
625 | + | |
626 | On some file system/operating system combinations, this is unreliable. | |
627 | Set this config setting to 'rename' there; However, This will remove the | |
628 | check that makes sure that existing object files will not get overwritten. | |
be66a6c4 | 629 | |
a97a7468 JS |
630 | core.notesRef:: |
631 | When showing commit messages, also show notes which are stored in | |
9eb3f816 JN |
632 | the given ref. The ref must be fully qualified. If the given |
633 | ref does not exist, it is not an error but means that no | |
634 | notes should be printed. | |
a97a7468 | 635 | + |
9eb3f816 JN |
636 | This setting defaults to "refs/notes/commits", and it can be overridden by |
637 | the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. | |
a97a7468 | 638 | |
08aefc9e NTND |
639 | core.sparseCheckout:: |
640 | Enable "sparse checkout" feature. See section "Sparse checkout" in | |
641 | linkgit:git-read-tree[1] for more information. | |
642 | ||
a71f09fe | 643 | core.abbrev:: |
dce96489 LT |
644 | Set the length object names are abbreviated to. If unspecified, |
645 | many commands abbreviate to 7 hexdigits, which may not be enough | |
646 | for abbreviated object names to stay unique for sufficiently long | |
647 | time. | |
648 | ||
13bd2134 | 649 | add.ignore-errors:: |
6b3020a2 | 650 | add.ignoreErrors:: |
0b444cdb | 651 | Tells 'git add' to continue adding files when some files cannot be |
13bd2134 | 652 | added due to indexing errors. Equivalent to the '--ignore-errors' |
2de9b711 | 653 | option of linkgit:git-add[1]. Older versions of Git accept only |
6b3020a2 | 654 | `add.ignore-errors`, which does not follow the usual naming |
2de9b711 | 655 | convention for configuration variables. Newer versions of Git |
6b3020a2 | 656 | honor `add.ignoreErrors` as well. |
13bd2134 | 657 | |
4514ad4f | 658 | alias.*:: |
5162e697 | 659 | Command aliases for the linkgit:git[1] command wrapper - e.g. |
4514ad4f PB |
660 | after defining "alias.last = cat-file commit HEAD", the invocation |
661 | "git last" is equivalent to "git cat-file commit HEAD". To avoid | |
99b41c84 | 662 | confusion and troubles with script usage, aliases that |
2de9b711 | 663 | hide existing Git commands are ignored. Arguments are split by |
99b41c84 PB |
664 | spaces, the usual shell quoting and escaping is supported. |
665 | quote pair and a backslash can be used to quote them. | |
f368f5a6 JH |
666 | + |
667 | If the alias expansion is prefixed with an exclamation point, | |
668 | it will be treated as a shell command. For example, defining | |
669 | "alias.new = !gitk --all --not ORIG_HEAD", the invocation | |
670 | "git new" is equivalent to running the shell command | |
595b8dbf SC |
671 | "gitk --all --not ORIG_HEAD". Note that shell commands will be |
672 | executed from the top-level directory of a repository, which may | |
673 | not necessarily be the current directory. | |
7cf16a14 MG |
674 | 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix' |
675 | from the original current directory. See linkgit:git-rev-parse[1]. | |
dfd42a3c | 676 | |
e80d4cbe SH |
677 | am.keepcr:: |
678 | If true, git-am will call git-mailsplit for patches in mbox format | |
679 | with parameter '--keep-cr'. In this case git-mailsplit will | |
6b677a28 | 680 | not remove `\r` from lines ending with `\r\n`. Can be overridden |
e80d4cbe SH |
681 | by giving '--no-keep-cr' from the command line. |
682 | See linkgit:git-am[1], linkgit:git-mailsplit[1]. | |
683 | ||
86c91f91 | 684 | apply.ignorewhitespace:: |
0b444cdb | 685 | When set to 'change', tells 'git apply' to ignore changes in |
86c91f91 GB |
686 | whitespace, in the same way as the '--ignore-space-change' |
687 | option. | |
0b444cdb | 688 | When set to one of: no, none, never, false tells 'git apply' to |
86c91f91 GB |
689 | respect all whitespace differences. |
690 | See linkgit:git-apply[1]. | |
691 | ||
1ab661dd | 692 | apply.whitespace:: |
0b444cdb | 693 | Tells 'git apply' how to handle whitespaces, in the same way |
5162e697 | 694 | as the '--whitespace' option. See linkgit:git-apply[1]. |
1ab661dd | 695 | |
9902387d | 696 | branch.autosetupmerge:: |
add0951a | 697 | Tells 'git branch' and 'git checkout' to set up new branches |
572fc81d JS |
698 | so that linkgit:git-pull[1] will appropriately merge from the |
699 | starting point branch. Note that even if this option is not set, | |
9902387d | 700 | this behavior can be chosen per-branch using the `--track` |
572fc81d JS |
701 | and `--no-track` options. The valid settings are: `false` -- no |
702 | automatic setup is done; `true` -- automatic setup is done when the | |
29b9a66f MM |
703 | starting point is a remote-tracking branch; `always` -- |
704 | automatic setup is done when the starting point is either a | |
705 | local branch or remote-tracking | |
572fc81d | 706 | branch. This option defaults to true. |
9902387d | 707 | |
c998ae9b | 708 | branch.autosetuprebase:: |
0b444cdb | 709 | When a new branch is created with 'git branch' or 'git checkout' |
2de9b711 | 710 | that tracks another branch, this variable tells Git to set |
c998ae9b DS |
711 | up pull to rebase instead of merge (see "branch.<name>.rebase"). |
712 | When `never`, rebase is never automatically set to true. | |
713 | When `local`, rebase is set to true for tracked branches of | |
714 | other local branches. | |
715 | When `remote`, rebase is set to true for tracked branches of | |
29b9a66f | 716 | remote-tracking branches. |
c998ae9b DS |
717 | When `always`, rebase will be set to true for all tracking |
718 | branches. | |
719 | See "branch.autosetupmerge" for details on how to set up a | |
720 | branch to track another branch. | |
721 | This option defaults to never. | |
722 | ||
648ad18f | 723 | branch.<name>.remote:: |
224c2171 RR |
724 | When on branch <name>, it tells 'git fetch' and 'git push' |
725 | which remote to fetch from/push to. The remote to push to | |
726 | may be overridden with `remote.pushdefault` (for all branches). | |
9f765ce6 RR |
727 | The remote to push to, for the current branch, may be further |
728 | overridden by `branch.<name>.pushremote`. If no remote is | |
729 | configured, or if you are not on any branch, it defaults to | |
730 | `origin` for fetching and `remote.pushdefault` for pushing. | |
b85ecea6 PO |
731 | Additionally, `.` (a period) is the current local repository |
732 | (a dot-repository), see `branch.<name>.merge`'s final note below. | |
9f765ce6 RR |
733 | |
734 | branch.<name>.pushremote:: | |
735 | When on branch <name>, it overrides `branch.<name>.remote` for | |
736 | pushing. It also overrides `remote.pushdefault` for pushing | |
737 | from branch <name>. When you pull from one place (e.g. your | |
738 | upstream) and push to another place (e.g. your own publishing | |
739 | repository), you would want to set `remote.pushdefault` to | |
740 | specify the remote to push to for all branches, and use this | |
741 | option to override it for a specific branch. | |
648ad18f | 742 | |
5372806a | 743 | branch.<name>.merge:: |
76d3cc50 | 744 | Defines, together with branch.<name>.remote, the upstream branch |
15a147e6 | 745 | for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which |
0b444cdb TR |
746 | branch to merge and can also affect 'git push' (see push.default). |
747 | When in branch <name>, it tells 'git fetch' the default | |
b888d61c DB |
748 | refspec to be marked for merging in FETCH_HEAD. The value is |
749 | handled like the remote part of a refspec, and must match a | |
750 | ref which is fetched from the remote given by | |
751 | "branch.<name>.remote". | |
0b444cdb TR |
752 | The merge information is used by 'git pull' (which at first calls |
753 | 'git fetch') to lookup the default branch for merging. Without | |
754 | this option, 'git pull' defaults to merge the first refspec fetched. | |
62b339a5 | 755 | Specify multiple values to get an octopus merge. |
0b444cdb | 756 | If you wish to setup 'git pull' so that it merges into <name> from |
9debc324 | 757 | another branch in the local repository, you can point |
b85ecea6 PO |
758 | branch.<name>.merge to the desired branch, and use the relative path |
759 | setting `.` (a period) for branch.<name>.remote. | |
5372806a | 760 | |
aec7b362 LH |
761 | branch.<name>.mergeoptions:: |
762 | Sets default options for merging into branch <name>. The syntax and | |
25dcc0d6 | 763 | supported options are the same as those of linkgit:git-merge[1], but |
aec7b362 LH |
764 | option values containing whitespace characters are currently not |
765 | supported. | |
766 | ||
cd67e4d4 JS |
767 | branch.<name>.rebase:: |
768 | When true, rebase the branch <name> on top of the fetched branch, | |
15ddb6fa | 769 | instead of merging the default branch from the default remote when |
6b37dff1 ÆAB |
770 | "git pull" is run. See "pull.rebase" for doing this in a non |
771 | branch-specific manner. | |
66713ef3 SH |
772 | + |
773 | When preserve, also pass `--preserve-merges` along to 'git rebase' | |
774 | so that locally committed merge commits will not be flattened | |
775 | by running 'git pull'. | |
6b37dff1 ÆAB |
776 | + |
777 | *NOTE*: this is a possibly dangerous operation; do *not* use | |
778 | it unless you understand the implications (see linkgit:git-rebase[1] | |
779 | for details). | |
cd67e4d4 | 780 | |
a5ba2cbe NTND |
781 | branch.<name>.description:: |
782 | Branch description, can be edited with | |
783 | `git branch --edit-description`. Branch description is | |
784 | automatically added in the format-patch cover letter or | |
785 | request-pull summary. | |
786 | ||
1658c614 CC |
787 | browser.<tool>.cmd:: |
788 | Specify the command to invoke the specified browser. The | |
789 | specified command is evaluated in shell with the URLs passed | |
565e135a | 790 | as arguments. (See linkgit:git-web{litdd}browse[1].) |
1658c614 | 791 | |
584627b4 CC |
792 | browser.<tool>.path:: |
793 | Override the path for the given tool that may be used to | |
ab989adf CC |
794 | browse HTML help (see '-w' option in linkgit:git-help[1]) or a |
795 | working repository in gitweb (see linkgit:git-instaweb[1]). | |
584627b4 | 796 | |
2122591b | 797 | clean.requireForce:: |
f85f7947 JX |
798 | A boolean to make git-clean do nothing unless given -f, |
799 | -i or -n. Defaults to true. | |
2122591b | 800 | |
f3673988 BG |
801 | color.branch:: |
802 | A boolean to enable/disable color in the output of | |
5162e697 | 803 | linkgit:git-branch[1]. May be set to `always`, |
cec99d8c | 804 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
f3673988 BG |
805 | only when the output is to a terminal. Defaults to false. |
806 | ||
807 | color.branch.<slot>:: | |
808 | Use customized color for branch coloration. `<slot>` is one of | |
809 | `current` (the current branch), `local` (a local branch), | |
dbda21fa FC |
810 | `remote` (a remote-tracking branch in refs/remotes/), |
811 | `upstream` (upstream tracking branch), `plain` (other | |
4f193f20 MW |
812 | refs). |
813 | + | |
814 | The value for these configuration variables is a list of colors (at most | |
815 | two) and attributes (at most one), separated by spaces. The colors | |
816 | accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, | |
817 | `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, | |
818 | `blink` and `reverse`. The first color given is the foreground; the | |
819 | second is the background. The position of the attribute, if any, | |
820 | doesn't matter. | |
f3673988 | 821 | |
a159ca0c | 822 | color.diff:: |
6999c540 MG |
823 | Whether to use ANSI escape sequences to add color to patches. |
824 | If this is set to `always`, linkgit:git-diff[1], | |
825 | linkgit:git-log[1], and linkgit:git-show[1] will use color | |
826 | for all patches. If it is set to `true` or `auto`, those | |
827 | commands will only use color when output is to the terminal. | |
828 | Defaults to false. | |
829 | + | |
a58088ab | 830 | This does not affect linkgit:git-format-patch[1] or the |
6999c540 MG |
831 | 'git-diff-{asterisk}' plumbing commands. Can be overridden on the |
832 | command line with the `--color[=<when>]` option. | |
b5376648 | 833 | |
a159ca0c | 834 | color.diff.<slot>:: |
4f193f20 MW |
835 | Use customized color for diff colorization. `<slot>` specifies |
836 | which part of the patch to use the specified color, and is one | |
837 | of `plain` (context text), `meta` (metainformation), `frag` | |
89cb73a1 BW |
838 | (hunk header), 'func' (function in hunk header), `old` (removed lines), |
839 | `new` (added lines), `commit` (commit headers), or `whitespace` | |
840 | (highlighting whitespace errors). The values of these variables may be | |
841 | specified as in color.branch.<slot>. | |
b5376648 | 842 | |
5e11bee6 NR |
843 | color.decorate.<slot>:: |
844 | Use customized color for 'git log --decorate' output. `<slot>` is one | |
845 | of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local | |
0e615b25 | 846 | branches, remote-tracking branches, tags, stash and HEAD, respectively. |
5e11bee6 | 847 | |
7e8f59d5 RS |
848 | color.grep:: |
849 | When set to `always`, always highlight matches. When `false` (or | |
850 | `never`), never. When set to `true` or `auto`, use color only | |
851 | when the output is written to the terminal. Defaults to `false`. | |
852 | ||
55f638bd ML |
853 | color.grep.<slot>:: |
854 | Use customized color for grep colorization. `<slot>` specifies which | |
855 | part of the line to use the specified color, and is one of | |
856 | + | |
857 | -- | |
00588bb5 ML |
858 | `context`;; |
859 | non-matching text in context lines (when using `-A`, `-B`, or `-C`) | |
55f638bd ML |
860 | `filename`;; |
861 | filename prefix (when not using `-h`) | |
00588bb5 ML |
862 | `function`;; |
863 | function name lines (when using `-p`) | |
55f638bd ML |
864 | `linenumber`;; |
865 | line number prefix (when using `-n`) | |
866 | `match`;; | |
867 | matching text | |
00588bb5 ML |
868 | `selected`;; |
869 | non-matching text in selected lines | |
55f638bd ML |
870 | `separator`;; |
871 | separators between fields on a line (`:`, `-`, and `=`) | |
872 | and between hunks (`--`) | |
873 | -- | |
874 | + | |
875 | The values of these variables may be specified as in color.branch.<slot>. | |
7e8f59d5 | 876 | |
b4c61ed6 | 877 | color.interactive:: |
47ee06f1 | 878 | When set to `always`, always use colors for interactive prompts |
7a9b0b80 JX |
879 | and displays (such as those used by "git-add --interactive" and |
880 | "git-clean --interactive"). When false (or `never`), never. | |
881 | When set to `true` or `auto`, use colors only when the output is | |
882 | to the terminal. Defaults to false. | |
b4c61ed6 JH |
883 | |
884 | color.interactive.<slot>:: | |
7a9b0b80 JX |
885 | Use customized color for 'git add --interactive' and 'git clean |
886 | --interactive' output. `<slot>` may be `prompt`, `header`, `help` | |
887 | or `error`, for four distinct types of normal output from | |
888 | interactive commands. The values of these variables may be | |
889 | specified as in color.branch.<slot>. | |
b4c61ed6 | 890 | |
1d77043b JH |
891 | color.pager:: |
892 | A boolean to enable/disable colored output when the pager is in | |
893 | use (default is true). | |
894 | ||
ab07ba2a MH |
895 | color.showbranch:: |
896 | A boolean to enable/disable color in the output of | |
897 | linkgit:git-show-branch[1]. May be set to `always`, | |
898 | `false` (or `never`) or `auto` (or `true`), in which case colors are used | |
899 | only when the output is to a terminal. Defaults to false. | |
900 | ||
1d77043b JH |
901 | color.status:: |
902 | A boolean to enable/disable color in the output of | |
5162e697 | 903 | linkgit:git-status[1]. May be set to `always`, |
cec99d8c | 904 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
1d77043b JH |
905 | only when the output is to a terminal. Defaults to false. |
906 | ||
907 | color.status.<slot>:: | |
908 | Use customized color for status colorization. `<slot>` is | |
909 | one of `header` (the header text of the status message), | |
82dca848 SP |
910 | `added` or `updated` (files which are added but not committed), |
911 | `changed` (files which are changed but not added in the index), | |
2de9b711 | 912 | `untracked` (files which are not tracked by Git), |
1d282327 | 913 | `branch` (the current branch), or |
950ce2e2 CP |
914 | `nobranch` (the color the 'no branch' warning is shown in, defaulting |
915 | to red). The values of these variables may be specified as in | |
916 | color.branch.<slot>. | |
1d77043b | 917 | |
6b2f2d98 | 918 | color.ui:: |
6999c540 MG |
919 | This variable determines the default value for variables such |
920 | as `color.diff` and `color.grep` that control the use of color | |
921 | per command family. Its scope will expand as more commands learn | |
922 | configuration to set a default for the `--color` option. Set it | |
4c7f1819 MM |
923 | to `false` or `never` if you prefer Git commands not to use |
924 | color unless enabled explicitly with some other configuration | |
925 | or the `--color` option. Set it to `always` if you want all | |
926 | output not intended for machine consumption to use color, to | |
927 | `true` or `auto` (this is the default since Git 1.8.4) if you | |
928 | want such output to use color when written to the terminal. | |
6b2f2d98 | 929 | |
7e29b825 NTND |
930 | column.ui:: |
931 | Specify whether supported commands should output in columns. | |
932 | This variable consists of a list of tokens separated by spaces | |
933 | or commas: | |
934 | + | |
5e62cc14 RR |
935 | These options control when the feature should be enabled |
936 | (defaults to 'never'): | |
937 | + | |
7e29b825 NTND |
938 | -- |
939 | `always`;; | |
940 | always show in columns | |
941 | `never`;; | |
942 | never show in columns | |
943 | `auto`;; | |
944 | show in columns if the output is to the terminal | |
5e62cc14 RR |
945 | -- |
946 | + | |
947 | These options control layout (defaults to 'column'). Setting any | |
948 | of these implies 'always' if none of 'always', 'never', or 'auto' are | |
949 | specified. | |
950 | + | |
951 | -- | |
077539d7 | 952 | `column`;; |
5e62cc14 | 953 | fill columns before rows |
077539d7 NTND |
954 | `row`;; |
955 | fill rows before columns | |
7e29b825 NTND |
956 | `plain`;; |
957 | show in one column | |
5e62cc14 RR |
958 | -- |
959 | + | |
960 | Finally, these options can be combined with a layout option (defaults | |
961 | to 'nodense'): | |
962 | + | |
963 | -- | |
3f8eccbe NTND |
964 | `dense`;; |
965 | make unequal size columns to utilize more space | |
966 | `nodense`;; | |
967 | make equal size columns | |
7e29b825 | 968 | -- |
7e29b825 | 969 | |
ebe31ef2 NTND |
970 | column.branch:: |
971 | Specify whether to output branch listing in `git branch` in columns. | |
972 | See `column.ui` for details. | |
973 | ||
1b8fd467 JX |
974 | column.clean:: |
975 | Specify the layout when list items in `git clean -i`, which always | |
976 | shows files and directories in columns. See `column.ui` for details. | |
977 | ||
323d0530 NTND |
978 | column.status:: |
979 | Specify whether to output untracked files in `git status` in columns. | |
980 | See `column.ui` for details. | |
981 | ||
d96e3c15 NTND |
982 | column.tag:: |
983 | Specify whether to output tag listing in `git tag` in columns. | |
984 | See `column.ui` for details. | |
985 | ||
51fb3a3d RT |
986 | commit.cleanup:: |
987 | This setting overrides the default of the `--cleanup` option in | |
988 | `git commit`. See linkgit:git-commit[1] for details. Changing the | |
989 | default can be useful when you always want to keep lines that begin | |
990 | with comment character `#` in your log message, in which case you | |
991 | would do `git config commit.cleanup whitespace` (note that you will | |
992 | have to remove the help lines that begin with `#` in the commit log | |
993 | template yourself, if you do this). | |
994 | ||
88955ed2 | 995 | commit.status:: |
bed575e4 JHI |
996 | A boolean to enable/disable inclusion of status information in the |
997 | commit message template when using an editor to prepare the commit | |
998 | message. Defaults to true. | |
999 | ||
b0f34c3d MM |
1000 | commit.template:: |
1001 | Specify a file to use as the template for new commit messages. | |
6cf378f0 | 1002 | "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the |
df2a79f4 | 1003 | specified user's home directory. |
b0f34c3d | 1004 | |
a6fc9fd3 JK |
1005 | credential.helper:: |
1006 | Specify an external helper to be called when a username or | |
1007 | password credential is needed; the helper may consult external | |
1008 | storage to avoid prompting the user for the credentials. See | |
1009 | linkgit:gitcredentials[7] for details. | |
1010 | ||
1011 | credential.useHttpPath:: | |
1012 | When acquiring credentials, consider the "path" component of an http | |
1013 | or https URL to be important. Defaults to false. See | |
1014 | linkgit:gitcredentials[7] for more information. | |
1015 | ||
1016 | credential.username:: | |
1017 | If no username is set for a network authentication, use this username | |
1018 | by default. See credential.<context>.* below, and | |
1019 | linkgit:gitcredentials[7]. | |
1020 | ||
1021 | credential.<url>.*:: | |
1022 | Any of the credential.* options above can be applied selectively to | |
1023 | some credentials. For example "credential.https://example.com.username" | |
1024 | would set the default username only for https connections to | |
1025 | example.com. See linkgit:gitcredentials[7] for details on how URLs are | |
1026 | matched. | |
1027 | ||
19299a84 | 1028 | include::diff-config.txt[] |
afcbc8e7 DA |
1029 | |
1030 | difftool.<tool>.path:: | |
1031 | Override the path for the given tool. This is useful in case | |
1032 | your tool is not in the PATH. | |
1033 | ||
1034 | difftool.<tool>.cmd:: | |
1035 | Specify the command to invoke the specified diff tool. | |
1036 | The specified command is evaluated in shell with the following | |
1037 | variables available: 'LOCAL' is set to the name of the temporary | |
1038 | file containing the contents of the diff pre-image and 'REMOTE' | |
1039 | is set to the name of the temporary file containing the contents | |
1040 | of the diff post-image. | |
1041 | ||
a904392e DA |
1042 | difftool.prompt:: |
1043 | Prompt before each invocation of the diff tool. | |
1044 | ||
be254a0e | 1045 | fetch.recurseSubmodules:: |
1fb25502 JL |
1046 | This option can be either set to a boolean value or to 'on-demand'. |
1047 | Setting it to a boolean changes the behavior of fetch and pull to | |
1048 | unconditionally recurse into submodules when set to true or to not | |
1049 | recurse at all when set to false. When set to 'on-demand' (the default | |
1050 | value), fetch and pull will only recurse into a populated submodule | |
1051 | when its superproject retrieves a commit that updates the submodule's | |
1052 | reference. | |
be254a0e | 1053 | |
5e838ea7 JH |
1054 | fetch.fsckObjects:: |
1055 | If it is set to true, git-fetch-pack will check all fetched | |
1056 | objects. It will abort in the case of a malformed object or a | |
1057 | broken link. The result of an abort are only dangling objects. | |
dab76d3a JH |
1058 | Defaults to false. If not set, the value of `transfer.fsckObjects` |
1059 | is used instead. | |
5e838ea7 | 1060 | |
af7cf268 | 1061 | fetch.unpackLimit:: |
2de9b711 | 1062 | If the number of objects fetched over the Git native |
af7cf268 JH |
1063 | transfer is below this |
1064 | limit, then the objects will be unpacked into loose object | |
1065 | files. However if the number of received objects equals or | |
1066 | exceeds this limit then the received pack will be stored as | |
1067 | a pack, after adding any missing delta bases. Storing the | |
1068 | pack from a push can make the push operation complete faster, | |
80cd9cf9 MB |
1069 | especially on slow filesystems. If not set, the value of |
1070 | `transfer.unpackLimit` is used instead. | |
af7cf268 | 1071 | |
737c5a9c MS |
1072 | fetch.prune:: |
1073 | If true, fetch will automatically behave as if the `--prune` | |
1074 | option was given on the command line. See also `remote.<name>.prune`. | |
1075 | ||
48d3448d SB |
1076 | format.attach:: |
1077 | Enable multipart/mixed attachments as the default for | |
1078 | 'format-patch'. The value can also be a double quoted string | |
1079 | which will enable attachments as the default and set the | |
1080 | value as the boundary. See the --attach option in | |
1081 | linkgit:git-format-patch[1]. | |
1082 | ||
49604a4d | 1083 | format.numbered:: |
a567fdcb BG |
1084 | A boolean which can enable or disable sequence numbers in patch |
1085 | subjects. It defaults to "auto" which enables it only if there | |
1086 | is more than one patch. It can be enabled or disabled for all | |
1087 | messages by setting it to "true" or "false". See --numbered | |
1088 | option in linkgit:git-format-patch[1]. | |
49604a4d | 1089 | |
1ab661dd PB |
1090 | format.headers:: |
1091 | Additional email headers to include in a patch to be submitted | |
5162e697 | 1092 | by mail. See linkgit:git-format-patch[1]. |
1ab661dd | 1093 | |
312a30eb | 1094 | format.to:: |
48d3448d | 1095 | format.cc:: |
312a30eb MV |
1096 | Additional recipients to include in a patch to be submitted |
1097 | by mail. See the --to and --cc options in | |
1098 | linkgit:git-format-patch[1]. | |
48d3448d SB |
1099 | |
1100 | format.subjectprefix:: | |
1101 | The default for format-patch is to output files with the '[PATCH]' | |
1102 | subject prefix. Use this variable to change that prefix. | |
1103 | ||
6622d9c7 SB |
1104 | format.signature:: |
1105 | The default for format-patch is to output a signature containing | |
2de9b711 | 1106 | the Git version number. Use this variable to change that default. |
6622d9c7 SB |
1107 | Set this variable to the empty string ("") to suppress |
1108 | signature generation. | |
1109 | ||
78cb59c8 JS |
1110 | format.suffix:: |
1111 | The default for format-patch is to output files with the suffix | |
1112 | `.patch`. Use this variable to change that suffix (make sure to | |
1113 | include the dot if you want it). | |
1ab661dd | 1114 | |
94c22a5e CR |
1115 | format.pretty:: |
1116 | The default pretty format for log/show/whatchanged command, | |
1117 | See linkgit:git-log[1], linkgit:git-show[1], | |
1118 | linkgit:git-whatchanged[1]. | |
1119 | ||
30984ed2 | 1120 | format.thread:: |
0b444cdb | 1121 | The default threading style for 'git format-patch'. Can be |
578b62bf JN |
1122 | a boolean value, or `shallow` or `deep`. `shallow` threading |
1123 | makes every mail a reply to the head of the series, | |
30984ed2 | 1124 | where the head is chosen from the cover letter, the |
6cf378f0 | 1125 | `--in-reply-to`, and the first patch mail, in this order. |
fd1ff306 | 1126 | `deep` threading makes every mail a reply to the previous one. |
30984ed2 TR |
1127 | A true boolean value is the same as `shallow`, and a false |
1128 | value disables threading. | |
1129 | ||
1d1876e9 | 1130 | format.signoff:: |
240ae2b8 FC |
1131 | A boolean value which lets you enable the `-s/--signoff` option of |
1132 | format-patch by default. *Note:* Adding the Signed-off-by: line to a | |
1133 | patch should be a conscious act and means that you certify you have | |
1134 | the rights to submit this work under the same open source license. | |
1135 | Please see the 'SubmittingPatches' document for further discussion. | |
1d1876e9 | 1136 | |
2a4c2607 FC |
1137 | format.coverLetter:: |
1138 | A boolean that controls whether to generate a cover-letter when | |
1139 | format-patch is invoked, but in addition can be set to "auto", to | |
1140 | generate a cover-letter only when there's more than one patch. | |
1141 | ||
26488f59 RR |
1142 | filter.<driver>.clean:: |
1143 | The command which is used to convert the content of a worktree | |
1144 | file to a blob upon checkin. See linkgit:gitattributes[5] for | |
1145 | details. | |
1146 | ||
1147 | filter.<driver>.smudge:: | |
1148 | The command which is used to convert the content of a blob | |
1149 | object to a worktree file upon checkout. See | |
1150 | linkgit:gitattributes[5] for details. | |
1151 | ||
0d7566a5 TT |
1152 | gc.aggressiveWindow:: |
1153 | The window size parameter used in the delta compression | |
0b444cdb | 1154 | algorithm used by 'git gc --aggressive'. This defaults |
f78683f3 | 1155 | to 250. |
0d7566a5 | 1156 | |
e9831e83 JH |
1157 | gc.auto:: |
1158 | When there are approximately more than this many loose | |
1159 | objects in the repository, `git gc --auto` will pack them. | |
1160 | Some Porcelain commands use this command to perform a | |
80cd9cf9 MB |
1161 | light-weight garbage collection from time to time. The |
1162 | default value is 6700. Setting this to 0 disables it. | |
e9831e83 | 1163 | |
17815501 JH |
1164 | gc.autopacklimit:: |
1165 | When there are more than this many packs that are not | |
1166 | marked with `*.keep` file in the repository, `git gc | |
80cd9cf9 | 1167 | --auto` consolidates them into one larger pack. The |
97063974 | 1168 | default value is 50. Setting this to 0 disables it. |
17815501 | 1169 | |
c2120e5e | 1170 | gc.packrefs:: |
efc266e8 JN |
1171 | Running `git pack-refs` in a repository renders it |
1172 | unclonable by Git versions prior to 1.5.1.2 over dumb | |
1173 | transports such as HTTP. This variable determines whether | |
4be0c352 | 1174 | 'git gc' runs `git pack-refs`. This can be set to `notbare` |
efc266e8 JN |
1175 | to enable it within all non-bare repos or it can be set to a |
1176 | boolean value. The default is `true`. | |
c2120e5e | 1177 | |
25ee9731 | 1178 | gc.pruneexpire:: |
0b444cdb | 1179 | When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. |
8e8daf33 NP |
1180 | Override the grace period with this config variable. The value |
1181 | "now" may be used to disable this grace period and always prune | |
1182 | unreachable objects immediately. | |
25ee9731 | 1183 | |
4aec56d1 | 1184 | gc.reflogexpire:: |
eb523a8d | 1185 | gc.<pattern>.reflogexpire:: |
0b444cdb | 1186 | 'git reflog expire' removes reflog entries older than |
eb523a8d JH |
1187 | this time; defaults to 90 days. With "<pattern>" (e.g. |
1188 | "refs/stash") in the middle the setting applies only to | |
1189 | the refs that match the <pattern>. | |
4aec56d1 JH |
1190 | |
1191 | gc.reflogexpireunreachable:: | |
eb523a8d | 1192 | gc.<ref>.reflogexpireunreachable:: |
0b444cdb | 1193 | 'git reflog expire' removes reflog entries older than |
4aec56d1 | 1194 | this time and are not reachable from the current tip; |
eb523a8d JH |
1195 | defaults to 30 days. With "<pattern>" (e.g. "refs/stash") |
1196 | in the middle, the setting applies only to the refs that | |
1197 | match the <pattern>. | |
4aec56d1 | 1198 | |
48c32424 JH |
1199 | gc.rerereresolved:: |
1200 | Records of conflicted merge you resolved earlier are | |
0b444cdb | 1201 | kept for this many days when 'git rerere gc' is run. |
5162e697 | 1202 | The default is 60 days. See linkgit:git-rerere[1]. |
48c32424 JH |
1203 | |
1204 | gc.rerereunresolved:: | |
1205 | Records of conflicted merge you have not resolved are | |
0b444cdb | 1206 | kept for this many days when 'git rerere gc' is run. |
5162e697 | 1207 | The default is 15 days. See linkgit:git-rerere[1]. |
48c32424 | 1208 | |
280514e1 FE |
1209 | gitcvs.commitmsgannotation:: |
1210 | Append this string to each commit message. Set to empty string | |
1211 | to disable this feature. Defaults to "via git-CVS emulator". | |
1212 | ||
1ab661dd | 1213 | gitcvs.enabled:: |
db218723 | 1214 | Whether the CVS server interface is enabled for this repository. |
5162e697 | 1215 | See linkgit:git-cvsserver[1]. |
1ab661dd PB |
1216 | |
1217 | gitcvs.logfile:: | |
db218723 | 1218 | Path to a log file where the CVS server interface well... logs |
5162e697 | 1219 | various stuff. See linkgit:git-cvsserver[1]. |
1ab661dd | 1220 | |
1707adb7 | 1221 | gitcvs.usecrlfattr:: |
5ec3e670 EB |
1222 | If true, the server will look up the end-of-line conversion |
1223 | attributes for files to determine the '-k' modes to use. If | |
2de9b711 | 1224 | the attributes force Git to treat a file as text, |
6b677a28 | 1225 | the '-k' mode will be left blank so CVS clients will |
5ec3e670 | 1226 | treat it as text. If they suppress text conversion, the file |
1168d402 | 1227 | will be set with '-kb' mode, which suppresses any newline munging |
5ec3e670 EB |
1228 | the client might otherwise do. If the attributes do not allow |
1229 | the file type to be determined, then 'gitcvs.allbinary' is | |
1230 | used. See linkgit:gitattributes[5]. | |
8a06a632 | 1231 | |
eabb0bfd | 1232 | gitcvs.allbinary:: |
90948a42 MO |
1233 | This is used if 'gitcvs.usecrlfattr' does not resolve |
1234 | the correct '-kb' mode to use. If true, all | |
1235 | unresolved files are sent to the client in | |
1236 | mode '-kb'. This causes the client to treat them | |
1237 | as binary files, which suppresses any newline munging it | |
1238 | otherwise might do. Alternatively, if it is set to "guess", | |
1239 | then the contents of the file are examined to decide if | |
1240 | it is binary, similar to 'core.autocrlf'. | |
abbf5947 | 1241 | |
04752868 FL |
1242 | gitcvs.dbname:: |
1243 | Database used by git-cvsserver to cache revision information | |
2de9b711 | 1244 | derived from the Git repository. The exact meaning depends on the |
04752868 FL |
1245 | used database driver, for SQLite (which is the default driver) this |
1246 | is a filename. Supports variable substitution (see | |
5162e697 | 1247 | linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). |
04752868 FL |
1248 | Default: '%Ggitcvs.%m.sqlite' |
1249 | ||
1250 | gitcvs.dbdriver:: | |
1251 | Used Perl DBI driver. You can specify any available driver | |
240ae2b8 | 1252 | for this here, but it might not work. git-cvsserver is tested |
04752868 FL |
1253 | with 'DBD::SQLite', reported to work with 'DBD::Pg', and |
1254 | reported *not* to work with 'DBD::mysql'. Experimental feature. | |
1255 | May not contain double colons (`:`). Default: 'SQLite'. | |
5162e697 | 1256 | See linkgit:git-cvsserver[1]. |
eabb0bfd | 1257 | |
04752868 FL |
1258 | gitcvs.dbuser, gitcvs.dbpass:: |
1259 | Database user and password. Only useful if setting 'gitcvs.dbdriver', | |
1260 | since SQLite has no concept of database users and/or passwords. | |
1261 | 'gitcvs.dbuser' supports variable substitution (see | |
5162e697 | 1262 | linkgit:git-cvsserver[1] for details). |
04752868 | 1263 | |
6aeeffd1 JE |
1264 | gitcvs.dbTableNamePrefix:: |
1265 | Database table name prefix. Prepended to the names of any | |
1266 | database tables used, allowing a single database to be used | |
1267 | for several repositories. Supports variable substitution (see | |
1268 | linkgit:git-cvsserver[1] for details). Any non-alphabetic | |
1269 | characters will be replaced with underscores. | |
1270 | ||
8a06a632 MO |
1271 | All gitcvs variables except for 'gitcvs.usecrlfattr' and |
1272 | 'gitcvs.allbinary' can also be specified as | |
1273 | 'gitcvs.<access_method>.<varname>' (where 'access_method' | |
02783075 BH |
1274 | is one of "ext" and "pserver") to make them apply only for the given |
1275 | access method. | |
04752868 | 1276 | |
cd82323f JN |
1277 | gitweb.category:: |
1278 | gitweb.description:: | |
1279 | gitweb.owner:: | |
1280 | gitweb.url:: | |
1281 | See linkgit:gitweb[1] for description. | |
1282 | ||
1283 | gitweb.avatar:: | |
1284 | gitweb.blame:: | |
1285 | gitweb.grep:: | |
1286 | gitweb.highlight:: | |
1287 | gitweb.patches:: | |
1288 | gitweb.pickaxe:: | |
1289 | gitweb.remote_heads:: | |
1290 | gitweb.showsizes:: | |
1291 | gitweb.snapshot:: | |
1292 | See linkgit:gitweb.conf[5] for description. | |
1293 | ||
b22520a3 JR |
1294 | grep.lineNumber:: |
1295 | If set to true, enable '-n' option by default. | |
1296 | ||
84befcd0 S |
1297 | grep.patternType:: |
1298 | Set the default matching behavior. Using a value of 'basic', 'extended', | |
1299 | 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp', | |
1300 | '--fixed-strings', or '--perl-regexp' option accordingly, while the | |
1301 | value 'default' will return to the default matching behavior. | |
1302 | ||
b22520a3 | 1303 | grep.extendedRegexp:: |
84befcd0 S |
1304 | If set to true, enable '--extended-regexp' option by default. This |
1305 | option is ignored when the 'grep.patternType' option is set to a value | |
1306 | other than 'default'. | |
b22520a3 | 1307 | |
0c5e70f0 JH |
1308 | gpg.program:: |
1309 | Use this custom program instead of "gpg" found on $PATH when | |
1310 | making or verifying a PGP signature. The program must support the | |
1311 | same command line interface as GPG, namely, to verify a detached | |
1312 | signature, "gpg --verify $file - <$signature" is run, and the | |
1313 | program is expected to signal a good signature by exiting with | |
1314 | code 0, and to generate an ascii-armored detached signature, the | |
1315 | standard input of "gpg -bsau $key" is fed with the contents to be | |
1316 | signed, and the program is expected to send the result to its | |
1317 | standard output. | |
1318 | ||
d84ae0db GH |
1319 | gui.commitmsgwidth:: |
1320 | Defines how wide the commit message window is in the | |
1321 | linkgit:git-gui[1]. "75" is the default. | |
1322 | ||
1323 | gui.diffcontext:: | |
1324 | Specifies how many context lines should be used in calls to diff | |
1325 | made by the linkgit:git-gui[1]. The default is "5". | |
1326 | ||
a2df1fb2 AG |
1327 | gui.encoding:: |
1328 | Specifies the default encoding to use for displaying of | |
1329 | file contents in linkgit:git-gui[1] and linkgit:gitk[1]. | |
1330 | It can be overridden by setting the 'encoding' attribute | |
1331 | for relevant files (see linkgit:gitattributes[5]). | |
1332 | If this option is not set, the tools default to the | |
1333 | locale encoding. | |
1334 | ||
d84ae0db GH |
1335 | gui.matchtrackingbranch:: |
1336 | Determines if new branches created with linkgit:git-gui[1] should | |
1337 | default to tracking remote branches with matching names or | |
1338 | not. Default: "false". | |
1339 | ||
1340 | gui.newbranchtemplate:: | |
1341 | Is used as suggested name when creating new branches using the | |
1342 | linkgit:git-gui[1]. | |
1343 | ||
1344 | gui.pruneduringfetch:: | |
8b3f3f84 | 1345 | "true" if linkgit:git-gui[1] should prune remote-tracking branches when |
d84ae0db GH |
1346 | performing a fetch. The default value is "false". |
1347 | ||
1348 | gui.trustmtime:: | |
1349 | Determines if linkgit:git-gui[1] should trust the file modification | |
1350 | timestamp or not. By default the timestamps are not trusted. | |
1351 | ||
1352 | gui.spellingdictionary:: | |
1353 | Specifies the dictionary used for spell checking commit messages in | |
1354 | the linkgit:git-gui[1]. When set to "none" spell checking is turned | |
1355 | off. | |
1356 | ||
a2df1fb2 | 1357 | gui.fastcopyblame:: |
ca768288 | 1358 | If true, 'git gui blame' uses `-C` instead of `-C -C` for original |
a2df1fb2 AG |
1359 | location detection. It makes blame significantly faster on huge |
1360 | repositories at the expense of less thorough copy detection. | |
1361 | ||
1362 | gui.copyblamethreshold:: | |
76bac890 | 1363 | Specifies the threshold to use in 'git gui blame' original location |
a2df1fb2 AG |
1364 | detection, measured in alphanumeric characters. See the |
1365 | linkgit:git-blame[1] manual for more information on copy detection. | |
1366 | ||
1367 | gui.blamehistoryctx:: | |
1368 | Specifies the radius of history context in days to show in | |
1369 | linkgit:gitk[1] for the selected commit, when the `Show History | |
1370 | Context` menu item is invoked from 'git gui blame'. If this | |
1371 | variable is set to zero, the whole history is shown. | |
1372 | ||
390c3480 AG |
1373 | guitool.<name>.cmd:: |
1374 | Specifies the shell command line to execute when the corresponding item | |
1375 | of the linkgit:git-gui[1] `Tools` menu is invoked. This option is | |
1376 | mandatory for every tool. The command is executed from the root of | |
1377 | the working directory, and in the environment it receives the name of | |
1378 | the tool as 'GIT_GUITOOL', the name of the currently selected file as | |
1379 | 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if | |
1380 | the head is detached, 'CUR_BRANCH' is empty). | |
1381 | ||
1382 | guitool.<name>.needsfile:: | |
1383 | Run the tool only if a diff is selected in the GUI. It guarantees | |
1384 | that 'FILENAME' is not empty. | |
1385 | ||
1386 | guitool.<name>.noconsole:: | |
1387 | Run the command silently, without creating a window to display its | |
1388 | output. | |
1389 | ||
1390 | guitool.<name>.norescan:: | |
1391 | Don't rescan the working directory for changes after the tool | |
1392 | finishes execution. | |
1393 | ||
1394 | guitool.<name>.confirm:: | |
1395 | Show a confirmation dialog before actually running the tool. | |
1396 | ||
1397 | guitool.<name>.argprompt:: | |
1398 | Request a string argument from the user, and pass it to the tool | |
1399 | through the 'ARGS' environment variable. Since requesting an | |
1400 | argument implies confirmation, the 'confirm' option has no effect | |
1401 | if this is enabled. If the option is set to 'true', 'yes', or '1', | |
1402 | the dialog uses a built-in generic prompt; otherwise the exact | |
1403 | value of the variable is used. | |
1404 | ||
1405 | guitool.<name>.revprompt:: | |
1406 | Request a single valid revision from the user, and set the | |
1407 | 'REVISION' environment variable. In other aspects this option | |
1408 | is similar to 'argprompt', and can be used together with it. | |
1409 | ||
1410 | guitool.<name>.revunmerged:: | |
1411 | Show only unmerged branches in the 'revprompt' subdialog. | |
1412 | This is useful for tools similar to merge or rebase, but not | |
1413 | for things like checkout or reset. | |
1414 | ||
1415 | guitool.<name>.title:: | |
1416 | Specifies the title to use for the prompt dialog. The default | |
1417 | is the tool name. | |
1418 | ||
1419 | guitool.<name>.prompt:: | |
1420 | Specifies the general prompt string to display at the top of | |
1421 | the dialog, before subsections for 'argprompt' and 'revprompt'. | |
1422 | The default value includes the actual command. | |
1423 | ||
983a9eeb CC |
1424 | help.browser:: |
1425 | Specify the browser that will be used to display help in the | |
1426 | 'web' format. See linkgit:git-help[1]. | |
1427 | ||
1428 | help.format:: | |
1429 | Override the default help format used by linkgit:git-help[1]. | |
1430 | Values 'man', 'info', 'web' and 'html' are supported. 'man' is | |
1431 | the default. 'web' and 'html' are the same. | |
1432 | ||
f0e90716 AR |
1433 | help.autocorrect:: |
1434 | Automatically correct and execute mistyped commands after | |
1435 | waiting for the given number of deciseconds (0.1 sec). If more | |
1436 | than one command can be deduced from the entered text, nothing | |
1437 | will be executed. If the value of this option is negative, | |
1438 | the corrected command will be executed immediately. If the | |
1439 | value is 0 - the command will be just shown but not executed. | |
1440 | This is the default. | |
1441 | ||
b1f809d0 SS |
1442 | help.htmlpath:: |
1443 | Specify the path where the HTML documentation resides. File system paths | |
1444 | and URLs are supported. HTML pages will be prefixed with this path when | |
1445 | help is displayed in the 'web' format. This defaults to the documentation | |
1446 | path of your Git installation. | |
1447 | ||
9c5665aa | 1448 | http.proxy:: |
b2c8c6d9 CB |
1449 | Override the HTTP proxy, normally configured using the 'http_proxy', |
1450 | 'https_proxy', and 'all_proxy' environment variables (see | |
1451 | `curl(1)`). This can be overridden on a per-remote basis; see | |
1452 | remote.<name>.proxy | |
9c5665aa | 1453 | |
bcfb95dd DB |
1454 | http.cookiefile:: |
1455 | File containing previously stored cookie lines which should be used | |
2de9b711 | 1456 | in the Git http session, if they match the server. The file format |
bcfb95dd DB |
1457 | of the file to read cookies from should be plain HTTP headers or |
1458 | the Netscape/Mozilla cookie file format (see linkgit:curl[1]). | |
1459 | NOTE that the file specified with http.cookiefile is only used as | |
912b2acf DB |
1460 | input unless http.saveCookies is set. |
1461 | ||
1462 | http.savecookies:: | |
1463 | If set, store cookies received during requests to the file specified by | |
1464 | http.cookiefile. Has no effect if http.cookiefile is unset. | |
bcfb95dd | 1465 | |
1ab661dd PB |
1466 | http.sslVerify:: |
1467 | Whether to verify the SSL certificate when fetching or pushing | |
37425065 | 1468 | over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment |
1ab661dd PB |
1469 | variable. |
1470 | ||
1471 | http.sslCert:: | |
1472 | File containing the SSL certificate when fetching or pushing | |
37425065 | 1473 | over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment |
1ab661dd PB |
1474 | variable. |
1475 | ||
1476 | http.sslKey:: | |
1477 | File containing the SSL private key when fetching or pushing | |
abda1ef5 | 1478 | over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment |
1ab661dd PB |
1479 | variable. |
1480 | ||
754ae192 | 1481 | http.sslCertPasswordProtected:: |
2de9b711 | 1482 | Enable Git's password prompt for the SSL certificate. Otherwise |
754ae192 ML |
1483 | OpenSSL will prompt the user, possibly many times, if the |
1484 | certificate or private key is encrypted. Can be overridden by the | |
1485 | 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable. | |
1486 | ||
1ab661dd PB |
1487 | http.sslCAInfo:: |
1488 | File containing the certificates to verify the peer with when | |
abda1ef5 | 1489 | fetching or pushing over HTTPS. Can be overridden by the |
1ab661dd PB |
1490 | 'GIT_SSL_CAINFO' environment variable. |
1491 | ||
1492 | http.sslCAPath:: | |
1493 | Path containing files with the CA certificates to verify the peer | |
37425065 | 1494 | with when fetching or pushing over HTTPS. Can be overridden |
1ab661dd PB |
1495 | by the 'GIT_SSL_CAPATH' environment variable. |
1496 | ||
4bc444eb MV |
1497 | http.sslTry:: |
1498 | Attempt to use AUTH SSL/TLS and encrypted data transfers | |
1499 | when connecting via regular FTP protocol. This might be needed | |
1500 | if the FTP server requires it for security reasons or you wish | |
1501 | to connect securely whenever remote FTP server supports it. | |
1502 | Default is false since it might trigger certificate verification | |
1503 | errors on misconfigured servers. | |
1504 | ||
1ab661dd | 1505 | http.maxRequests:: |
abda1ef5 | 1506 | How many HTTP requests to launch in parallel. Can be overridden |
1ab661dd PB |
1507 | by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. |
1508 | ||
ad75ebe5 TRC |
1509 | http.minSessions:: |
1510 | The number of curl sessions (counted across slots) to be kept across | |
1511 | requests. They will not be ended with curl_easy_cleanup() until | |
1512 | http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this | |
1513 | value will be capped at 1. Defaults to 1. | |
1514 | ||
de1a2fdd SP |
1515 | http.postBuffer:: |
1516 | Maximum size in bytes of the buffer used by smart HTTP | |
1517 | transports when POSTing data to the remote system. | |
1518 | For requests larger than this buffer size, HTTP/1.1 and | |
1519 | Transfer-Encoding: chunked is used to avoid creating a | |
1520 | massive pack file locally. Default is 1 MiB, which is | |
1521 | sufficient for most requests. | |
1522 | ||
1ab661dd PB |
1523 | http.lowSpeedLimit, http.lowSpeedTime:: |
1524 | If the HTTP transfer speed is less than 'http.lowSpeedLimit' | |
1525 | for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. | |
abda1ef5 | 1526 | Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and |
1ab661dd PB |
1527 | 'GIT_HTTP_LOW_SPEED_TIME' environment variables. |
1528 | ||
3ea099d4 SK |
1529 | http.noEPSV:: |
1530 | A boolean which disables using of EPSV ftp command by curl. | |
befc9c42 | 1531 | This can helpful with some "poor" ftp servers which don't |
3ea099d4 SK |
1532 | support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' |
1533 | environment variable. Default is false (curl will use EPSV). | |
1534 | ||
b1d1058c SO |
1535 | http.useragent:: |
1536 | The HTTP USER_AGENT string presented to an HTTP server. The default | |
2de9b711 | 1537 | value represents the version of the client Git such as git/1.7.1. |
b1d1058c SO |
1538 | This option allows you to override this value to a more common value |
1539 | such as Mozilla/4.0. This may be necessary, for instance, if | |
1540 | connecting through a firewall that restricts HTTP connections to a set | |
1541 | of common USER_AGENT strings (but not including those like git/1.7.1). | |
1542 | Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable. | |
1543 | ||
6a56993b KM |
1544 | http.<url>.*:: |
1545 | Any of the http.* options above can be applied selectively to some urls. | |
1546 | For a config key to match a URL, each element of the config key is | |
1547 | compared to that of the URL, in the following order: | |
1548 | + | |
1549 | -- | |
1550 | . Scheme (e.g., `https` in `https://example.com/`). This field | |
1551 | must match exactly between the config key and the URL. | |
1552 | ||
1553 | . Host/domain name (e.g., `example.com` in `https://example.com/`). | |
1554 | This field must match exactly between the config key and the URL. | |
1555 | ||
1556 | . Port number (e.g., `8080` in `http://example.com:8080/`). | |
1557 | This field must match exactly between the config key and the URL. | |
1558 | Omitted port numbers are automatically converted to the correct | |
1559 | default for the scheme before matching. | |
1560 | ||
1561 | . Path (e.g., `repo.git` in `https://example.com/repo.git`). The | |
1562 | path field of the config key must match the path field of the URL | |
1563 | either exactly or as a prefix of slash-delimited path elements. This means | |
1564 | a config key with path `foo/` matches URL path `foo/bar`. A prefix can only | |
1565 | match on a slash (`/`) boundary. Longer matches take precedence (so a config | |
1566 | key with path `foo/bar` is a better match to URL path `foo/bar` than a config | |
1567 | key with just path `foo/`). | |
1568 | ||
1569 | . User name (e.g., `user` in `https://user@example.com/repo.git`). If | |
1570 | the config key has a user name it must match the user name in the | |
1571 | URL exactly. If the config key does not have a user name, that | |
1572 | config key will match a URL with any user name (including none), | |
1573 | but at a lower precedence than a config key with a user name. | |
1574 | -- | |
1575 | + | |
1576 | The list above is ordered by decreasing precedence; a URL that matches | |
1577 | a config key's path is preferred to one that matches its user name. For example, | |
1578 | if the URL is `https://user@example.com/foo/bar` a config key match of | |
1579 | `https://example.com/foo` will be preferred over a config key match of | |
1580 | `https://user@example.com`. | |
1581 | + | |
1582 | All URLs are normalized before attempting any matching (the password part, | |
1583 | if embedded in the URL, is always ignored for matching purposes) so that | |
1584 | equivalent urls that are simply spelled differently will match properly. | |
1585 | Environment variable settings always override any matches. The urls that are | |
1586 | matched against are those given directly to Git commands. This means any URLs | |
1587 | visited as a result of a redirection do not participate in matching. | |
1588 | ||
1ab661dd | 1589 | i18n.commitEncoding:: |
2de9b711 | 1590 | Character encoding the commit messages are stored in; Git itself |
1ab661dd PB |
1591 | does not care per se, but this information is necessary e.g. when |
1592 | importing commits from emails or in the gitk graphical history | |
1593 | browser (and possibly at other places in the future or in other | |
5162e697 | 1594 | porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. |
1ab661dd | 1595 | |
d2c11a38 JH |
1596 | i18n.logOutputEncoding:: |
1597 | Character encoding the commit messages are converted to when | |
0b444cdb | 1598 | running 'git log' and friends. |
d2c11a38 | 1599 | |
b0f34c3d MM |
1600 | imap:: |
1601 | The configuration variables in the 'imap' section are described | |
1602 | in linkgit:git-imap-send[1]. | |
1603 | ||
d8a8488d SD |
1604 | init.templatedir:: |
1605 | Specify the directory from which templates will be copied. | |
1606 | (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].) | |
1607 | ||
983a9eeb CC |
1608 | instaweb.browser:: |
1609 | Specify the program that will be used to browse your working | |
1610 | repository in gitweb. See linkgit:git-instaweb[1]. | |
1611 | ||
1612 | instaweb.httpd:: | |
1613 | The HTTP daemon command-line to start gitweb on your working | |
1614 | repository. See linkgit:git-instaweb[1]. | |
1615 | ||
1616 | instaweb.local:: | |
1617 | If true the web server started by linkgit:git-instaweb[1] will | |
1618 | be bound to the local IP (127.0.0.1). | |
1619 | ||
1620 | instaweb.modulepath:: | |
6b677a28 VS |
1621 | The default module path for linkgit:git-instaweb[1] to use |
1622 | instead of /usr/lib/apache2/modules. Only used if httpd | |
1623 | is Apache. | |
983a9eeb CC |
1624 | |
1625 | instaweb.port:: | |
1626 | The port number to bind the gitweb httpd to. See | |
1627 | linkgit:git-instaweb[1]. | |
1628 | ||
ca6ac7f1 | 1629 | interactive.singlekey:: |
57f6ec02 | 1630 | In interactive commands, allow the user to provide one-letter |
ca6ac7f1 | 1631 | input with a single key (i.e., without hitting enter). |
6cf378f0 | 1632 | Currently this is used by the `--patch` mode of |
e6b57a8a CI |
1633 | linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1], |
1634 | linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this | |
1635 | setting is silently ignored if portable keystroke input | |
1636 | is not available. | |
ca6ac7f1 | 1637 | |
0c47695a JS |
1638 | log.abbrevCommit:: |
1639 | If true, makes linkgit:git-log[1], linkgit:git-show[1], and | |
6cf378f0 JK |
1640 | linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may |
1641 | override this option with `--no-abbrev-commit`. | |
0c47695a | 1642 | |
dd0ffd5b | 1643 | log.date:: |
e860795d JN |
1644 | Set the default date-time mode for the 'log' command. |
1645 | Setting a value for log.date is similar to using 'git log''s | |
6cf378f0 | 1646 | `--date` option. Possible values are `relative`, `local`, |
e860795d JN |
1647 | `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1] |
1648 | for details. | |
dd0ffd5b | 1649 | |
eb734454 SD |
1650 | log.decorate:: |
1651 | Print out the ref names of any commits that are shown by the log | |
1652 | command. If 'short' is specified, the ref name prefixes 'refs/heads/', | |
1653 | 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is | |
1654 | specified, the full ref name (including prefix) will be printed. | |
1655 | This is the same as the log commands '--decorate' option. | |
1656 | ||
0f03ca94 PB |
1657 | log.showroot:: |
1658 | If true, the initial commit will be shown as a big creation event. | |
1659 | This is equivalent to a diff against an empty tree. | |
5162e697 | 1660 | Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which |
0f03ca94 PB |
1661 | normally hide the root commit will now show it. True by default. |
1662 | ||
e6bb5f78 AP |
1663 | log.mailmap:: |
1664 | If true, makes linkgit:git-log[1], linkgit:git-show[1], and | |
1665 | linkgit:git-whatchanged[1] assume `--use-mailmap`. | |
1666 | ||
d551a488 MSO |
1667 | mailmap.file:: |
1668 | The location of an augmenting mailmap file. The default | |
1669 | mailmap, located in the root of the repository, is loaded | |
1670 | first, then the mailmap file pointed to by this variable. | |
1671 | The location of the mailmap file may be in a repository | |
1672 | subdirectory, or somewhere outside of the repository itself. | |
1673 | See linkgit:git-shortlog[1] and linkgit:git-blame[1]. | |
1674 | ||
08610900 JK |
1675 | mailmap.blob:: |
1676 | Like `mailmap.file`, but consider the value as a reference to a | |
8c473cec JK |
1677 | blob in the repository. If both `mailmap.file` and |
1678 | `mailmap.blob` are given, both are parsed, with entries from | |
1679 | `mailmap.file` taking precedence. In a bare repository, this | |
1680 | defaults to `HEAD:.mailmap`. In a non-bare repository, it | |
1681 | defaults to empty. | |
08610900 | 1682 | |
b5578f33 | 1683 | man.viewer:: |
b8322ea8 | 1684 | Specify the programs that may be used to display help in the |
b5578f33 CC |
1685 | 'man' format. See linkgit:git-help[1]. |
1686 | ||
0bb64009 CC |
1687 | man.<tool>.cmd:: |
1688 | Specify the command to invoke the specified man viewer. The | |
1689 | specified command is evaluated in shell with the man page | |
1690 | passed as argument. (See linkgit:git-help[1].) | |
1691 | ||
7e8114c0 CC |
1692 | man.<tool>.path:: |
1693 | Override the path for the given tool that may be used to | |
1694 | display help in the 'man' format. See linkgit:git-help[1]. | |
1695 | ||
b0f34c3d | 1696 | include::merge-config.txt[] |
b5412484 | 1697 | |
77680caa JS |
1698 | mergetool.<tool>.path:: |
1699 | Override the path for the given tool. This is useful in case | |
1700 | your tool is not in the PATH. | |
1701 | ||
964473a0 CB |
1702 | mergetool.<tool>.cmd:: |
1703 | Specify the command to invoke the specified merge tool. The | |
1704 | specified command is evaluated in shell with the following | |
1705 | variables available: 'BASE' is the name of a temporary file | |
1706 | containing the common base of the files to be merged, if available; | |
1707 | 'LOCAL' is the name of a temporary file containing the contents of | |
1708 | the file on the current branch; 'REMOTE' is the name of a temporary | |
1709 | file containing the contents of the file from the branch being | |
1710 | merged; 'MERGED' contains the name of the file to which the merge | |
1711 | tool should write the results of a successful merge. | |
1712 | ||
1713 | mergetool.<tool>.trustExitCode:: | |
1714 | For a custom merge command, specify whether the exit code of | |
1715 | the merge command can be used to determine whether the merge was | |
1716 | successful. If this is not set to true then the merge target file | |
1717 | timestamp is checked and the merge assumed to have been successful | |
1718 | if the file has been updated, otherwise the user is prompted to | |
1719 | indicate the success of the merge. | |
1720 | ||
44c36d1c CB |
1721 | mergetool.keepBackup:: |
1722 | After performing a merge, the original file with conflict markers | |
1723 | can be saved as a file with a `.orig` extension. If this variable | |
1724 | is set to `false` then this file is not preserved. Defaults to | |
1725 | `true` (i.e. keep the backup files). | |
1726 | ||
162eba8b | 1727 | mergetool.keepTemporaries:: |
2de9b711 | 1728 | When invoking a custom merge tool, Git uses a set of temporary |
162eba8b CB |
1729 | files to pass to the tool. If the tool returns an error and this |
1730 | variable is set to `true`, then these temporary files will be | |
1731 | preserved, otherwise they will be removed after the tool has | |
1732 | exited. Defaults to `false`. | |
1733 | ||
682b451f CB |
1734 | mergetool.prompt:: |
1735 | Prompt before each invocation of the merge resolution program. | |
1736 | ||
894a9d33 TR |
1737 | notes.displayRef:: |
1738 | The (fully qualified) refname from which to show notes when | |
1739 | showing commit messages. The value of this variable can be set | |
1740 | to a glob, in which case notes from all matching refs will be | |
1741 | shown. You may also specify this configuration variable | |
1742 | several times. A warning will be issued for refs that do not | |
1743 | exist, but a glob that does not match any refs is silently | |
1744 | ignored. | |
1745 | + | |
1746 | This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` | |
1747 | environment variable, which must be a colon separated list of refs or | |
1748 | globs. | |
1749 | + | |
1750 | The effective value of "core.notesRef" (possibly overridden by | |
1751 | GIT_NOTES_REF) is also implicitly added to the list of refs to be | |
1752 | displayed. | |
1753 | ||
6956f858 TR |
1754 | notes.rewrite.<command>:: |
1755 | When rewriting commits with <command> (currently `amend` or | |
2de9b711 | 1756 | `rebase`) and this variable is set to `true`, Git |
6956f858 TR |
1757 | automatically copies your notes from the original to the |
1758 | rewritten commit. Defaults to `true`, but see | |
1759 | "notes.rewriteRef" below. | |
6956f858 TR |
1760 | |
1761 | notes.rewriteMode:: | |
1762 | When copying notes during a rewrite (see the | |
1763 | "notes.rewrite.<command>" option), determines what to do if | |
1764 | the target commit already has a note. Must be one of | |
1765 | `overwrite`, `concatenate`, or `ignore`. Defaults to | |
1766 | `concatenate`. | |
1767 | + | |
1768 | This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` | |
1769 | environment variable. | |
1770 | ||
1771 | notes.rewriteRef:: | |
1772 | When copying notes during a rewrite, specifies the (fully | |
1773 | qualified) ref whose notes should be copied. The ref may be a | |
1774 | glob, in which case notes in all matching refs will be copied. | |
1775 | You may also specify this configuration several times. | |
1776 | + | |
1777 | Does not have a default value; you must configure this variable to | |
2b4aa89c TR |
1778 | enable note rewriting. Set it to `refs/notes/commits` to enable |
1779 | rewriting for the default commit notes. | |
cfb88e9a LAS |
1780 | + |
1781 | This setting can be overridden with the `GIT_NOTES_REWRITE_REF` | |
1782 | environment variable, which must be a colon separated list of refs or | |
1783 | globs. | |
6956f858 | 1784 | |
4812a93a | 1785 | pack.window:: |
5162e697 | 1786 | The size of the window used by linkgit:git-pack-objects[1] when no |
4812a93a JK |
1787 | window size is given on the command line. Defaults to 10. |
1788 | ||
842aaf93 | 1789 | pack.depth:: |
5162e697 | 1790 | The maximum delta depth used by linkgit:git-pack-objects[1] when no |
618e613a | 1791 | maximum depth is given on the command line. Defaults to 50. |
842aaf93 | 1792 | |
e93b15cd | 1793 | pack.windowMemory:: |
5162e697 | 1794 | The window memory size limit used by linkgit:git-pack-objects[1] |
e93b15cd BD |
1795 | when no limit is given on the command line. The value can be |
1796 | suffixed with "k", "m", or "g". Defaults to 0, meaning no | |
1797 | limit. | |
1798 | ||
960ccca6 DH |
1799 | pack.compression:: |
1800 | An integer -1..9, indicating the compression level for objects | |
1801 | in a pack file. -1 is the zlib default. 0 means no | |
1802 | compression, and 1..9 are various speed/size tradeoffs, 9 being | |
1803 | slowest. If not set, defaults to core.compression. If that is | |
dec92309 BD |
1804 | not set, defaults to -1, the zlib default, which is "a default |
1805 | compromise between speed and compression (currently equivalent | |
1806 | to level 6)." | |
89d71f75 JK |
1807 | + |
1808 | Note that changing the compression level will not automatically recompress | |
1809 | all existing objects. You can force recompression by passing the -F option | |
1810 | to linkgit:git-repack[1]. | |
960ccca6 | 1811 | |
074b2eea | 1812 | pack.deltaCacheSize:: |
02783075 | 1813 | The maximum memory in bytes used for caching deltas in |
5749b0b2 NP |
1814 | linkgit:git-pack-objects[1] before writing them out to a pack. |
1815 | This cache is used to speed up the writing object phase by not | |
1816 | having to recompute the final delta result once the best match | |
1817 | for all objects is found. Repacking large repositories on machines | |
1818 | which are tight with memory might be badly impacted by this though, | |
1819 | especially if this cache pushes the system into swapping. | |
1820 | A value of 0 means no limit. The smallest size of 1 byte may be | |
1821 | used to virtually disable this cache. Defaults to 256 MiB. | |
074b2eea | 1822 | |
e3dfddb3 | 1823 | pack.deltaCacheLimit:: |
693b86ff | 1824 | The maximum size of a delta, that is cached in |
5749b0b2 NP |
1825 | linkgit:git-pack-objects[1]. This cache is used to speed up the |
1826 | writing object phase by not having to recompute the final delta | |
1827 | result once the best match for all objects is found. Defaults to 1000. | |
e3dfddb3 | 1828 | |
693b86ff NP |
1829 | pack.threads:: |
1830 | Specifies the number of threads to spawn when searching for best | |
5162e697 | 1831 | delta matches. This requires that linkgit:git-pack-objects[1] |
693b86ff NP |
1832 | be compiled with pthreads otherwise this option is ignored with a |
1833 | warning. This is meant to reduce packing time on multiprocessor | |
1834 | machines. The required amount of memory for the delta search window | |
1835 | is however multiplied by the number of threads. | |
2de9b711 | 1836 | Specifying 0 will cause Git to auto-detect the number of CPU's |
833e3df1 | 1837 | and set the number of threads accordingly. |
693b86ff | 1838 | |
4d00bda2 NP |
1839 | pack.indexVersion:: |
1840 | Specify the default pack index version. Valid values are 1 for | |
1841 | legacy pack index used by Git versions prior to 1.5.2, and 2 for | |
1842 | the new pack index with capabilities for packs larger than 4 GB | |
1843 | as well as proper protection against the repacking of corrupted | |
c0a5e2d4 NP |
1844 | packs. Version 2 is the default. Note that version 2 is enforced |
1845 | and this config option ignored whenever the corresponding pack is | |
1846 | larger than 2 GB. | |
1847 | + | |
2de9b711 | 1848 | If you have an old Git that does not understand the version 2 `*.idx` file, |
c0a5e2d4 | 1849 | cloning or fetching over a non native protocol (e.g. "http" and "rsync") |
6cf378f0 | 1850 | that will copy both `*.pack` file and corresponding `*.idx` file from the |
c0a5e2d4 | 1851 | other side may give you a repository that cannot be accessed with your |
2de9b711 | 1852 | older version of Git. If the `*.pack` file is smaller than 2 GB, however, |
c0a5e2d4 | 1853 | you can use linkgit:git-index-pack[1] on the *.pack file to regenerate |
6cf378f0 | 1854 | the `*.idx` file. |
4d00bda2 | 1855 | |
dbdbfec4 | 1856 | pack.packSizeLimit:: |
07cf0f24 NP |
1857 | The maximum size of a pack. This setting only affects |
1858 | packing to a file when repacking, i.e. the git:// protocol | |
6cf378f0 | 1859 | is unaffected. It can be overridden by the `--max-pack-size` |
07cf0f24 NP |
1860 | option of linkgit:git-repack[1]. The minimum size allowed is |
1861 | limited to 1 MiB. The default is unlimited. | |
1862 | Common unit suffixes of 'k', 'm', or 'g' are | |
1863 | supported. | |
2b84b5a8 | 1864 | |
4370c2d6 | 1865 | pager.<cmd>:: |
9bad7233 | 1866 | If the value is boolean, turns on or off pagination of the |
2de9b711 | 1867 | output of a particular Git subcommand when writing to a tty. |
9bad7233 | 1868 | Otherwise, turns on pagination for the subcommand using the |
6cf378f0 JK |
1869 | pager specified by the value of `pager.<cmd>`. If `--paginate` |
1870 | or `--no-pager` is specified on the command line, it takes | |
9bad7233 JK |
1871 | precedence over this option. To disable pagination for all |
1872 | commands, set `core.pager` or `GIT_PAGER` to `cat`. | |
4370c2d6 | 1873 | |
8028184e WP |
1874 | pretty.<name>:: |
1875 | Alias for a --pretty= format string, as specified in | |
1876 | linkgit:git-log[1]. Any aliases defined here can be used just | |
1877 | as the built-in pretty formats could. For example, | |
6cf378f0 | 1878 | running `git config pretty.changelog "format:* %H %s"` |
8028184e | 1879 | would cause the invocation `git log --pretty=changelog` |
6cf378f0 | 1880 | to be equivalent to running `git log "--pretty=format:* %H %s"`. |
8028184e WP |
1881 | Note that an alias with the same name as a built-in format |
1882 | will be silently ignored. | |
1883 | ||
6b37dff1 ÆAB |
1884 | pull.rebase:: |
1885 | When true, rebase branches on top of the fetched branch, instead | |
1886 | of merging the default branch from the default remote when "git | |
1887 | pull" is run. See "branch.<name>.rebase" for setting this on a | |
1888 | per-branch basis. | |
66713ef3 SH |
1889 | + |
1890 | When preserve, also pass `--preserve-merges` along to 'git rebase' | |
1891 | so that locally committed merge commits will not be flattened | |
1892 | by running 'git pull'. | |
6b37dff1 ÆAB |
1893 | + |
1894 | *NOTE*: this is a possibly dangerous operation; do *not* use | |
1895 | it unless you understand the implications (see linkgit:git-rebase[1] | |
1896 | for details). | |
1897 | ||
1ab661dd PB |
1898 | pull.octopus:: |
1899 | The default merge strategy to use when pulling multiple branches | |
1900 | at once. | |
1901 | ||
1902 | pull.twohead:: | |
1903 | The default merge strategy to use when pulling a single branch. | |
1904 | ||
52153747 | 1905 | push.default:: |
87a70e4c RR |
1906 | Defines the action `git push` should take if no refspec is |
1907 | explicitly given. Different values are well-suited for | |
1908 | specific workflows; for instance, in a purely central workflow | |
1909 | (i.e. the fetch source is equal to the push destination), | |
1910 | `upstream` is probably what you want. Possible values are: | |
52153747 | 1911 | + |
b1290514 | 1912 | -- |
87a70e4c RR |
1913 | |
1914 | * `nothing` - do not push anything (error out) unless a refspec is | |
1915 | explicitly given. This is primarily meant for people who want to | |
1916 | avoid mistakes by always being explicit. | |
1917 | ||
1918 | * `current` - push the current branch to update a branch with the same | |
1919 | name on the receiving end. Works in both central and non-central | |
1920 | workflows. | |
1921 | ||
1922 | * `upstream` - push the current branch back to the branch whose | |
1923 | changes are usually integrated into the current branch (which is | |
1924 | called `@{upstream}`). This mode only makes sense if you are | |
1925 | pushing to the same repository you would normally pull from | |
1926 | (i.e. central workflow). | |
1927 | ||
ed2b1829 RR |
1928 | * `simple` - in centralized workflow, work like `upstream` with an |
1929 | added safety to refuse to push if the upstream branch's name is | |
1930 | different from the local one. | |
b1290514 | 1931 | + |
ed2b1829 RR |
1932 | When pushing to a remote that is different from the remote you normally |
1933 | pull from, work as `current`. This is the safest option and is suited | |
1934 | for beginners. | |
b1290514 | 1935 | + |
87a70e4c RR |
1936 | This mode will become the default in Git 2.0. |
1937 | ||
1938 | * `matching` - push all branches having the same name on both ends. | |
1939 | This makes the repository you are pushing to remember the set of | |
1940 | branches that will be pushed out (e.g. if you always push 'maint' | |
1941 | and 'master' there and no other branches, the repository you push | |
1942 | to will have these two branches, and your local 'maint' and | |
1943 | 'master' will be pushed there). | |
1944 | + | |
1945 | To use this mode effectively, you have to make sure _all_ the | |
1946 | branches you would push out are ready to be pushed out before | |
1947 | running 'git push', as the whole point of this mode is to allow you | |
1948 | to push all of the branches in one go. If you usually finish work | |
1949 | on only one branch and push out the result, while other branches are | |
1950 | unfinished, this mode is not for you. Also this mode is not | |
1951 | suitable for pushing into a shared central repository, as other | |
1952 | people may add new branches there, or update the tip of existing | |
1953 | branches outside your control. | |
1954 | + | |
1955 | This is currently the default, but Git 2.0 will change the default | |
1956 | to `simple`. | |
1957 | ||
1958 | -- | |
52153747 | 1959 | |
a9c3821c TAV |
1960 | rebase.stat:: |
1961 | Whether to show a diffstat of what changed upstream since the last | |
1962 | rebase. False by default. | |
1963 | ||
dd1e5b31 HV |
1964 | rebase.autosquash:: |
1965 | If set to true enable '--autosquash' option by default. | |
1966 | ||
58794775 RR |
1967 | rebase.autostash:: |
1968 | When set to true, automatically create a temporary stash | |
1969 | before the operation begins, and apply it after the operation | |
1970 | ends. This means that you can run rebase on a dirty worktree. | |
1971 | However, use with care: the final stash application after a | |
1972 | successful rebase might result in non-trivial conflicts. | |
1973 | Defaults to false. | |
1974 | ||
77e3efbf JH |
1975 | receive.autogc:: |
1976 | By default, git-receive-pack will run "git-gc --auto" after | |
1977 | receiving data from git-push and updating refs. You can stop | |
1978 | it by setting this variable to false. | |
1979 | ||
b0f34c3d MM |
1980 | receive.fsckObjects:: |
1981 | If it is set to true, git-receive-pack will check all received | |
1982 | objects. It will abort in the case of a malformed object or a | |
1983 | broken link. The result of an abort are only dangling objects. | |
dab76d3a JH |
1984 | Defaults to false. If not set, the value of `transfer.fsckObjects` |
1985 | is used instead. | |
b0f34c3d MM |
1986 | |
1987 | receive.unpackLimit:: | |
1988 | If the number of objects received in a push is below this | |
1989 | limit then the objects will be unpacked into loose object | |
1990 | files. However if the number of received objects equals or | |
1991 | exceeds this limit then the received pack will be stored as | |
1992 | a pack, after adding any missing delta bases. Storing the | |
1993 | pack from a push can make the push operation complete faster, | |
1994 | especially on slow filesystems. If not set, the value of | |
1995 | `transfer.unpackLimit` is used instead. | |
1996 | ||
42fc11c1 JH |
1997 | receive.denyDeletes:: |
1998 | If set to true, git-receive-pack will deny a ref update that deletes | |
1999 | the ref. Use this to prevent such a ref deletion via a push. | |
2000 | ||
662c83ff TR |
2001 | receive.denyDeleteCurrent:: |
2002 | If set to true, git-receive-pack will deny a ref update that | |
2003 | deletes the currently checked out branch of a non-bare repository. | |
2004 | ||
42fc11c1 | 2005 | receive.denyCurrentBranch:: |
f3838ce1 | 2006 | If set to true or "refuse", git-receive-pack will deny a ref update |
42fc11c1 JH |
2007 | to the currently checked out branch of a non-bare repository. |
2008 | Such a push is potentially dangerous because it brings the HEAD | |
2009 | out of sync with the index and working tree. If set to "warn", | |
2010 | print a warning of such a push to stderr, but allow the push to | |
2011 | proceed. If set to false or "ignore", allow such pushes with no | |
7d182f52 | 2012 | message. Defaults to "refuse". |
42fc11c1 | 2013 | |
b0f34c3d MM |
2014 | receive.denyNonFastForwards:: |
2015 | If set to true, git-receive-pack will deny a ref update which is | |
a75d7b54 | 2016 | not a fast-forward. Use this to prevent such an update via a push, |
b0f34c3d MM |
2017 | even if that push is forced. This configuration variable is |
2018 | set when initializing a shared repository. | |
2019 | ||
daebaa78 JH |
2020 | receive.hiderefs:: |
2021 | String(s) `receive-pack` uses to decide which refs to omit | |
2022 | from its initial advertisement. Use more than one | |
2023 | definitions to specify multiple prefix strings. A ref that | |
2024 | are under the hierarchies listed on the value of this | |
2025 | variable is excluded, and is hidden when responding to `git | |
2026 | push`, and an attempt to update or delete a hidden ref by | |
2027 | `git push` is rejected. | |
2028 | ||
77e3efbf JH |
2029 | receive.updateserverinfo:: |
2030 | If set to true, git-receive-pack will run git-update-server-info | |
2031 | after receiving data from git-push and updating refs. | |
2032 | ||
0a1bc12b NTND |
2033 | receive.shallowupdate:: |
2034 | If set to true, .git/shallow can be updated when new refs | |
2035 | require new shallow roots. Otherwise those refs are rejected. | |
2036 | ||
224c2171 RR |
2037 | remote.pushdefault:: |
2038 | The remote to push to by default. Overrides | |
9f765ce6 RR |
2039 | `branch.<name>.remote` for all branches, and is overridden by |
2040 | `branch.<name>.pushremote` for specific branches. | |
224c2171 | 2041 | |
0cc6d346 | 2042 | remote.<name>.url:: |
5162e697 DM |
2043 | The URL of a remote repository. See linkgit:git-fetch[1] or |
2044 | linkgit:git-push[1]. | |
0cc6d346 | 2045 | |
20346234 MG |
2046 | remote.<name>.pushurl:: |
2047 | The push URL of a remote repository. See linkgit:git-push[1]. | |
2048 | ||
14c98218 SV |
2049 | remote.<name>.proxy:: |
2050 | For remotes that require curl (http, https and ftp), the URL to | |
2051 | the proxy to use for that remote. Set to the empty string to | |
2052 | disable proxying for that remote. | |
2053 | ||
0cc6d346 | 2054 | remote.<name>.fetch:: |
5162e697 DM |
2055 | The default set of "refspec" for linkgit:git-fetch[1]. See |
2056 | linkgit:git-fetch[1]. | |
0cc6d346 SB |
2057 | |
2058 | remote.<name>.push:: | |
5162e697 DM |
2059 | The default set of "refspec" for linkgit:git-push[1]. See |
2060 | linkgit:git-push[1]. | |
0cc6d346 | 2061 | |
84bb2dfd PB |
2062 | remote.<name>.mirror:: |
2063 | If true, pushing to this remote will automatically behave | |
6cf378f0 | 2064 | as if the `--mirror` option was given on the command line. |
84bb2dfd | 2065 | |
1918278e TT |
2066 | remote.<name>.skipDefaultUpdate:: |
2067 | If true, this remote will be skipped by default when updating | |
7cc91a2f BG |
2068 | using linkgit:git-fetch[1] or the `update` subcommand of |
2069 | linkgit:git-remote[1]. | |
2070 | ||
2071 | remote.<name>.skipFetchAll:: | |
2072 | If true, this remote will be skipped by default when updating | |
2073 | using linkgit:git-fetch[1] or the `update` subcommand of | |
2074 | linkgit:git-remote[1]. | |
1918278e | 2075 | |
060aafc1 | 2076 | remote.<name>.receivepack:: |
5dee29ac | 2077 | The default program to execute on the remote side when pushing. See |
79f43f3d | 2078 | option \--receive-pack of linkgit:git-push[1]. |
060aafc1 | 2079 | |
5dee29ac UKK |
2080 | remote.<name>.uploadpack:: |
2081 | The default program to execute on the remote side when fetching. See | |
79f43f3d | 2082 | option \--upload-pack of linkgit:git-fetch-pack[1]. |
5dee29ac | 2083 | |
047f636d | 2084 | remote.<name>.tagopt:: |
79f43f3d | 2085 | Setting this value to \--no-tags disables automatic tag following when |
944163a4 ST |
2086 | fetching from remote <name>. Setting it to \--tags will fetch every |
2087 | tag from remote <name>, even if they are not reachable from remote | |
ed368546 DJ |
2088 | branch heads. Passing these flags directly to linkgit:git-fetch[1] can |
2089 | override this setting. See options \--tags and \--no-tags of | |
2090 | linkgit:git-fetch[1]. | |
047f636d | 2091 | |
c578f51d | 2092 | remote.<name>.vcs:: |
2de9b711 | 2093 | Setting this to a value <vcs> will cause Git to interact with |
c578f51d DB |
2094 | the remote with the git-remote-<vcs> helper. |
2095 | ||
737c5a9c MS |
2096 | remote.<name>.prune:: |
2097 | When set to true, fetching from this remote by default will also | |
0838bf47 MH |
2098 | remove any remote-tracking references that no longer exist on the |
2099 | remote (as if the `--prune` option was given on the command line). | |
737c5a9c MS |
2100 | Overrides `fetch.prune` settings, if any. |
2101 | ||
1918278e TT |
2102 | remotes.<group>:: |
2103 | The list of remotes which are fetched by "git remote update | |
5162e697 | 2104 | <group>". See linkgit:git-remote[1]. |
1918278e | 2105 | |
b6945f57 | 2106 | repack.usedeltabaseoffset:: |
22c79eab NP |
2107 | By default, linkgit:git-repack[1] creates packs that use |
2108 | delta-base offset. If you need to share your repository with | |
2de9b711 | 2109 | Git older than version 1.4.4, either directly or via a dumb |
22c79eab | 2110 | protocol such as http, then you need to set this option to |
2de9b711 | 2111 | "false" and repack. Access from old Git versions over the |
22c79eab | 2112 | native protocol are unaffected by this option. |
b6945f57 | 2113 | |
b0f34c3d MM |
2114 | rerere.autoupdate:: |
2115 | When set to true, `git-rerere` updates the index with the | |
2116 | resulting contents after it cleanly resolves conflicts using | |
2117 | previously recorded resolution. Defaults to false. | |
2118 | ||
2119 | rerere.enabled:: | |
2120 | Activate recording of resolved conflicts, so that identical | |
07b88a00 TR |
2121 | conflict hunks can be resolved automatically, should they be |
2122 | encountered again. By default, linkgit:git-rerere[1] is | |
2123 | enabled if there is an `rr-cache` directory under the | |
b6fb7fed JH |
2124 | `$GIT_DIR`, e.g. if "rerere" was previously used in the |
2125 | repository. | |
b0f34c3d | 2126 | |
65180c66 YD |
2127 | sendemail.identity:: |
2128 | A configuration identity. When given, causes values in the | |
2129 | 'sendemail.<identity>' subsection to take precedence over | |
2130 | values in the 'sendemail' section. The default identity is | |
2131 | the value of 'sendemail.identity'. | |
2132 | ||
2133 | sendemail.smtpencryption:: | |
2134 | See linkgit:git-send-email[1] for description. Note that this | |
2135 | setting is not subject to the 'identity' mechanism. | |
2136 | ||
2137 | sendemail.smtpssl:: | |
2138 | Deprecated alias for 'sendemail.smtpencryption = ssl'. | |
2139 | ||
35035bbf RR |
2140 | sendemail.smtpsslcertpath:: |
2141 | Path to ca-certificates (either a directory or a single file). | |
2142 | Set it to an empty string to disable certificate verification. | |
2143 | ||
65180c66 YD |
2144 | sendemail.<identity>.*:: |
2145 | Identity-specific versions of the 'sendemail.*' parameters | |
2146 | found below, taking precedence over those when the this | |
2147 | identity is selected, through command-line or | |
2148 | 'sendemail.identity'. | |
2149 | ||
2150 | sendemail.aliasesfile:: | |
2151 | sendemail.aliasfiletype:: | |
402596aa | 2152 | sendemail.annotate:: |
65180c66 YD |
2153 | sendemail.bcc:: |
2154 | sendemail.cc:: | |
2155 | sendemail.cccmd:: | |
2156 | sendemail.chainreplyto:: | |
2157 | sendemail.confirm:: | |
2158 | sendemail.envelopesender:: | |
2159 | sendemail.from:: | |
2160 | sendemail.multiedit:: | |
2161 | sendemail.signedoffbycc:: | |
2162 | sendemail.smtppass:: | |
2163 | sendemail.suppresscc:: | |
2164 | sendemail.suppressfrom:: | |
2165 | sendemail.to:: | |
69cf7bfd | 2166 | sendemail.smtpdomain:: |
65180c66 YD |
2167 | sendemail.smtpserver:: |
2168 | sendemail.smtpserverport:: | |
052fbea2 | 2169 | sendemail.smtpserveroption:: |
65180c66 YD |
2170 | sendemail.smtpuser:: |
2171 | sendemail.thread:: | |
2172 | sendemail.validate:: | |
2173 | See linkgit:git-send-email[1] for description. | |
2174 | ||
2175 | sendemail.signedoffcc:: | |
2176 | Deprecated alias for 'sendemail.signedoffbycc'. | |
2177 | ||
1ab661dd | 2178 | showbranch.default:: |
5162e697 DM |
2179 | The default set of branches for linkgit:git-show-branch[1]. |
2180 | See linkgit:git-show-branch[1]. | |
1ab661dd | 2181 | |
46f721c8 | 2182 | status.relativePaths:: |
5162e697 | 2183 | By default, linkgit:git-status[1] shows paths relative to the |
46f721c8 | 2184 | current directory. Setting this variable to `false` shows paths |
2de9b711 | 2185 | relative to the repository root (this was the default for Git |
46f721c8 JK |
2186 | prior to v1.5.4). |
2187 | ||
4fb5166a JJGG |
2188 | status.short:: |
2189 | Set to true to enable --short by default in linkgit:git-status[1]. | |
2190 | The option --no-short takes precedence over this variable. | |
2191 | ||
ec85d070 JJGG |
2192 | status.branch:: |
2193 | Set to true to enable --branch by default in linkgit:git-status[1]. | |
2194 | The option --no-branch takes precedence over this variable. | |
2195 | ||
2556b996 MM |
2196 | status.displayCommentPrefix:: |
2197 | If set to true, linkgit:git-status[1] will insert a comment | |
2198 | prefix before each output line (starting with | |
2199 | `core.commentChar`, i.e. `#` by default). This was the | |
2200 | behavior of linkgit:git-status[1] in Git 1.8.4 and previous. | |
2201 | Defaults to false. | |
2202 | ||
d6293d1f MSO |
2203 | status.showUntrackedFiles:: |
2204 | By default, linkgit:git-status[1] and linkgit:git-commit[1] show | |
2205 | files which are not currently tracked by Git. Directories which | |
2206 | contain only untracked files, are shown with the directory name | |
2207 | only. Showing untracked files means that Git needs to lstat() all | |
2208 | all the files in the whole repository, which might be slow on some | |
2209 | systems. So, this variable controls how the commands displays | |
2210 | the untracked files. Possible values are: | |
2211 | + | |
2212 | -- | |
9373bdc4 CF |
2213 | * `no` - Show no untracked files. |
2214 | * `normal` - Show untracked files and directories. | |
2215 | * `all` - Show also individual files in untracked directories. | |
d6293d1f MSO |
2216 | -- |
2217 | + | |
2218 | If this variable is not specified, it defaults to 'normal'. | |
2219 | This variable can be overridden with the -u|--untracked-files option | |
2220 | of linkgit:git-status[1] and linkgit:git-commit[1]. | |
2221 | ||
4b2343fa MG |
2222 | status.submodulesummary:: |
2223 | Defaults to false. | |
2224 | If this is set to a non zero number or true (identical to -1 or an | |
2225 | unlimited number), the submodule summary will be enabled and a | |
2226 | summary of commits for modified submodules will be shown (see | |
bb58b696 JL |
2227 | --summary-limit option of linkgit:git-submodule[1]). Please note |
2228 | that the summary output command will be suppressed for all | |
2229 | submodules when `diff.ignoreSubmodules` is set to 'all' or only | |
2230 | for those submodules where `submodule.<name>.ignore=all`. To | |
2231 | also view the summary for ignored submodules you can either use | |
2232 | the --ignore-submodules=dirty command line option or the 'git | |
2233 | submodule summary' command, which shows a similar output but does | |
2234 | not honor these settings. | |
4b2343fa | 2235 | |
0ad0a61f JN |
2236 | submodule.<name>.path:: |
2237 | submodule.<name>.url:: | |
2238 | submodule.<name>.update:: | |
2239 | The path within this project, URL, and the updating strategy | |
2240 | for a submodule. These variables are initially populated | |
2241 | by 'git submodule init'; edit them to override the | |
2242 | URL and other values found in the `.gitmodules` file. See | |
2243 | linkgit:git-submodule[1] and linkgit:gitmodules[5] for details. | |
2244 | ||
06b1abb5 TK |
2245 | submodule.<name>.branch:: |
2246 | The remote branch name for a submodule, used by `git submodule | |
2247 | update --remote`. Set this option to override the value found in | |
2248 | the `.gitmodules` file. See linkgit:git-submodule[1] and | |
2249 | linkgit:gitmodules[5] for details. | |
2250 | ||
c1a3c364 | 2251 | submodule.<name>.fetchRecurseSubmodules:: |
bf42b384 | 2252 | This option can be used to control recursive fetching of this |
469bfc96 | 2253 | submodule. It can be overridden by using the --[no-]recurse-submodules |
c1a3c364 JL |
2254 | command line option to "git fetch" and "git pull". |
2255 | This setting will override that from in the linkgit:gitmodules[5] | |
2256 | file. | |
2257 | ||
aee9c7d6 JL |
2258 | submodule.<name>.ignore:: |
2259 | Defines under what circumstances "git status" and the diff family show | |
2260 | a submodule as modified. When set to "all", it will never be considered | |
2261 | modified, "dirty" will ignore all changes to the submodules work tree and | |
2262 | takes only differences between the HEAD of the submodule and the commit | |
2263 | recorded in the superproject into account. "untracked" will additionally | |
2264 | let submodules with modified tracked files in their work tree show up. | |
2265 | Using "none" (the default when this option is not set) also shows | |
2266 | submodules that have untracked files in their work tree as changed. | |
302ad7a9 | 2267 | This setting overrides any setting made in .gitmodules for this submodule, |
3776ea9d | 2268 | both settings can be overridden on the command line by using the |
bb58b696 JL |
2269 | "--ignore-submodules" option. The 'git submodule' commands are not |
2270 | affected by this setting. | |
aee9c7d6 | 2271 | |
ce1a79b6 | 2272 | tar.umask:: |
687157c7 RS |
2273 | This variable can be used to restrict the permission bits of |
2274 | tar archive entries. The default is 0002, which turns off the | |
2275 | world write bit. The special value "user" indicates that the | |
2276 | archiving user's umask will be used instead. See umask(2) and | |
5162e697 | 2277 | linkgit:git-archive[1]. |
ce1a79b6 | 2278 | |
dab76d3a JH |
2279 | transfer.fsckObjects:: |
2280 | When `fetch.fsckObjects` or `receive.fsckObjects` are | |
2281 | not set, the value of this variable is used instead. | |
2282 | Defaults to false. | |
2283 | ||
daebaa78 JH |
2284 | transfer.hiderefs:: |
2285 | This variable can be used to set both `receive.hiderefs` | |
2286 | and `uploadpack.hiderefs` at the same time to the same | |
2287 | values. See entries for these other variables. | |
2288 | ||
b0f34c3d MM |
2289 | transfer.unpackLimit:: |
2290 | When `fetch.unpackLimit` or `receive.unpackLimit` are | |
2291 | not set, the value of this variable is used instead. | |
2292 | The default value is 100. | |
2293 | ||
daebaa78 JH |
2294 | uploadpack.hiderefs:: |
2295 | String(s) `upload-pack` uses to decide which refs to omit | |
2296 | from its initial advertisement. Use more than one | |
2297 | definitions to specify multiple prefix strings. A ref that | |
2298 | are under the hierarchies listed on the value of this | |
2299 | variable is excluded, and is hidden from `git ls-remote`, | |
2300 | `git fetch`, etc. An attempt to fetch a hidden ref by `git | |
390eb36b JH |
2301 | fetch` will fail. See also `uploadpack.allowtipsha1inwant`. |
2302 | ||
2303 | uploadpack.allowtipsha1inwant:: | |
2304 | When `uploadpack.hiderefs` is in effect, allow `upload-pack` | |
2305 | to accept a fetch request that asks for an object at the tip | |
2306 | of a hidden ref (by default, such a request is rejected). | |
2307 | see also `uploadpack.hiderefs`. | |
daebaa78 | 2308 | |
05e95155 JK |
2309 | uploadpack.keepalive:: |
2310 | When `upload-pack` has started `pack-objects`, there may be a | |
2311 | quiet period while `pack-objects` prepares the pack. Normally | |
2312 | it would output progress information, but if `--quiet` was used | |
2313 | for the fetch, `pack-objects` will output nothing at all until | |
2314 | the pack data begins. Some clients and networks may consider | |
2315 | the server to be hung and give up. Setting this option instructs | |
2316 | `upload-pack` to send an empty keepalive packet every | |
2317 | `uploadpack.keepalive` seconds. Setting this option to 0 | |
115dedd7 | 2318 | disables keepalive packets entirely. The default is 5 seconds. |
05e95155 | 2319 | |
55029ae4 DB |
2320 | url.<base>.insteadOf:: |
2321 | Any URL that starts with this value will be rewritten to | |
2322 | start, instead, with <base>. In cases where some site serves a | |
2323 | large number of repositories, and serves them with multiple | |
2324 | access methods, and some users need to use different access | |
2325 | methods, this feature allows people to specify any of the | |
2de9b711 | 2326 | equivalent URLs and have Git automatically rewrite the URL to |
55029ae4 | 2327 | the best alternative for the particular user, even for a |
844112ca JH |
2328 | never-before-seen repository on the site. When more than one |
2329 | insteadOf strings match a given URL, the longest match is used. | |
55029ae4 | 2330 | |
1c2eafb8 JT |
2331 | url.<base>.pushInsteadOf:: |
2332 | Any URL that starts with this value will not be pushed to; | |
2333 | instead, it will be rewritten to start with <base>, and the | |
2334 | resulting URL will be pushed to. In cases where some site serves | |
2335 | a large number of repositories, and serves them with multiple | |
2336 | access methods, some of which do not allow push, this feature | |
2de9b711 | 2337 | allows people to specify a pull-only URL and have Git |
1c2eafb8 JT |
2338 | automatically use an appropriate URL to push, even for a |
2339 | never-before-seen repository on the site. When more than one | |
2340 | pushInsteadOf strings match a given URL, the longest match is | |
2de9b711 | 2341 | used. If a remote has an explicit pushurl, Git will ignore this |
1c2eafb8 JT |
2342 | setting for that remote. |
2343 | ||
1ab661dd PB |
2344 | user.email:: |
2345 | Your email address to be recorded in any newly created commits. | |
28a94f88 | 2346 | Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and |
5162e697 | 2347 | 'EMAIL' environment variables. See linkgit:git-commit-tree[1]. |
1ab661dd PB |
2348 | |
2349 | user.name:: | |
2350 | Your full name to be recorded in any newly created commits. | |
abda1ef5 | 2351 | Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' |
5162e697 | 2352 | environment variables. See linkgit:git-commit-tree[1]. |
1ab661dd | 2353 | |
d67778ec | 2354 | user.signingkey:: |
f0551693 NV |
2355 | If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the |
2356 | key you want it to automatically when creating a signed tag or | |
2357 | commit, you can override the default selection with this variable. | |
2358 | This option is passed unchanged to gpg's --local-user parameter, | |
2359 | so you may specify a key using any method that gpg supports. | |
d67778ec | 2360 | |
983a9eeb CC |
2361 | web.browser:: |
2362 | Specify a web browser that may be used by some commands. | |
2363 | Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] | |
2364 | may use it. |