]>
Commit | Line | Data |
---|---|---|
1ab661dd PB |
1 | CONFIGURATION FILE |
2 | ------------------ | |
3 | ||
4 | The git configuration file contains a number of variables that affect | |
773002a7 | 5 | the git command's 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 | |
b7ee2266 SB |
11 | The configuration variables are used by both the git plumbing |
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 PB |
14 | dot-separated segment and the section name is everything before the last |
15 | dot. The variable names are case-insensitive and only alphanumeric | |
16 | characters are allowed. Some variables may appear multiple times. | |
17 | ||
e136f33b JN |
18 | Syntax |
19 | ~~~~~~ | |
20 | ||
1ab661dd | 21 | The syntax is fairly flexible and permissive; whitespaces are mostly |
e136f33b JN |
22 | ignored. The '#' and ';' characters begin comments to the end of line, |
23 | blank lines are ignored. | |
24 | ||
25 | The file consists of sections and variables. A section begins with | |
26 | the name of the section in square brackets and continues until the next | |
27 | section begins. Section names are not case sensitive. Only alphanumeric | |
dcb11263 | 28 | characters, `-` and `.` are allowed in section names. Each variable |
773002a7 SB |
29 | must belong to some section, which means that there must be a section |
30 | header before the first setting of a variable. | |
e136f33b JN |
31 | |
32 | Sections can be further divided into subsections. To begin a subsection | |
33 | put its name in double quotes, separated by space from the section name, | |
773002a7 | 34 | in the section header, like in the example below: |
e136f33b JN |
35 | |
36 | -------- | |
37 | [section "subsection"] | |
38 | ||
39 | -------- | |
40 | ||
b7ee2266 SB |
41 | Subsection names are case sensitive and can contain any characters except |
42 | newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`, | |
43 | respectively). Section headers cannot span multiple | |
e136f33b JN |
44 | lines. Variables may belong directly to a section or to a given subsection. |
45 | You can have `[section]` if you have `[section "subsection"]`, but you | |
46 | don't need to. | |
47 | ||
773002a7 SB |
48 | There is also a case insensitive alternative `[section.subsection]` syntax. |
49 | In this syntax, subsection names follow the same restrictions as for section | |
50 | names. | |
e136f33b | 51 | |
2ceb639f NS |
52 | All the other lines (and the remainder of the line after the section |
53 | header) are recognized as setting variables, in the form | |
e136f33b JN |
54 | 'name = value'. If there is no equal sign on the line, the entire line |
55 | is taken as 'name' and the variable is recognized as boolean "true". | |
56 | The variable names are case-insensitive and only alphanumeric | |
dcb11263 | 57 | characters and `-` are allowed. There can be more than one value |
e136f33b JN |
58 | for a given variable; we say then that variable is multivalued. |
59 | ||
60 | Leading and trailing whitespace in a variable value is discarded. | |
61 | Internal whitespace within a variable value is retained verbatim. | |
62 | ||
63 | The values following the equals sign in variable assign are all either | |
64 | a string, an integer, or a boolean. Boolean values may be given as yes/no, | |
0cbcf7ad | 65 | 0/1, true/false or on/off. Case is not significant in boolean values, when |
e136f33b | 66 | converting value to the canonical form using '--bool' type specifier; |
0b444cdb | 67 | 'git config' will ensure that the output is "true" or "false". |
e136f33b JN |
68 | |
69 | String values may be entirely or partially enclosed in double quotes. | |
773002a7 SB |
70 | You need to enclose variable values in double quotes if you want to |
71 | preserve leading or trailing whitespace, or if the variable value contains | |
72 | comment characters (i.e. it contains '#' or ';'). | |
73 | Double quote `"` and backslash `\` characters in variable values must | |
dcb11263 | 74 | be escaped: use `\"` for `"` and `\\` for `\`. |
e136f33b | 75 | |
dcb11263 CJ |
76 | The following escape sequences (beside `\"` and `\\`) are recognized: |
77 | `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB) | |
78 | and `\b` for backspace (BS). No other char escape sequence, nor octal | |
e136f33b JN |
79 | char sequences are valid. |
80 | ||
773002a7 | 81 | Variable values ending in a `\` are continued on the next line in the |
e136f33b JN |
82 | customary UNIX fashion. |
83 | ||
773002a7 | 84 | Some variables may require a special value format. |
1ab661dd PB |
85 | |
86 | Example | |
87 | ~~~~~~~ | |
88 | ||
89 | # Core variables | |
90 | [core] | |
91 | ; Don't trust file modes | |
92 | filemode = false | |
93 | ||
94 | # Our diff algorithm | |
95 | [diff] | |
6bb9e51b | 96 | external = /usr/local/bin/diff-wrapper |
1ab661dd PB |
97 | renames = true |
98 | ||
910c00c8 AK |
99 | [branch "devel"] |
100 | remote = origin | |
101 | merge = refs/heads/devel | |
102 | ||
e136f33b JN |
103 | # Proxy settings |
104 | [core] | |
29093c28 | 105 | gitProxy="ssh" for "kernel.org" |
e136f33b | 106 | gitProxy=default-proxy ; for the rest |
910c00c8 | 107 | |
1ab661dd PB |
108 | Variables |
109 | ~~~~~~~~~ | |
110 | ||
111 | Note that this list is non-comprehensive and not necessarily complete. | |
b8936cf0 FD |
112 | For command-specific variables, you will find a more detailed description |
113 | in the appropriate manual page. You will find a description of non-core | |
1ab661dd PB |
114 | porcelain configuration variables in the respective porcelain documentation. |
115 | ||
75194438 JK |
116 | advice.*:: |
117 | When set to 'true', display the given optional help message. | |
118 | When set to 'false', do not display. The configuration variables | |
119 | are: | |
120 | + | |
121 | -- | |
122 | pushNonFastForward:: | |
123 | Advice shown when linkgit:git-push[1] refuses | |
124 | non-fast-forward refs. Default: true. | |
edf563fb JK |
125 | statusHints:: |
126 | Directions on how to stage/unstage/add shown in the | |
127 | output of linkgit:git-status[1] and the template shown | |
128 | when writing commit messages. Default: true. | |
4c371f91 MM |
129 | commitBeforeMerge:: |
130 | Advice shown when linkgit:git-merge[1] refuses to | |
131 | merge to avoid overwritting local changes. | |
132 | Default: true. | |
d38a30df MM |
133 | resolveConflict:: |
134 | Advices shown by various commands when conflicts | |
135 | prevent the operation from being performed. | |
136 | Default: true. | |
b706fcfe JK |
137 | implicitIdentity:: |
138 | Advice on how to set your identity configuration when | |
139 | your information is guessed from the system username and | |
140 | domain name. Default: true. | |
13be3e31 JH |
141 | |
142 | detachedHead:: | |
143 | Advice shown when you used linkgit::git-checkout[1] to | |
144 | move to the detach HEAD state, to instruct how to create | |
145 | a local branch after the fact. Default: true. | |
75194438 JK |
146 | -- |
147 | ||
1ab661dd PB |
148 | core.fileMode:: |
149 | If false, the executable bit differences between the index and | |
150 | the working copy are ignored; useful on broken filesystems like FAT. | |
7b357240 MO |
151 | See linkgit:git-update-index[1]. |
152 | + | |
153 | The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] | |
154 | will probe and set core.fileMode false if appropriate when the | |
155 | repository is created. | |
1ab661dd | 156 | |
adbc0b6b DP |
157 | core.ignoreCygwinFSTricks:: |
158 | This option is only used by Cygwin implementation of Git. If false, | |
159 | the Cygwin stat() and lstat() functions are used. This may be useful | |
160 | if your repository consists of a few separate directories joined in | |
161 | one hierarchy using Cygwin mount. If true, Git uses native Win32 API | |
162 | whenever it is possible and falls back to Cygwin functions only to | |
163 | handle symbol links. The native mode is more than twice faster than | |
7faee6b8 ML |
164 | normal Cygwin l/stat() functions. True by default, unless core.filemode |
165 | is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's | |
166 | POSIX emulation is required to support core.filemode. | |
adbc0b6b | 167 | |
7b357240 MO |
168 | core.ignorecase:: |
169 | If true, this option enables various workarounds to enable | |
170 | git to work better on filesystems that are not case sensitive, | |
171 | like FAT. For example, if a directory listing finds | |
172 | "makefile" when git expects "Makefile", git will assume | |
173 | it is really the same file, and continue to remember it as | |
174 | "Makefile". | |
175 | + | |
176 | The default is false, except linkgit:git-clone[1] or linkgit:git-init[1] | |
177 | will probe and set core.ignorecase true if appropriate when the repository | |
178 | is created. | |
179 | ||
1ce4790b AR |
180 | core.trustctime:: |
181 | If false, the ctime differences between the index and the | |
182 | working copy are ignored; useful when the inode change time | |
183 | is regularly modified by something outside Git (file system | |
184 | crawlers and some backup systems). | |
185 | See linkgit:git-update-index[1]. True by default. | |
186 | ||
9378c161 | 187 | core.quotepath:: |
5833d730 JN |
188 | The commands that output paths (e.g. 'ls-files', |
189 | 'diff'), when not given the `-z` option, will quote | |
9378c161 JH |
190 | "unusual" characters in the pathname by enclosing the |
191 | pathname in a double-quote pair and with backslashes the | |
192 | same way strings in C source code are quoted. If this | |
193 | variable is set to false, the bytes higher than 0x80 are | |
194 | not quoted but output as verbatim. Note that double | |
195 | quote, backslash and control characters are always | |
196 | quoted without `-z` regardless of the setting of this | |
197 | variable. | |
198 | ||
5cb71f82 FL |
199 | core.autocrlf:: |
200 | If true, makes git convert `CRLF` at the end of lines in text files to | |
c308b9c2 WP |
201 | `LF` when reading from the work tree, and convert in reverse when |
202 | writing to the work tree. The variable can be set to | |
5cb71f82 | 203 | 'input', in which case the conversion happens only while |
c308b9c2 WP |
204 | reading from the work tree but files are written out to the work |
205 | tree with `LF` at the end of lines. A file is considered | |
ff686686 MO |
206 | "text" (i.e. be subjected to the autocrlf mechanism) based on |
207 | the file's `crlf` attribute, or if `crlf` is unspecified, | |
208 | based on the file's contents. See linkgit:gitattributes[5]. | |
5cb71f82 | 209 | |
21e5ad50 SP |
210 | core.safecrlf:: |
211 | If true, makes git check if converting `CRLF` as controlled by | |
212 | `core.autocrlf` is reversible. Git will verify if a command | |
213 | modifies a file in the work tree either directly or indirectly. | |
214 | For example, committing a file followed by checking out the | |
215 | same file should yield the original file in the work tree. If | |
216 | this is not the case for the current setting of | |
217 | `core.autocrlf`, git will reject the file. The variable can | |
218 | be set to "warn", in which case git will only warn about an | |
219 | irreversible conversion but continue the operation. | |
220 | + | |
221 | CRLF conversion bears a slight chance of corrupting data. | |
222 | autocrlf=true will convert CRLF to LF during commit and LF to | |
223 | CRLF during checkout. A file that contains a mixture of LF and | |
224 | CRLF before the commit cannot be recreated by git. For text | |
225 | files this is the right thing to do: it corrects line endings | |
226 | such that we have only LF line endings in the repository. | |
227 | But for binary files that are accidentally classified as text the | |
228 | conversion can corrupt data. | |
229 | + | |
230 | If you recognize such corruption early you can easily fix it by | |
231 | setting the conversion type explicitly in .gitattributes. Right | |
232 | after committing you still have the original file in your work | |
233 | tree and this file is not yet corrupted. You can explicitly tell | |
234 | git that this file is binary and git will handle the file | |
235 | appropriately. | |
236 | + | |
237 | Unfortunately, the desired effect of cleaning up text files with | |
238 | mixed line endings and the undesired effect of corrupting binary | |
239 | files cannot be distinguished. In both cases CRLFs are removed | |
240 | in an irreversible way. For text files this is the right thing | |
241 | to do because CRLFs are line endings, while for binary files | |
242 | converting CRLFs corrupts data. | |
243 | + | |
244 | Note, this safety check does not mean that a checkout will generate a | |
245 | file identical to the original file for a different setting of | |
246 | `core.autocrlf`, but only for the current one. For example, a text | |
247 | file with `LF` would be accepted with `core.autocrlf=input` and could | |
248 | later be checked out with `core.autocrlf=true`, in which case the | |
249 | resulting file would contain `CRLF`, although the original file | |
250 | contained `LF`. However, in both work trees the line endings would be | |
251 | consistent, that is either all `LF` or all `CRLF`, but never mixed. A | |
252 | file with mixed line endings would be reported by the `core.safecrlf` | |
253 | mechanism. | |
254 | ||
78a8d641 JS |
255 | core.symlinks:: |
256 | If false, symbolic links are checked out as small plain files that | |
5162e697 DM |
257 | contain the link text. linkgit:git-update-index[1] and |
258 | linkgit:git-add[1] will not change the recorded type to regular | |
78a8d641 | 259 | file. Useful on filesystems like FAT that do not support |
7b357240 MO |
260 | symbolic links. |
261 | + | |
262 | The default is true, except linkgit:git-clone[1] or linkgit:git-init[1] | |
263 | will probe and set core.symlinks false if appropriate when the repository | |
264 | is created. | |
78a8d641 | 265 | |
1ab661dd PB |
266 | core.gitProxy:: |
267 | A "proxy command" to execute (as 'command host port') instead | |
268 | of establishing direct connection to the remote server when | |
269 | using the git protocol for fetching. If the variable value is | |
270 | in the "COMMAND for DOMAIN" format, the command is applied only | |
271 | on hostnames ending with the specified domain string. This variable | |
272 | may be set multiple times and is matched in the given order; | |
273 | the first match wins. | |
b8936cf0 FD |
274 | + |
275 | Can be overridden by the 'GIT_PROXY_COMMAND' environment variable | |
276 | (which always applies universally, without the special "for" | |
277 | handling). | |
642d0844 ES |
278 | + |
279 | The special string `none` can be used as the proxy command to | |
280 | specify that no proxy be used for a given domain pattern. | |
281 | This is useful for excluding servers inside a firewall from | |
282 | proxy use, while defaulting to a common proxy for external domains. | |
1ab661dd PB |
283 | |
284 | core.ignoreStat:: | |
b7f685a7 MSO |
285 | If true, commands which modify both the working tree and the index |
286 | will mark the updated paths with the "assume unchanged" bit in the | |
287 | index. These marked files are then assumed to stay unchanged in the | |
288 | working copy, until you mark them otherwise manually - Git will not | |
289 | detect the file changes by lstat() calls. This is useful on systems | |
290 | where those are very slow, such as Microsoft Windows. | |
291 | See linkgit:git-update-index[1]. | |
1ab661dd PB |
292 | False by default. |
293 | ||
9f0bb90d JH |
294 | core.preferSymlinkRefs:: |
295 | Instead of the default "symref" format for HEAD | |
296 | and other symbolic reference files, use symbolic links. | |
297 | This is sometimes needed to work with old scripts that | |
298 | expect HEAD to be a symbolic link. | |
1ab661dd | 299 | |
e4a15f40 SP |
300 | core.bare:: |
301 | If true this repository is assumed to be 'bare' and has no | |
302 | working directory associated with it. If this is the case a | |
303 | number of commands that require a working directory will be | |
5162e697 | 304 | disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. |
e4a15f40 | 305 | + |
5162e697 DM |
306 | This setting is automatically guessed by linkgit:git-clone[1] or |
307 | linkgit:git-init[1] when the repository was created. By default a | |
e4a15f40 SP |
308 | repository that ends in "/.git" is assumed to be not bare (bare = |
309 | false), while all other repositories are assumed to be bare (bare | |
310 | = true). | |
311 | ||
892c41b9 | 312 | core.worktree:: |
f5e025a9 | 313 | Set the path to the root of the work tree. |
06ada152 | 314 | This can be overridden by the GIT_WORK_TREE environment |
302cc11a | 315 | variable and the '--work-tree' command line option. It can be |
f5e025a9 NTND |
316 | an absolute path or a relative path to the .git directory, |
317 | either specified by --git-dir or GIT_DIR, or automatically | |
318 | discovered. | |
319 | If --git-dir or GIT_DIR are specified but none of | |
302cc11a | 320 | --work-tree, GIT_WORK_TREE and core.worktree is specified, |
f5e025a9 NTND |
321 | the current working directory is regarded as the root of the |
322 | work tree. | |
323 | + | |
324 | Note that this variable is honored even when set in a configuration | |
325 | file in a ".git" subdirectory of a directory, and its value differs | |
326 | from the latter directory (e.g. "/path/to/.git/config" has | |
327 | core.worktree set to "/different/path"), which is most likely a | |
328 | misconfiguration. Running git commands in "/path/to" directory will | |
329 | still use "/different/path" as the root of the work tree and can cause | |
330 | great confusion to the users. | |
892c41b9 | 331 | |
6de08ae6 | 332 | core.logAllRefUpdates:: |
14cd5607 | 333 | Enable the reflog. Updates to a ref <ref> is logged to the file |
4057deb5 JH |
334 | "$GIT_DIR/logs/<ref>", by appending the new and old |
335 | SHA1, the date/time and the reason of the update, but | |
336 | only when the file exists. If this configuration | |
337 | variable is set to true, missing "$GIT_DIR/logs/<ref>" | |
338 | file is automatically created for branch heads. | |
a862f97e JH |
339 | + |
340 | This information can be used to determine what commit | |
341 | was the tip of a branch "2 days ago". | |
342 | + | |
343 | This value is true by default in a repository that has | |
344 | a working directory associated with it, and false by | |
345 | default in a bare repository. | |
6de08ae6 | 346 | |
1ab661dd PB |
347 | core.repositoryFormatVersion:: |
348 | Internal variable identifying the repository format and layout | |
349 | version. | |
350 | ||
351 | core.sharedRepository:: | |
d5dc6a76 JF |
352 | When 'group' (or 'true'), the repository is made shareable between |
353 | several users in a group (making sure all the files and objects are | |
354 | group-writable). When 'all' (or 'world' or 'everybody'), the | |
355 | repository will be readable by all users, additionally to being | |
356 | group-shareable. When 'umask' (or 'false'), git will use permissions | |
06cbe855 HO |
357 | reported by umask(2). When '0xxx', where '0xxx' is an octal number, |
358 | files in the repository will have this mode value. '0xxx' will override | |
098082fb JH |
359 | user's umask value (whereas the other options will only override |
360 | requested parts of the user's umask value). Examples: '0660' will make | |
361 | the repo read/write-able for the owner and group, but inaccessible to | |
362 | others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a | |
06cbe855 HO |
363 | repository that is group-readable but not group-writable. |
364 | See linkgit:git-init[1]. False by default. | |
1ab661dd PB |
365 | |
366 | core.warnAmbiguousRefs:: | |
367 | If true, git will warn you if the ref name you passed it is ambiguous | |
368 | and might match multiple refs in the .git/refs/ tree. True by default. | |
369 | ||
3d3e95af | 370 | core.compression:: |
960ccca6 DH |
371 | An integer -1..9, indicating a default compression level. |
372 | -1 is the zlib default. 0 means no compression, | |
373 | and 1..9 are various speed/size tradeoffs, 9 being slowest. | |
dec92309 BD |
374 | If set, this provides a default to other compression variables, |
375 | such as 'core.loosecompression' and 'pack.compression'. | |
960ccca6 DH |
376 | |
377 | core.loosecompression:: | |
12f6c308 | 378 | An integer -1..9, indicating the compression level for objects that |
960ccca6 | 379 | are not in a pack file. -1 is the zlib default. 0 means no |
12f6c308 | 380 | compression, and 1..9 are various speed/size tradeoffs, 9 being |
960ccca6 | 381 | slowest. If not set, defaults to core.compression. If that is |
de1b2460 | 382 | not set, defaults to 1 (best speed). |
12f6c308 | 383 | |
60bb8b14 SP |
384 | core.packedGitWindowSize:: |
385 | Number of bytes of a pack file to map into memory in a | |
386 | single mapping operation. Larger window sizes may allow | |
387 | your system to process a smaller number of large pack files | |
388 | more quickly. Smaller window sizes will negatively affect | |
eb92242f | 389 | performance due to increased calls to the operating system's |
60bb8b14 | 390 | memory manager, but may improve performance when accessing |
22bac0ea SP |
391 | a large number of large pack files. |
392 | + | |
393 | Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32 | |
394 | MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should | |
395 | be reasonable for all users/operating systems. You probably do | |
396 | not need to adjust this value. | |
eb92242f SP |
397 | + |
398 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
60bb8b14 | 399 | |
77ccc5bb SP |
400 | core.packedGitLimit:: |
401 | Maximum number of bytes to map simultaneously into memory | |
402 | from pack files. If Git needs to access more than this many | |
403 | bytes at once to complete an operation it will unmap existing | |
404 | regions to reclaim virtual address space within the process. | |
22bac0ea SP |
405 | + |
406 | Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms. | |
407 | This should be reasonable for all users/operating systems, except on | |
408 | the largest projects. You probably do not need to adjust this value. | |
eb92242f SP |
409 | + |
410 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
77ccc5bb | 411 | |
18bdec11 SP |
412 | core.deltaBaseCacheLimit:: |
413 | Maximum number of bytes to reserve for caching base objects | |
414 | that multiple deltafied objects reference. By storing the | |
415 | entire decompressed base objects in a cache Git is able | |
416 | to avoid unpacking and decompressing frequently used base | |
417 | objects multiple times. | |
418 | + | |
419 | Default is 16 MiB on all platforms. This should be reasonable | |
420 | for all users/operating systems, except on the largest projects. | |
421 | You probably do not need to adjust this value. | |
422 | + | |
423 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
424 | ||
5eef828b SP |
425 | core.bigFileThreshold:: |
426 | Files larger than this size are stored deflated, without | |
427 | attempting delta compression. Storing large files without | |
428 | delta compression avoids excessive memory usage, at the | |
429 | slight expense of increased disk usage. | |
430 | + | |
431 | Default is 512 MiB on all platforms. This should be reasonable | |
432 | for most projects as source code and other text files can still | |
433 | be delta compressed, but larger binary media files won't be. | |
434 | + | |
435 | Common unit suffixes of 'k', 'm', or 'g' are supported. | |
436 | + | |
437 | Currently only linkgit:git-fast-import[1] honors this setting. | |
438 | ||
e8964a5b | 439 | core.excludesfile:: |
0ba956d3 JS |
440 | In addition to '.gitignore' (per-directory) and |
441 | '.git/info/exclude', git looks into this file for patterns | |
0f7fb21a JH |
442 | of files which are not meant to be tracked. "{tilde}/" is expanded |
443 | to the value of `$HOME` and "{tilde}user/" to the specified user's | |
df2a79f4 | 444 | home directory. See linkgit:gitignore[5]. |
0ba956d3 | 445 | |
ef0c2abf AR |
446 | core.editor:: |
447 | Commands such as `commit` and `tag` that lets you edit | |
02783075 | 448 | messages by launching an editor uses the value of this |
ef0c2abf | 449 | variable when it is set, and the environment variable |
b4479f07 | 450 | `GIT_EDITOR` is not set. See linkgit:git-var[1]. |
ef0c2abf | 451 | |
54adf370 | 452 | core.pager:: |
ab54cd6c JN |
453 | The command that git will use to paginate output. Can |
454 | be overridden with the `GIT_PAGER` environment | |
455 | variable. Note that git sets the `LESS` environment | |
456 | variable to `FRSX` if it is unset when it runs the | |
457 | pager. One can change these settings by setting the | |
fee75457 CF |
458 | `LESS` variable to some other value. Alternately, |
459 | these settings can be overridden on a project or | |
460 | global basis by setting the `core.pager` option. | |
461 | Setting `core.pager` has no affect on the `LESS` | |
462 | environment variable behaviour above, so if you want | |
463 | to override git's default settings this way, you need | |
464 | to be explicit. For example, to disable the S option | |
465 | in a backward compatible manner, set `core.pager` | |
dcb11263 | 466 | to `less -+$LESS -FRX`. This will be passed to the |
fee75457 | 467 | shell by git, which will translate the final command to |
dcb11263 | 468 | `LESS=FRSX less -+FRSX -FRX`. |
54adf370 | 469 | |
91af7ae5 JH |
470 | core.whitespace:: |
471 | A comma separated list of common whitespace problems to | |
0b444cdb TR |
472 | notice. 'git diff' will use `color.diff.whitespace` to |
473 | highlight them, and 'git apply --whitespace=error' will | |
c921cc92 JH |
474 | consider them as errors. You can prefix `-` to disable |
475 | any of them (e.g. `-trailing-space`): | |
91af7ae5 | 476 | + |
aeb84b05 | 477 | * `blank-at-eol` treats trailing whitespaces at the end of the line |
91af7ae5 JH |
478 | as an error (enabled by default). |
479 | * `space-before-tab` treats a space character that appears immediately | |
480 | before a tab character in the initial indent part of the line as an | |
481 | error (enabled by default). | |
482 | * `indent-with-non-tab` treats a line that is indented with 8 or more | |
127f72e6 | 483 | space characters as an error (not enabled by default). |
3e3ec2ab CW |
484 | * `tab-in-indent` treats a tab character in the initial indent part of |
485 | the line as an error (not enabled by default). | |
77b15bbd JH |
486 | * `blank-at-eof` treats blank lines added at the end of file as an error |
487 | (enabled by default). | |
aeb84b05 JH |
488 | * `trailing-space` is a short-hand to cover both `blank-at-eol` and |
489 | `blank-at-eof`. | |
b2979ff5 JH |
490 | * `cr-at-eol` treats a carriage-return at the end of line as |
491 | part of the line terminator, i.e. with it, `trailing-space` | |
492 | does not trigger if the character before such a carriage-return | |
493 | is not a whitespace (not enabled by default). | |
91af7ae5 | 494 | |
aafe9fba LT |
495 | core.fsyncobjectfiles:: |
496 | This boolean will enable 'fsync()' when writing object files. | |
497 | + | |
498 | This is a total waste of time and effort on a filesystem that orders | |
499 | data writes properly, but can be useful for filesystems that do not use | |
500 | journalling (traditional UNIX filesystems) or that only journal metadata | |
501 | and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback"). | |
502 | ||
671c9b7e LT |
503 | core.preloadindex:: |
504 | Enable parallel index preload for operations like 'git diff' | |
505 | + | |
506 | This can speed up operations like 'git diff' and 'git status' especially | |
507 | on filesystems like NFS that have weak caching semantics and thus | |
508 | relatively high IO latencies. With this set to 'true', git will do the | |
509 | index comparison to the filesystem data in parallel, allowing | |
510 | overlapping IO's. | |
511 | ||
348df166 JS |
512 | core.createObject:: |
513 | You can set this to 'link', in which case a hardlink followed by | |
514 | a delete of the source are used to make sure that object creation | |
515 | will not overwrite existing objects. | |
516 | + | |
517 | On some file system/operating system combinations, this is unreliable. | |
518 | Set this config setting to 'rename' there; However, This will remove the | |
519 | check that makes sure that existing object files will not get overwritten. | |
be66a6c4 | 520 | |
a97a7468 JS |
521 | core.notesRef:: |
522 | When showing commit messages, also show notes which are stored in | |
9eb3f816 JN |
523 | the given ref. The ref must be fully qualified. If the given |
524 | ref does not exist, it is not an error but means that no | |
525 | notes should be printed. | |
a97a7468 | 526 | + |
9eb3f816 JN |
527 | This setting defaults to "refs/notes/commits", and it can be overridden by |
528 | the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. | |
a97a7468 | 529 | |
08aefc9e NTND |
530 | core.sparseCheckout:: |
531 | Enable "sparse checkout" feature. See section "Sparse checkout" in | |
532 | linkgit:git-read-tree[1] for more information. | |
533 | ||
13bd2134 | 534 | add.ignore-errors:: |
0b444cdb | 535 | Tells 'git add' to continue adding files when some files cannot be |
13bd2134 SB |
536 | added due to indexing errors. Equivalent to the '--ignore-errors' |
537 | option of linkgit:git-add[1]. | |
538 | ||
4514ad4f | 539 | alias.*:: |
5162e697 | 540 | Command aliases for the linkgit:git[1] command wrapper - e.g. |
4514ad4f PB |
541 | after defining "alias.last = cat-file commit HEAD", the invocation |
542 | "git last" is equivalent to "git cat-file commit HEAD". To avoid | |
99b41c84 PB |
543 | confusion and troubles with script usage, aliases that |
544 | hide existing git commands are ignored. Arguments are split by | |
545 | spaces, the usual shell quoting and escaping is supported. | |
546 | quote pair and a backslash can be used to quote them. | |
f368f5a6 JH |
547 | + |
548 | If the alias expansion is prefixed with an exclamation point, | |
549 | it will be treated as a shell command. For example, defining | |
550 | "alias.new = !gitk --all --not ORIG_HEAD", the invocation | |
551 | "git new" is equivalent to running the shell command | |
595b8dbf SC |
552 | "gitk --all --not ORIG_HEAD". Note that shell commands will be |
553 | executed from the top-level directory of a repository, which may | |
554 | not necessarily be the current directory. | |
dfd42a3c | 555 | |
e80d4cbe SH |
556 | am.keepcr:: |
557 | If true, git-am will call git-mailsplit for patches in mbox format | |
558 | with parameter '--keep-cr'. In this case git-mailsplit will | |
559 | not remove `\r` from lines ending with `\r\n`. Can be overrriden | |
560 | by giving '--no-keep-cr' from the command line. | |
561 | See linkgit:git-am[1], linkgit:git-mailsplit[1]. | |
562 | ||
86c91f91 | 563 | apply.ignorewhitespace:: |
0b444cdb | 564 | When set to 'change', tells 'git apply' to ignore changes in |
86c91f91 GB |
565 | whitespace, in the same way as the '--ignore-space-change' |
566 | option. | |
0b444cdb | 567 | When set to one of: no, none, never, false tells 'git apply' to |
86c91f91 GB |
568 | respect all whitespace differences. |
569 | See linkgit:git-apply[1]. | |
570 | ||
1ab661dd | 571 | apply.whitespace:: |
0b444cdb | 572 | Tells 'git apply' how to handle whitespaces, in the same way |
5162e697 | 573 | as the '--whitespace' option. See linkgit:git-apply[1]. |
1ab661dd | 574 | |
9902387d | 575 | branch.autosetupmerge:: |
add0951a | 576 | Tells 'git branch' and 'git checkout' to set up new branches |
572fc81d JS |
577 | so that linkgit:git-pull[1] will appropriately merge from the |
578 | starting point branch. Note that even if this option is not set, | |
9902387d | 579 | this behavior can be chosen per-branch using the `--track` |
572fc81d JS |
580 | and `--no-track` options. The valid settings are: `false` -- no |
581 | automatic setup is done; `true` -- automatic setup is done when the | |
582 | starting point is a remote branch; `always` -- automatic setup is | |
583 | done when the starting point is either a local branch or remote | |
584 | branch. This option defaults to true. | |
9902387d | 585 | |
c998ae9b | 586 | branch.autosetuprebase:: |
0b444cdb | 587 | When a new branch is created with 'git branch' or 'git checkout' |
c998ae9b DS |
588 | that tracks another branch, this variable tells git to set |
589 | up pull to rebase instead of merge (see "branch.<name>.rebase"). | |
590 | When `never`, rebase is never automatically set to true. | |
591 | When `local`, rebase is set to true for tracked branches of | |
592 | other local branches. | |
593 | When `remote`, rebase is set to true for tracked branches of | |
594 | remote branches. | |
595 | When `always`, rebase will be set to true for all tracking | |
596 | branches. | |
597 | See "branch.autosetupmerge" for details on how to set up a | |
598 | branch to track another branch. | |
599 | This option defaults to never. | |
600 | ||
648ad18f | 601 | branch.<name>.remote:: |
0b444cdb | 602 | When in branch <name>, it tells 'git fetch' and 'git push' which |
76d3cc50 SB |
603 | remote to fetch from/push to. It defaults to `origin` if no remote is |
604 | configured. `origin` is also used if you are not on any branch. | |
648ad18f | 605 | |
5372806a | 606 | branch.<name>.merge:: |
76d3cc50 | 607 | Defines, together with branch.<name>.remote, the upstream branch |
0b444cdb TR |
608 | for the given branch. It tells 'git fetch'/'git pull' which |
609 | branch to merge and can also affect 'git push' (see push.default). | |
610 | When in branch <name>, it tells 'git fetch' the default | |
b888d61c DB |
611 | refspec to be marked for merging in FETCH_HEAD. The value is |
612 | handled like the remote part of a refspec, and must match a | |
613 | ref which is fetched from the remote given by | |
614 | "branch.<name>.remote". | |
0b444cdb TR |
615 | The merge information is used by 'git pull' (which at first calls |
616 | 'git fetch') to lookup the default branch for merging. Without | |
617 | this option, 'git pull' defaults to merge the first refspec fetched. | |
62b339a5 | 618 | Specify multiple values to get an octopus merge. |
0b444cdb | 619 | If you wish to setup 'git pull' so that it merges into <name> from |
9debc324 PB |
620 | another branch in the local repository, you can point |
621 | branch.<name>.merge to the desired branch, and use the special setting | |
622 | `.` (a period) for branch.<name>.remote. | |
5372806a | 623 | |
aec7b362 LH |
624 | branch.<name>.mergeoptions:: |
625 | Sets default options for merging into branch <name>. The syntax and | |
25dcc0d6 | 626 | supported options are the same as those of linkgit:git-merge[1], but |
aec7b362 LH |
627 | option values containing whitespace characters are currently not |
628 | supported. | |
629 | ||
cd67e4d4 JS |
630 | branch.<name>.rebase:: |
631 | When true, rebase the branch <name> on top of the fetched branch, | |
15ddb6fa DS |
632 | instead of merging the default branch from the default remote when |
633 | "git pull" is run. | |
cd67e4d4 | 634 | *NOTE*: this is a possibly dangerous operation; do *not* use |
5162e697 | 635 | it unless you understand the implications (see linkgit:git-rebase[1] |
cd67e4d4 JS |
636 | for details). |
637 | ||
1658c614 CC |
638 | browser.<tool>.cmd:: |
639 | Specify the command to invoke the specified browser. The | |
640 | specified command is evaluated in shell with the URLs passed | |
641 | as arguments. (See linkgit:git-web--browse[1].) | |
642 | ||
584627b4 CC |
643 | browser.<tool>.path:: |
644 | Override the path for the given tool that may be used to | |
ab989adf CC |
645 | browse HTML help (see '-w' option in linkgit:git-help[1]) or a |
646 | working repository in gitweb (see linkgit:git-instaweb[1]). | |
584627b4 | 647 | |
2122591b | 648 | clean.requireForce:: |
562ca192 JH |
649 | A boolean to make git-clean do nothing unless given -f |
650 | or -n. Defaults to true. | |
2122591b | 651 | |
f3673988 BG |
652 | color.branch:: |
653 | A boolean to enable/disable color in the output of | |
5162e697 | 654 | linkgit:git-branch[1]. May be set to `always`, |
cec99d8c | 655 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
f3673988 BG |
656 | only when the output is to a terminal. Defaults to false. |
657 | ||
658 | color.branch.<slot>:: | |
659 | Use customized color for branch coloration. `<slot>` is one of | |
660 | `current` (the current branch), `local` (a local branch), | |
661 | `remote` (a tracking branch in refs/remotes/), `plain` (other | |
4f193f20 MW |
662 | refs). |
663 | + | |
664 | The value for these configuration variables is a list of colors (at most | |
665 | two) and attributes (at most one), separated by spaces. The colors | |
666 | accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`, | |
667 | `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`, | |
668 | `blink` and `reverse`. The first color given is the foreground; the | |
669 | second is the background. The position of the attribute, if any, | |
670 | doesn't matter. | |
f3673988 | 671 | |
a159ca0c | 672 | color.diff:: |
cec99d8c JH |
673 | When set to `always`, always use colors in patch. |
674 | When false (or `never`), never. When set to `true` or `auto`, use | |
675 | colors only when the output is to the terminal. Defaults to false. | |
b5376648 | 676 | |
a159ca0c | 677 | color.diff.<slot>:: |
4f193f20 MW |
678 | Use customized color for diff colorization. `<slot>` specifies |
679 | which part of the patch to use the specified color, and is one | |
680 | of `plain` (context text), `meta` (metainformation), `frag` | |
89cb73a1 BW |
681 | (hunk header), 'func' (function in hunk header), `old` (removed lines), |
682 | `new` (added lines), `commit` (commit headers), or `whitespace` | |
683 | (highlighting whitespace errors). The values of these variables may be | |
684 | specified as in color.branch.<slot>. | |
b5376648 | 685 | |
7e8f59d5 RS |
686 | color.grep:: |
687 | When set to `always`, always highlight matches. When `false` (or | |
688 | `never`), never. When set to `true` or `auto`, use color only | |
689 | when the output is written to the terminal. Defaults to `false`. | |
690 | ||
55f638bd ML |
691 | color.grep.<slot>:: |
692 | Use customized color for grep colorization. `<slot>` specifies which | |
693 | part of the line to use the specified color, and is one of | |
694 | + | |
695 | -- | |
00588bb5 ML |
696 | `context`;; |
697 | non-matching text in context lines (when using `-A`, `-B`, or `-C`) | |
55f638bd ML |
698 | `filename`;; |
699 | filename prefix (when not using `-h`) | |
00588bb5 ML |
700 | `function`;; |
701 | function name lines (when using `-p`) | |
55f638bd ML |
702 | `linenumber`;; |
703 | line number prefix (when using `-n`) | |
704 | `match`;; | |
705 | matching text | |
00588bb5 ML |
706 | `selected`;; |
707 | non-matching text in selected lines | |
55f638bd ML |
708 | `separator`;; |
709 | separators between fields on a line (`:`, `-`, and `=`) | |
710 | and between hunks (`--`) | |
711 | -- | |
712 | + | |
713 | The values of these variables may be specified as in color.branch.<slot>. | |
7e8f59d5 | 714 | |
b4c61ed6 | 715 | color.interactive:: |
47ee06f1 | 716 | When set to `always`, always use colors for interactive prompts |
467c0197 | 717 | and displays (such as those used by "git-add --interactive"). |
b4c61ed6 JH |
718 | When false (or `never`), never. When set to `true` or `auto`, use |
719 | colors only when the output is to the terminal. Defaults to false. | |
720 | ||
721 | color.interactive.<slot>:: | |
0b444cdb | 722 | Use customized color for 'git add --interactive' |
a3019736 TR |
723 | output. `<slot>` may be `prompt`, `header`, `help` or `error`, for |
724 | four distinct types of normal output from interactive | |
57f6ec02 | 725 | commands. The values of these variables may be specified as |
b4c61ed6 JH |
726 | in color.branch.<slot>. |
727 | ||
1d77043b JH |
728 | color.pager:: |
729 | A boolean to enable/disable colored output when the pager is in | |
730 | use (default is true). | |
731 | ||
ab07ba2a MH |
732 | color.showbranch:: |
733 | A boolean to enable/disable color in the output of | |
734 | linkgit:git-show-branch[1]. May be set to `always`, | |
735 | `false` (or `never`) or `auto` (or `true`), in which case colors are used | |
736 | only when the output is to a terminal. Defaults to false. | |
737 | ||
1d77043b JH |
738 | color.status:: |
739 | A boolean to enable/disable color in the output of | |
5162e697 | 740 | linkgit:git-status[1]. May be set to `always`, |
cec99d8c | 741 | `false` (or `never`) or `auto` (or `true`), in which case colors are used |
1d77043b JH |
742 | only when the output is to a terminal. Defaults to false. |
743 | ||
744 | color.status.<slot>:: | |
745 | Use customized color for status colorization. `<slot>` is | |
746 | one of `header` (the header text of the status message), | |
82dca848 SP |
747 | `added` or `updated` (files which are added but not committed), |
748 | `changed` (files which are changed but not added in the index), | |
950ce2e2 CP |
749 | `untracked` (files which are not tracked by git), or |
750 | `nobranch` (the color the 'no branch' warning is shown in, defaulting | |
751 | to red). The values of these variables may be specified as in | |
752 | color.branch.<slot>. | |
1d77043b | 753 | |
6b2f2d98 MK |
754 | color.ui:: |
755 | When set to `always`, always use colors in all git commands which | |
756 | are capable of colored output. When false (or `never`), never. When | |
757 | set to `true` or `auto`, use colors only when the output is to the | |
758 | terminal. When more specific variables of color.* are set, they always | |
759 | take precedence over this setting. Defaults to false. | |
760 | ||
88955ed2 | 761 | commit.status:: |
bed575e4 JHI |
762 | A boolean to enable/disable inclusion of status information in the |
763 | commit message template when using an editor to prepare the commit | |
764 | message. Defaults to true. | |
765 | ||
b0f34c3d MM |
766 | commit.template:: |
767 | Specify a file to use as the template for new commit messages. | |
0f7fb21a | 768 | "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the |
df2a79f4 | 769 | specified user's home directory. |
b0f34c3d | 770 | |
aecbf914 | 771 | diff.autorefreshindex:: |
0b444cdb | 772 | When using 'git diff' to compare with work tree |
aecbf914 JH |
773 | files, do not consider stat-only change as changed. |
774 | Instead, silently run `git update-index --refresh` to | |
775 | update the cached stat information for paths whose | |
776 | contents in the work tree match the contents in the | |
777 | index. This option defaults to true. Note that this | |
0b444cdb | 778 | affects only 'git diff' Porcelain, and not lower level |
add0951a | 779 | 'diff' commands such as 'git diff-files'. |
aecbf914 | 780 | |
77680caa JS |
781 | diff.external:: |
782 | If this config variable is set, diff generation is not | |
783 | performed using the internal diff machinery, but using the | |
6bb9e51b AM |
784 | given command. Can be overridden with the `GIT_EXTERNAL_DIFF' |
785 | environment variable. The command is called with parameters | |
786 | as described under "git Diffs" in linkgit:git[1]. Note: if | |
787 | you want to use an external diff program only on a subset of | |
788 | your files, you might want to use linkgit:gitattributes[5] instead. | |
77680caa | 789 | |
a5a818ee | 790 | diff.mnemonicprefix:: |
0b444cdb | 791 | If set, 'git diff' uses a prefix pair that is different from the |
a5a818ee JH |
792 | standard "a/" and "b/" depending on what is being compared. When |
793 | this configuration is in effect, reverse diff output also swaps | |
794 | the order of the prefixes: | |
ca768288 | 795 | `git diff`;; |
a5a818ee | 796 | compares the (i)ndex and the (w)ork tree; |
ca768288 | 797 | `git diff HEAD`;; |
a5a818ee | 798 | compares a (c)ommit and the (w)ork tree; |
ca768288 | 799 | `git diff --cached`;; |
a5a818ee | 800 | compares a (c)ommit and the (i)ndex; |
ca768288 | 801 | `git diff HEAD:file1 file2`;; |
a5a818ee | 802 | compares an (o)bject and a (w)ork tree entity; |
ca768288 | 803 | `git diff --no-index a b`;; |
a5a818ee JH |
804 | compares two non-git things (1) and (2). |
805 | ||
1ab661dd PB |
806 | diff.renameLimit:: |
807 | The number of files to consider when performing the copy/rename | |
0b444cdb | 808 | detection; equivalent to the 'git diff' option '-l'. |
1ab661dd | 809 | |
b68ea12e EW |
810 | diff.renames:: |
811 | Tells git to detect renames. If set to any boolean value, it | |
812 | will enable basic rename detection. If set to "copies" or | |
813 | "copy", it will detect copies, as well. | |
814 | ||
950db879 | 815 | diff.suppressBlankEmpty:: |
5fdb7098 RH |
816 | A boolean to inhibit the standard behavior of printing a space |
817 | before each empty output line. Defaults to false. | |
818 | ||
afcbc8e7 DA |
819 | diff.tool:: |
820 | Controls which diff tool is used. `diff.tool` overrides | |
821 | `merge.tool` when used by linkgit:git-difftool[1] and has | |
822 | the same valid values as `merge.tool` minus "tortoisemerge" | |
823 | and plus "kompare". | |
824 | ||
825 | difftool.<tool>.path:: | |
826 | Override the path for the given tool. This is useful in case | |
827 | your tool is not in the PATH. | |
828 | ||
829 | difftool.<tool>.cmd:: | |
830 | Specify the command to invoke the specified diff tool. | |
831 | The specified command is evaluated in shell with the following | |
832 | variables available: 'LOCAL' is set to the name of the temporary | |
833 | file containing the contents of the diff pre-image and 'REMOTE' | |
834 | is set to the name of the temporary file containing the contents | |
835 | of the diff post-image. | |
836 | ||
a904392e DA |
837 | difftool.prompt:: |
838 | Prompt before each invocation of the diff tool. | |
839 | ||
ae3b970a | 840 | diff.wordRegex:: |
98a4d87b BSSJ |
841 | A POSIX Extended Regular Expression used to determine what is a "word" |
842 | when performing word-by-word difference calculations. Character | |
843 | sequences that match the regular expression are "words", all other | |
844 | characters are *ignorable* whitespace. | |
845 | ||
af7cf268 JH |
846 | fetch.unpackLimit:: |
847 | If the number of objects fetched over the git native | |
848 | transfer is below this | |
849 | limit, then the objects will be unpacked into loose object | |
850 | files. However if the number of received objects equals or | |
851 | exceeds this limit then the received pack will be stored as | |
852 | a pack, after adding any missing delta bases. Storing the | |
853 | pack from a push can make the push operation complete faster, | |
80cd9cf9 MB |
854 | especially on slow filesystems. If not set, the value of |
855 | `transfer.unpackLimit` is used instead. | |
af7cf268 | 856 | |
48d3448d SB |
857 | format.attach:: |
858 | Enable multipart/mixed attachments as the default for | |
859 | 'format-patch'. The value can also be a double quoted string | |
860 | which will enable attachments as the default and set the | |
861 | value as the boundary. See the --attach option in | |
862 | linkgit:git-format-patch[1]. | |
863 | ||
49604a4d | 864 | format.numbered:: |
a567fdcb BG |
865 | A boolean which can enable or disable sequence numbers in patch |
866 | subjects. It defaults to "auto" which enables it only if there | |
867 | is more than one patch. It can be enabled or disabled for all | |
868 | messages by setting it to "true" or "false". See --numbered | |
869 | option in linkgit:git-format-patch[1]. | |
49604a4d | 870 | |
1ab661dd PB |
871 | format.headers:: |
872 | Additional email headers to include in a patch to be submitted | |
5162e697 | 873 | by mail. See linkgit:git-format-patch[1]. |
1ab661dd | 874 | |
48d3448d SB |
875 | format.cc:: |
876 | Additional "Cc:" headers to include in a patch to be submitted | |
877 | by mail. See the --cc option in linkgit:git-format-patch[1]. | |
878 | ||
879 | format.subjectprefix:: | |
880 | The default for format-patch is to output files with the '[PATCH]' | |
881 | subject prefix. Use this variable to change that prefix. | |
882 | ||
6622d9c7 SB |
883 | format.signature:: |
884 | The default for format-patch is to output a signature containing | |
885 | the git version number. Use this variable to change that default. | |
886 | Set this variable to the empty string ("") to suppress | |
887 | signature generation. | |
888 | ||
78cb59c8 JS |
889 | format.suffix:: |
890 | The default for format-patch is to output files with the suffix | |
891 | `.patch`. Use this variable to change that suffix (make sure to | |
892 | include the dot if you want it). | |
1ab661dd | 893 | |
94c22a5e CR |
894 | format.pretty:: |
895 | The default pretty format for log/show/whatchanged command, | |
896 | See linkgit:git-log[1], linkgit:git-show[1], | |
897 | linkgit:git-whatchanged[1]. | |
898 | ||
30984ed2 | 899 | format.thread:: |
0b444cdb | 900 | The default threading style for 'git format-patch'. Can be |
578b62bf JN |
901 | a boolean value, or `shallow` or `deep`. `shallow` threading |
902 | makes every mail a reply to the head of the series, | |
30984ed2 TR |
903 | where the head is chosen from the cover letter, the |
904 | `\--in-reply-to`, and the first patch mail, in this order. | |
fd1ff306 | 905 | `deep` threading makes every mail a reply to the previous one. |
30984ed2 TR |
906 | A true boolean value is the same as `shallow`, and a false |
907 | value disables threading. | |
908 | ||
1d1876e9 HV |
909 | format.signoff:: |
910 | A boolean value which lets you enable the `-s/--signoff` option of | |
911 | format-patch by default. *Note:* Adding the Signed-off-by: line to a | |
912 | patch should be a conscious act and means that you certify you have | |
913 | the rights to submit this work under the same open source license. | |
914 | Please see the 'SubmittingPatches' document for further discussion. | |
915 | ||
0d7566a5 TT |
916 | gc.aggressiveWindow:: |
917 | The window size parameter used in the delta compression | |
0b444cdb | 918 | algorithm used by 'git gc --aggressive'. This defaults |
f78683f3 | 919 | to 250. |
0d7566a5 | 920 | |
e9831e83 JH |
921 | gc.auto:: |
922 | When there are approximately more than this many loose | |
923 | objects in the repository, `git gc --auto` will pack them. | |
924 | Some Porcelain commands use this command to perform a | |
80cd9cf9 MB |
925 | light-weight garbage collection from time to time. The |
926 | default value is 6700. Setting this to 0 disables it. | |
e9831e83 | 927 | |
17815501 JH |
928 | gc.autopacklimit:: |
929 | When there are more than this many packs that are not | |
930 | marked with `*.keep` file in the repository, `git gc | |
80cd9cf9 | 931 | --auto` consolidates them into one larger pack. The |
97063974 | 932 | default value is 50. Setting this to 0 disables it. |
17815501 | 933 | |
c2120e5e | 934 | gc.packrefs:: |
efc266e8 JN |
935 | Running `git pack-refs` in a repository renders it |
936 | unclonable by Git versions prior to 1.5.1.2 over dumb | |
937 | transports such as HTTP. This variable determines whether | |
add0951a | 938 | 'git gc' runs `git pack-refs`. This can be set to `nobare` |
efc266e8 JN |
939 | to enable it within all non-bare repos or it can be set to a |
940 | boolean value. The default is `true`. | |
c2120e5e | 941 | |
25ee9731 | 942 | gc.pruneexpire:: |
0b444cdb | 943 | When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'. |
8e8daf33 NP |
944 | Override the grace period with this config variable. The value |
945 | "now" may be used to disable this grace period and always prune | |
946 | unreachable objects immediately. | |
25ee9731 | 947 | |
4aec56d1 | 948 | gc.reflogexpire:: |
eb523a8d | 949 | gc.<pattern>.reflogexpire:: |
0b444cdb | 950 | 'git reflog expire' removes reflog entries older than |
eb523a8d JH |
951 | this time; defaults to 90 days. With "<pattern>" (e.g. |
952 | "refs/stash") in the middle the setting applies only to | |
953 | the refs that match the <pattern>. | |
4aec56d1 JH |
954 | |
955 | gc.reflogexpireunreachable:: | |
eb523a8d | 956 | gc.<ref>.reflogexpireunreachable:: |
0b444cdb | 957 | 'git reflog expire' removes reflog entries older than |
4aec56d1 | 958 | this time and are not reachable from the current tip; |
eb523a8d JH |
959 | defaults to 30 days. With "<pattern>" (e.g. "refs/stash") |
960 | in the middle, the setting applies only to the refs that | |
961 | match the <pattern>. | |
4aec56d1 | 962 | |
48c32424 JH |
963 | gc.rerereresolved:: |
964 | Records of conflicted merge you resolved earlier are | |
0b444cdb | 965 | kept for this many days when 'git rerere gc' is run. |
5162e697 | 966 | The default is 60 days. See linkgit:git-rerere[1]. |
48c32424 JH |
967 | |
968 | gc.rerereunresolved:: | |
969 | Records of conflicted merge you have not resolved are | |
0b444cdb | 970 | kept for this many days when 'git rerere gc' is run. |
5162e697 | 971 | The default is 15 days. See linkgit:git-rerere[1]. |
48c32424 | 972 | |
280514e1 FE |
973 | gitcvs.commitmsgannotation:: |
974 | Append this string to each commit message. Set to empty string | |
975 | to disable this feature. Defaults to "via git-CVS emulator". | |
976 | ||
1ab661dd | 977 | gitcvs.enabled:: |
db218723 | 978 | Whether the CVS server interface is enabled for this repository. |
5162e697 | 979 | See linkgit:git-cvsserver[1]. |
1ab661dd PB |
980 | |
981 | gitcvs.logfile:: | |
db218723 | 982 | Path to a log file where the CVS server interface well... logs |
5162e697 | 983 | various stuff. See linkgit:git-cvsserver[1]. |
1ab661dd | 984 | |
1707adb7 | 985 | gitcvs.usecrlfattr:: |
8a06a632 MO |
986 | If true, the server will look up the `crlf` attribute for |
987 | files to determine the '-k' modes to use. If `crlf` is set, | |
988 | the '-k' mode will be left blank, so cvs clients will | |
989 | treat it as text. If `crlf` is explicitly unset, the file | |
1168d402 | 990 | will be set with '-kb' mode, which suppresses any newline munging |
8a06a632 | 991 | the client might otherwise do. If `crlf` is not specified, |
ea449615 | 992 | then 'gitcvs.allbinary' is used. See linkgit:gitattributes[5]. |
8a06a632 | 993 | |
eabb0bfd | 994 | gitcvs.allbinary:: |
90948a42 MO |
995 | This is used if 'gitcvs.usecrlfattr' does not resolve |
996 | the correct '-kb' mode to use. If true, all | |
997 | unresolved files are sent to the client in | |
998 | mode '-kb'. This causes the client to treat them | |
999 | as binary files, which suppresses any newline munging it | |
1000 | otherwise might do. Alternatively, if it is set to "guess", | |
1001 | then the contents of the file are examined to decide if | |
1002 | it is binary, similar to 'core.autocrlf'. | |
abbf5947 | 1003 | |
04752868 FL |
1004 | gitcvs.dbname:: |
1005 | Database used by git-cvsserver to cache revision information | |
1006 | derived from the git repository. The exact meaning depends on the | |
1007 | used database driver, for SQLite (which is the default driver) this | |
1008 | is a filename. Supports variable substitution (see | |
5162e697 | 1009 | linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). |
04752868 FL |
1010 | Default: '%Ggitcvs.%m.sqlite' |
1011 | ||
1012 | gitcvs.dbdriver:: | |
1013 | Used Perl DBI driver. You can specify any available driver | |
1014 | for this here, but it might not work. git-cvsserver is tested | |
1015 | with 'DBD::SQLite', reported to work with 'DBD::Pg', and | |
1016 | reported *not* to work with 'DBD::mysql'. Experimental feature. | |
1017 | May not contain double colons (`:`). Default: 'SQLite'. | |
5162e697 | 1018 | See linkgit:git-cvsserver[1]. |
eabb0bfd | 1019 | |
04752868 FL |
1020 | gitcvs.dbuser, gitcvs.dbpass:: |
1021 | Database user and password. Only useful if setting 'gitcvs.dbdriver', | |
1022 | since SQLite has no concept of database users and/or passwords. | |
1023 | 'gitcvs.dbuser' supports variable substitution (see | |
5162e697 | 1024 | linkgit:git-cvsserver[1] for details). |
04752868 | 1025 | |
6aeeffd1 JE |
1026 | gitcvs.dbTableNamePrefix:: |
1027 | Database table name prefix. Prepended to the names of any | |
1028 | database tables used, allowing a single database to be used | |
1029 | for several repositories. Supports variable substitution (see | |
1030 | linkgit:git-cvsserver[1] for details). Any non-alphabetic | |
1031 | characters will be replaced with underscores. | |
1032 | ||
8a06a632 MO |
1033 | All gitcvs variables except for 'gitcvs.usecrlfattr' and |
1034 | 'gitcvs.allbinary' can also be specified as | |
1035 | 'gitcvs.<access_method>.<varname>' (where 'access_method' | |
02783075 BH |
1036 | is one of "ext" and "pserver") to make them apply only for the given |
1037 | access method. | |
04752868 | 1038 | |
d84ae0db GH |
1039 | gui.commitmsgwidth:: |
1040 | Defines how wide the commit message window is in the | |
1041 | linkgit:git-gui[1]. "75" is the default. | |
1042 | ||
1043 | gui.diffcontext:: | |
1044 | Specifies how many context lines should be used in calls to diff | |
1045 | made by the linkgit:git-gui[1]. The default is "5". | |
1046 | ||
a2df1fb2 AG |
1047 | gui.encoding:: |
1048 | Specifies the default encoding to use for displaying of | |
1049 | file contents in linkgit:git-gui[1] and linkgit:gitk[1]. | |
1050 | It can be overridden by setting the 'encoding' attribute | |
1051 | for relevant files (see linkgit:gitattributes[5]). | |
1052 | If this option is not set, the tools default to the | |
1053 | locale encoding. | |
1054 | ||
d84ae0db GH |
1055 | gui.matchtrackingbranch:: |
1056 | Determines if new branches created with linkgit:git-gui[1] should | |
1057 | default to tracking remote branches with matching names or | |
1058 | not. Default: "false". | |
1059 | ||
1060 | gui.newbranchtemplate:: | |
1061 | Is used as suggested name when creating new branches using the | |
1062 | linkgit:git-gui[1]. | |
1063 | ||
1064 | gui.pruneduringfetch:: | |
1065 | "true" if linkgit:git-gui[1] should prune tracking branches when | |
1066 | performing a fetch. The default value is "false". | |
1067 | ||
1068 | gui.trustmtime:: | |
1069 | Determines if linkgit:git-gui[1] should trust the file modification | |
1070 | timestamp or not. By default the timestamps are not trusted. | |
1071 | ||
1072 | gui.spellingdictionary:: | |
1073 | Specifies the dictionary used for spell checking commit messages in | |
1074 | the linkgit:git-gui[1]. When set to "none" spell checking is turned | |
1075 | off. | |
1076 | ||
a2df1fb2 | 1077 | gui.fastcopyblame:: |
ca768288 | 1078 | If true, 'git gui blame' uses `-C` instead of `-C -C` for original |
a2df1fb2 AG |
1079 | location detection. It makes blame significantly faster on huge |
1080 | repositories at the expense of less thorough copy detection. | |
1081 | ||
1082 | gui.copyblamethreshold:: | |
76bac890 | 1083 | Specifies the threshold to use in 'git gui blame' original location |
a2df1fb2 AG |
1084 | detection, measured in alphanumeric characters. See the |
1085 | linkgit:git-blame[1] manual for more information on copy detection. | |
1086 | ||
1087 | gui.blamehistoryctx:: | |
1088 | Specifies the radius of history context in days to show in | |
1089 | linkgit:gitk[1] for the selected commit, when the `Show History | |
1090 | Context` menu item is invoked from 'git gui blame'. If this | |
1091 | variable is set to zero, the whole history is shown. | |
1092 | ||
390c3480 AG |
1093 | guitool.<name>.cmd:: |
1094 | Specifies the shell command line to execute when the corresponding item | |
1095 | of the linkgit:git-gui[1] `Tools` menu is invoked. This option is | |
1096 | mandatory for every tool. The command is executed from the root of | |
1097 | the working directory, and in the environment it receives the name of | |
1098 | the tool as 'GIT_GUITOOL', the name of the currently selected file as | |
1099 | 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if | |
1100 | the head is detached, 'CUR_BRANCH' is empty). | |
1101 | ||
1102 | guitool.<name>.needsfile:: | |
1103 | Run the tool only if a diff is selected in the GUI. It guarantees | |
1104 | that 'FILENAME' is not empty. | |
1105 | ||
1106 | guitool.<name>.noconsole:: | |
1107 | Run the command silently, without creating a window to display its | |
1108 | output. | |
1109 | ||
1110 | guitool.<name>.norescan:: | |
1111 | Don't rescan the working directory for changes after the tool | |
1112 | finishes execution. | |
1113 | ||
1114 | guitool.<name>.confirm:: | |
1115 | Show a confirmation dialog before actually running the tool. | |
1116 | ||
1117 | guitool.<name>.argprompt:: | |
1118 | Request a string argument from the user, and pass it to the tool | |
1119 | through the 'ARGS' environment variable. Since requesting an | |
1120 | argument implies confirmation, the 'confirm' option has no effect | |
1121 | if this is enabled. If the option is set to 'true', 'yes', or '1', | |
1122 | the dialog uses a built-in generic prompt; otherwise the exact | |
1123 | value of the variable is used. | |
1124 | ||
1125 | guitool.<name>.revprompt:: | |
1126 | Request a single valid revision from the user, and set the | |
1127 | 'REVISION' environment variable. In other aspects this option | |
1128 | is similar to 'argprompt', and can be used together with it. | |
1129 | ||
1130 | guitool.<name>.revunmerged:: | |
1131 | Show only unmerged branches in the 'revprompt' subdialog. | |
1132 | This is useful for tools similar to merge or rebase, but not | |
1133 | for things like checkout or reset. | |
1134 | ||
1135 | guitool.<name>.title:: | |
1136 | Specifies the title to use for the prompt dialog. The default | |
1137 | is the tool name. | |
1138 | ||
1139 | guitool.<name>.prompt:: | |
1140 | Specifies the general prompt string to display at the top of | |
1141 | the dialog, before subsections for 'argprompt' and 'revprompt'. | |
1142 | The default value includes the actual command. | |
1143 | ||
983a9eeb CC |
1144 | help.browser:: |
1145 | Specify the browser that will be used to display help in the | |
1146 | 'web' format. See linkgit:git-help[1]. | |
1147 | ||
1148 | help.format:: | |
1149 | Override the default help format used by linkgit:git-help[1]. | |
1150 | Values 'man', 'info', 'web' and 'html' are supported. 'man' is | |
1151 | the default. 'web' and 'html' are the same. | |
1152 | ||
f0e90716 AR |
1153 | help.autocorrect:: |
1154 | Automatically correct and execute mistyped commands after | |
1155 | waiting for the given number of deciseconds (0.1 sec). If more | |
1156 | than one command can be deduced from the entered text, nothing | |
1157 | will be executed. If the value of this option is negative, | |
1158 | the corrected command will be executed immediately. If the | |
1159 | value is 0 - the command will be just shown but not executed. | |
1160 | This is the default. | |
1161 | ||
9c5665aa SV |
1162 | http.proxy:: |
1163 | Override the HTTP proxy, normally configured using the 'http_proxy' | |
5162e697 | 1164 | environment variable (see linkgit:curl[1]). This can be overridden |
14c98218 | 1165 | on a per-remote basis; see remote.<name>.proxy |
9c5665aa | 1166 | |
1ab661dd PB |
1167 | http.sslVerify:: |
1168 | Whether to verify the SSL certificate when fetching or pushing | |
37425065 | 1169 | over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment |
1ab661dd PB |
1170 | variable. |
1171 | ||
1172 | http.sslCert:: | |
1173 | File containing the SSL certificate when fetching or pushing | |
37425065 | 1174 | over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment |
1ab661dd PB |
1175 | variable. |
1176 | ||
1177 | http.sslKey:: | |
1178 | File containing the SSL private key when fetching or pushing | |
abda1ef5 | 1179 | over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment |
1ab661dd PB |
1180 | variable. |
1181 | ||
754ae192 ML |
1182 | http.sslCertPasswordProtected:: |
1183 | Enable git's password prompt for the SSL certificate. Otherwise | |
1184 | OpenSSL will prompt the user, possibly many times, if the | |
1185 | certificate or private key is encrypted. Can be overridden by the | |
1186 | 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable. | |
1187 | ||
1ab661dd PB |
1188 | http.sslCAInfo:: |
1189 | File containing the certificates to verify the peer with when | |
abda1ef5 | 1190 | fetching or pushing over HTTPS. Can be overridden by the |
1ab661dd PB |
1191 | 'GIT_SSL_CAINFO' environment variable. |
1192 | ||
1193 | http.sslCAPath:: | |
1194 | Path containing files with the CA certificates to verify the peer | |
37425065 | 1195 | with when fetching or pushing over HTTPS. Can be overridden |
1ab661dd PB |
1196 | by the 'GIT_SSL_CAPATH' environment variable. |
1197 | ||
1198 | http.maxRequests:: | |
abda1ef5 | 1199 | How many HTTP requests to launch in parallel. Can be overridden |
1ab661dd PB |
1200 | by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. |
1201 | ||
ad75ebe5 TRC |
1202 | http.minSessions:: |
1203 | The number of curl sessions (counted across slots) to be kept across | |
1204 | requests. They will not be ended with curl_easy_cleanup() until | |
1205 | http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this | |
1206 | value will be capped at 1. Defaults to 1. | |
1207 | ||
de1a2fdd SP |
1208 | http.postBuffer:: |
1209 | Maximum size in bytes of the buffer used by smart HTTP | |
1210 | transports when POSTing data to the remote system. | |
1211 | For requests larger than this buffer size, HTTP/1.1 and | |
1212 | Transfer-Encoding: chunked is used to avoid creating a | |
1213 | massive pack file locally. Default is 1 MiB, which is | |
1214 | sufficient for most requests. | |
1215 | ||
1ab661dd PB |
1216 | http.lowSpeedLimit, http.lowSpeedTime:: |
1217 | If the HTTP transfer speed is less than 'http.lowSpeedLimit' | |
1218 | for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. | |
abda1ef5 | 1219 | Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and |
1ab661dd PB |
1220 | 'GIT_HTTP_LOW_SPEED_TIME' environment variables. |
1221 | ||
3ea099d4 SK |
1222 | http.noEPSV:: |
1223 | A boolean which disables using of EPSV ftp command by curl. | |
befc9c42 | 1224 | This can helpful with some "poor" ftp servers which don't |
3ea099d4 SK |
1225 | support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV' |
1226 | environment variable. Default is false (curl will use EPSV). | |
1227 | ||
1ab661dd PB |
1228 | i18n.commitEncoding:: |
1229 | Character encoding the commit messages are stored in; git itself | |
1230 | does not care per se, but this information is necessary e.g. when | |
1231 | importing commits from emails or in the gitk graphical history | |
1232 | browser (and possibly at other places in the future or in other | |
5162e697 | 1233 | porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. |
1ab661dd | 1234 | |
d2c11a38 JH |
1235 | i18n.logOutputEncoding:: |
1236 | Character encoding the commit messages are converted to when | |
0b444cdb | 1237 | running 'git log' and friends. |
d2c11a38 | 1238 | |
b0f34c3d MM |
1239 | imap:: |
1240 | The configuration variables in the 'imap' section are described | |
1241 | in linkgit:git-imap-send[1]. | |
1242 | ||
d8a8488d SD |
1243 | init.templatedir:: |
1244 | Specify the directory from which templates will be copied. | |
1245 | (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].) | |
1246 | ||
983a9eeb CC |
1247 | instaweb.browser:: |
1248 | Specify the program that will be used to browse your working | |
1249 | repository in gitweb. See linkgit:git-instaweb[1]. | |
1250 | ||
1251 | instaweb.httpd:: | |
1252 | The HTTP daemon command-line to start gitweb on your working | |
1253 | repository. See linkgit:git-instaweb[1]. | |
1254 | ||
1255 | instaweb.local:: | |
1256 | If true the web server started by linkgit:git-instaweb[1] will | |
1257 | be bound to the local IP (127.0.0.1). | |
1258 | ||
1259 | instaweb.modulepath:: | |
1260 | The module path for an apache httpd used by linkgit:git-instaweb[1]. | |
1261 | ||
1262 | instaweb.port:: | |
1263 | The port number to bind the gitweb httpd to. See | |
1264 | linkgit:git-instaweb[1]. | |
1265 | ||
ca6ac7f1 | 1266 | interactive.singlekey:: |
57f6ec02 | 1267 | In interactive commands, allow the user to provide one-letter |
ca6ac7f1 TR |
1268 | input with a single key (i.e., without hitting enter). |
1269 | Currently this is used only by the `\--patch` mode of | |
1270 | linkgit:git-add[1]. Note that this setting is silently | |
1271 | ignored if portable keystroke input is not available. | |
1272 | ||
dd0ffd5b HO |
1273 | log.date:: |
1274 | Set default date-time mode for the log command. Setting log.date | |
0b444cdb | 1275 | value is similar to using 'git log'\'s --date option. The value is one of the |
dd0ffd5b HO |
1276 | following alternatives: {relative,local,default,iso,rfc,short}. |
1277 | See linkgit:git-log[1]. | |
1278 | ||
eb734454 SD |
1279 | log.decorate:: |
1280 | Print out the ref names of any commits that are shown by the log | |
1281 | command. If 'short' is specified, the ref name prefixes 'refs/heads/', | |
1282 | 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is | |
1283 | specified, the full ref name (including prefix) will be printed. | |
1284 | This is the same as the log commands '--decorate' option. | |
1285 | ||
0f03ca94 PB |
1286 | log.showroot:: |
1287 | If true, the initial commit will be shown as a big creation event. | |
1288 | This is equivalent to a diff against an empty tree. | |
5162e697 | 1289 | Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which |
0f03ca94 PB |
1290 | normally hide the root commit will now show it. True by default. |
1291 | ||
d551a488 MSO |
1292 | mailmap.file:: |
1293 | The location of an augmenting mailmap file. The default | |
1294 | mailmap, located in the root of the repository, is loaded | |
1295 | first, then the mailmap file pointed to by this variable. | |
1296 | The location of the mailmap file may be in a repository | |
1297 | subdirectory, or somewhere outside of the repository itself. | |
1298 | See linkgit:git-shortlog[1] and linkgit:git-blame[1]. | |
1299 | ||
b5578f33 | 1300 | man.viewer:: |
b8322ea8 | 1301 | Specify the programs that may be used to display help in the |
b5578f33 CC |
1302 | 'man' format. See linkgit:git-help[1]. |
1303 | ||
0bb64009 CC |
1304 | man.<tool>.cmd:: |
1305 | Specify the command to invoke the specified man viewer. The | |
1306 | specified command is evaluated in shell with the man page | |
1307 | passed as argument. (See linkgit:git-help[1].) | |
1308 | ||
7e8114c0 CC |
1309 | man.<tool>.path:: |
1310 | Override the path for the given tool that may be used to | |
1311 | display help in the 'man' format. See linkgit:git-help[1]. | |
1312 | ||
b0f34c3d | 1313 | include::merge-config.txt[] |
b5412484 | 1314 | |
77680caa JS |
1315 | mergetool.<tool>.path:: |
1316 | Override the path for the given tool. This is useful in case | |
1317 | your tool is not in the PATH. | |
1318 | ||
964473a0 CB |
1319 | mergetool.<tool>.cmd:: |
1320 | Specify the command to invoke the specified merge tool. The | |
1321 | specified command is evaluated in shell with the following | |
1322 | variables available: 'BASE' is the name of a temporary file | |
1323 | containing the common base of the files to be merged, if available; | |
1324 | 'LOCAL' is the name of a temporary file containing the contents of | |
1325 | the file on the current branch; 'REMOTE' is the name of a temporary | |
1326 | file containing the contents of the file from the branch being | |
1327 | merged; 'MERGED' contains the name of the file to which the merge | |
1328 | tool should write the results of a successful merge. | |
1329 | ||
1330 | mergetool.<tool>.trustExitCode:: | |
1331 | For a custom merge command, specify whether the exit code of | |
1332 | the merge command can be used to determine whether the merge was | |
1333 | successful. If this is not set to true then the merge target file | |
1334 | timestamp is checked and the merge assumed to have been successful | |
1335 | if the file has been updated, otherwise the user is prompted to | |
1336 | indicate the success of the merge. | |
1337 | ||
44c36d1c CB |
1338 | mergetool.keepBackup:: |
1339 | After performing a merge, the original file with conflict markers | |
1340 | can be saved as a file with a `.orig` extension. If this variable | |
1341 | is set to `false` then this file is not preserved. Defaults to | |
1342 | `true` (i.e. keep the backup files). | |
1343 | ||
162eba8b CB |
1344 | mergetool.keepTemporaries:: |
1345 | When invoking a custom merge tool, git uses a set of temporary | |
1346 | files to pass to the tool. If the tool returns an error and this | |
1347 | variable is set to `true`, then these temporary files will be | |
1348 | preserved, otherwise they will be removed after the tool has | |
1349 | exited. Defaults to `false`. | |
1350 | ||
682b451f CB |
1351 | mergetool.prompt:: |
1352 | Prompt before each invocation of the merge resolution program. | |
1353 | ||
894a9d33 TR |
1354 | notes.displayRef:: |
1355 | The (fully qualified) refname from which to show notes when | |
1356 | showing commit messages. The value of this variable can be set | |
1357 | to a glob, in which case notes from all matching refs will be | |
1358 | shown. You may also specify this configuration variable | |
1359 | several times. A warning will be issued for refs that do not | |
1360 | exist, but a glob that does not match any refs is silently | |
1361 | ignored. | |
1362 | + | |
1363 | This setting can be overridden with the `GIT_NOTES_DISPLAY_REF` | |
1364 | environment variable, which must be a colon separated list of refs or | |
1365 | globs. | |
1366 | + | |
1367 | The effective value of "core.notesRef" (possibly overridden by | |
1368 | GIT_NOTES_REF) is also implicitly added to the list of refs to be | |
1369 | displayed. | |
1370 | ||
6956f858 TR |
1371 | notes.rewrite.<command>:: |
1372 | When rewriting commits with <command> (currently `amend` or | |
1373 | `rebase`) and this variable is set to `true`, git | |
1374 | automatically copies your notes from the original to the | |
1375 | rewritten commit. Defaults to `true`, but see | |
1376 | "notes.rewriteRef" below. | |
6956f858 TR |
1377 | |
1378 | notes.rewriteMode:: | |
1379 | When copying notes during a rewrite (see the | |
1380 | "notes.rewrite.<command>" option), determines what to do if | |
1381 | the target commit already has a note. Must be one of | |
1382 | `overwrite`, `concatenate`, or `ignore`. Defaults to | |
1383 | `concatenate`. | |
1384 | + | |
1385 | This setting can be overridden with the `GIT_NOTES_REWRITE_MODE` | |
1386 | environment variable. | |
1387 | ||
1388 | notes.rewriteRef:: | |
1389 | When copying notes during a rewrite, specifies the (fully | |
1390 | qualified) ref whose notes should be copied. The ref may be a | |
1391 | glob, in which case notes in all matching refs will be copied. | |
1392 | You may also specify this configuration several times. | |
1393 | + | |
1394 | Does not have a default value; you must configure this variable to | |
1395 | enable note rewriting. | |
cfb88e9a LAS |
1396 | + |
1397 | This setting can be overridden with the `GIT_NOTES_REWRITE_REF` | |
1398 | environment variable, which must be a colon separated list of refs or | |
1399 | globs. | |
6956f858 | 1400 | |
4812a93a | 1401 | pack.window:: |
5162e697 | 1402 | The size of the window used by linkgit:git-pack-objects[1] when no |
4812a93a JK |
1403 | window size is given on the command line. Defaults to 10. |
1404 | ||
842aaf93 | 1405 | pack.depth:: |
5162e697 | 1406 | The maximum delta depth used by linkgit:git-pack-objects[1] when no |
618e613a | 1407 | maximum depth is given on the command line. Defaults to 50. |
842aaf93 | 1408 | |
e93b15cd | 1409 | pack.windowMemory:: |
5162e697 | 1410 | The window memory size limit used by linkgit:git-pack-objects[1] |
e93b15cd BD |
1411 | when no limit is given on the command line. The value can be |
1412 | suffixed with "k", "m", or "g". Defaults to 0, meaning no | |
1413 | limit. | |
1414 | ||
960ccca6 DH |
1415 | pack.compression:: |
1416 | An integer -1..9, indicating the compression level for objects | |
1417 | in a pack file. -1 is the zlib default. 0 means no | |
1418 | compression, and 1..9 are various speed/size tradeoffs, 9 being | |
1419 | slowest. If not set, defaults to core.compression. If that is | |
dec92309 BD |
1420 | not set, defaults to -1, the zlib default, which is "a default |
1421 | compromise between speed and compression (currently equivalent | |
1422 | to level 6)." | |
960ccca6 | 1423 | |
074b2eea | 1424 | pack.deltaCacheSize:: |
02783075 | 1425 | The maximum memory in bytes used for caching deltas in |
5749b0b2 NP |
1426 | linkgit:git-pack-objects[1] before writing them out to a pack. |
1427 | This cache is used to speed up the writing object phase by not | |
1428 | having to recompute the final delta result once the best match | |
1429 | for all objects is found. Repacking large repositories on machines | |
1430 | which are tight with memory might be badly impacted by this though, | |
1431 | especially if this cache pushes the system into swapping. | |
1432 | A value of 0 means no limit. The smallest size of 1 byte may be | |
1433 | used to virtually disable this cache. Defaults to 256 MiB. | |
074b2eea | 1434 | |
e3dfddb3 | 1435 | pack.deltaCacheLimit:: |
693b86ff | 1436 | The maximum size of a delta, that is cached in |
5749b0b2 NP |
1437 | linkgit:git-pack-objects[1]. This cache is used to speed up the |
1438 | writing object phase by not having to recompute the final delta | |
1439 | result once the best match for all objects is found. Defaults to 1000. | |
e3dfddb3 | 1440 | |
693b86ff NP |
1441 | pack.threads:: |
1442 | Specifies the number of threads to spawn when searching for best | |
5162e697 | 1443 | delta matches. This requires that linkgit:git-pack-objects[1] |
693b86ff NP |
1444 | be compiled with pthreads otherwise this option is ignored with a |
1445 | warning. This is meant to reduce packing time on multiprocessor | |
1446 | machines. The required amount of memory for the delta search window | |
1447 | is however multiplied by the number of threads. | |
833e3df1 AE |
1448 | Specifying 0 will cause git to auto-detect the number of CPU's |
1449 | and set the number of threads accordingly. | |
693b86ff | 1450 | |
4d00bda2 NP |
1451 | pack.indexVersion:: |
1452 | Specify the default pack index version. Valid values are 1 for | |
1453 | legacy pack index used by Git versions prior to 1.5.2, and 2 for | |
1454 | the new pack index with capabilities for packs larger than 4 GB | |
1455 | as well as proper protection against the repacking of corrupted | |
c0a5e2d4 NP |
1456 | packs. Version 2 is the default. Note that version 2 is enforced |
1457 | and this config option ignored whenever the corresponding pack is | |
1458 | larger than 2 GB. | |
1459 | + | |
1460 | If you have an old git that does not understand the version 2 `{asterisk}.idx` file, | |
1461 | cloning or fetching over a non native protocol (e.g. "http" and "rsync") | |
1462 | that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the | |
1463 | other side may give you a repository that cannot be accessed with your | |
1464 | older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however, | |
1465 | you can use linkgit:git-index-pack[1] on the *.pack file to regenerate | |
1466 | the `{asterisk}.idx` file. | |
4d00bda2 | 1467 | |
dbdbfec4 | 1468 | pack.packSizeLimit:: |
07cf0f24 NP |
1469 | The maximum size of a pack. This setting only affects |
1470 | packing to a file when repacking, i.e. the git:// protocol | |
1471 | is unaffected. It can be overridden by the `\--max-pack-size` | |
1472 | option of linkgit:git-repack[1]. The minimum size allowed is | |
1473 | limited to 1 MiB. The default is unlimited. | |
1474 | Common unit suffixes of 'k', 'm', or 'g' are | |
1475 | supported. | |
2b84b5a8 | 1476 | |
4370c2d6 | 1477 | pager.<cmd>:: |
32818085 JN |
1478 | Allows turning on or off pagination of the output of a |
1479 | particular git subcommand when writing to a tty. If | |
1480 | `\--paginate` or `\--no-pager` is specified on the command line, | |
1481 | it takes precedence over this option. To disable pagination for | |
dcb11263 | 1482 | all commands, set `core.pager` or `GIT_PAGER` to `cat`. |
4370c2d6 | 1483 | |
8028184e WP |
1484 | pretty.<name>:: |
1485 | Alias for a --pretty= format string, as specified in | |
1486 | linkgit:git-log[1]. Any aliases defined here can be used just | |
1487 | as the built-in pretty formats could. For example, | |
1488 | running `git config pretty.changelog "format:{asterisk} %H %s"` | |
1489 | would cause the invocation `git log --pretty=changelog` | |
1490 | to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`. | |
1491 | Note that an alias with the same name as a built-in format | |
1492 | will be silently ignored. | |
1493 | ||
1ab661dd PB |
1494 | pull.octopus:: |
1495 | The default merge strategy to use when pulling multiple branches | |
1496 | at once. | |
1497 | ||
1498 | pull.twohead:: | |
1499 | The default merge strategy to use when pulling a single branch. | |
1500 | ||
52153747 FAG |
1501 | push.default:: |
1502 | Defines the action git push should take if no refspec is given | |
1503 | on the command line, no refspec is configured in the remote, and | |
1504 | no refspec is implied by any of the options given on the command | |
01eadafc | 1505 | line. Possible values are: |
52153747 FAG |
1506 | + |
1507 | * `nothing` do not push anything. | |
01eadafc | 1508 | * `matching` push all matching branches. |
52153747 | 1509 | All branches having the same name in both ends are considered to be |
01eadafc | 1510 | matching. This is the default. |
e892dc71 | 1511 | * `tracking` push the current branch to its upstream branch. |
01eadafc | 1512 | * `current` push the current branch to a branch of the same name. |
52153747 | 1513 | |
a9c3821c TAV |
1514 | rebase.stat:: |
1515 | Whether to show a diffstat of what changed upstream since the last | |
1516 | rebase. False by default. | |
1517 | ||
77e3efbf JH |
1518 | receive.autogc:: |
1519 | By default, git-receive-pack will run "git-gc --auto" after | |
1520 | receiving data from git-push and updating refs. You can stop | |
1521 | it by setting this variable to false. | |
1522 | ||
b0f34c3d MM |
1523 | receive.fsckObjects:: |
1524 | If it is set to true, git-receive-pack will check all received | |
1525 | objects. It will abort in the case of a malformed object or a | |
1526 | broken link. The result of an abort are only dangling objects. | |
1527 | Defaults to false. | |
1528 | ||
1529 | receive.unpackLimit:: | |
1530 | If the number of objects received in a push is below this | |
1531 | limit then the objects will be unpacked into loose object | |
1532 | files. However if the number of received objects equals or | |
1533 | exceeds this limit then the received pack will be stored as | |
1534 | a pack, after adding any missing delta bases. Storing the | |
1535 | pack from a push can make the push operation complete faster, | |
1536 | especially on slow filesystems. If not set, the value of | |
1537 | `transfer.unpackLimit` is used instead. | |
1538 | ||
42fc11c1 JH |
1539 | receive.denyDeletes:: |
1540 | If set to true, git-receive-pack will deny a ref update that deletes | |
1541 | the ref. Use this to prevent such a ref deletion via a push. | |
1542 | ||
1543 | receive.denyCurrentBranch:: | |
f3838ce1 | 1544 | If set to true or "refuse", git-receive-pack will deny a ref update |
42fc11c1 JH |
1545 | to the currently checked out branch of a non-bare repository. |
1546 | Such a push is potentially dangerous because it brings the HEAD | |
1547 | out of sync with the index and working tree. If set to "warn", | |
1548 | print a warning of such a push to stderr, but allow the push to | |
1549 | proceed. If set to false or "ignore", allow such pushes with no | |
7d182f52 | 1550 | message. Defaults to "refuse". |
42fc11c1 | 1551 | |
b0f34c3d MM |
1552 | receive.denyNonFastForwards:: |
1553 | If set to true, git-receive-pack will deny a ref update which is | |
a75d7b54 | 1554 | not a fast-forward. Use this to prevent such an update via a push, |
b0f34c3d MM |
1555 | even if that push is forced. This configuration variable is |
1556 | set when initializing a shared repository. | |
1557 | ||
77e3efbf JH |
1558 | receive.updateserverinfo:: |
1559 | If set to true, git-receive-pack will run git-update-server-info | |
1560 | after receiving data from git-push and updating refs. | |
1561 | ||
0cc6d346 | 1562 | remote.<name>.url:: |
5162e697 DM |
1563 | The URL of a remote repository. See linkgit:git-fetch[1] or |
1564 | linkgit:git-push[1]. | |
0cc6d346 | 1565 | |
20346234 MG |
1566 | remote.<name>.pushurl:: |
1567 | The push URL of a remote repository. See linkgit:git-push[1]. | |
1568 | ||
14c98218 SV |
1569 | remote.<name>.proxy:: |
1570 | For remotes that require curl (http, https and ftp), the URL to | |
1571 | the proxy to use for that remote. Set to the empty string to | |
1572 | disable proxying for that remote. | |
1573 | ||
0cc6d346 | 1574 | remote.<name>.fetch:: |
5162e697 DM |
1575 | The default set of "refspec" for linkgit:git-fetch[1]. See |
1576 | linkgit:git-fetch[1]. | |
0cc6d346 SB |
1577 | |
1578 | remote.<name>.push:: | |
5162e697 DM |
1579 | The default set of "refspec" for linkgit:git-push[1]. See |
1580 | linkgit:git-push[1]. | |
0cc6d346 | 1581 | |
84bb2dfd PB |
1582 | remote.<name>.mirror:: |
1583 | If true, pushing to this remote will automatically behave | |
1584 | as if the `\--mirror` option was given on the command line. | |
1585 | ||
1918278e TT |
1586 | remote.<name>.skipDefaultUpdate:: |
1587 | If true, this remote will be skipped by default when updating | |
7cc91a2f BG |
1588 | using linkgit:git-fetch[1] or the `update` subcommand of |
1589 | linkgit:git-remote[1]. | |
1590 | ||
1591 | remote.<name>.skipFetchAll:: | |
1592 | If true, this remote will be skipped by default when updating | |
1593 | using linkgit:git-fetch[1] or the `update` subcommand of | |
1594 | linkgit:git-remote[1]. | |
1918278e | 1595 | |
060aafc1 | 1596 | remote.<name>.receivepack:: |
5dee29ac | 1597 | The default program to execute on the remote side when pushing. See |
79f43f3d | 1598 | option \--receive-pack of linkgit:git-push[1]. |
060aafc1 | 1599 | |
5dee29ac UKK |
1600 | remote.<name>.uploadpack:: |
1601 | The default program to execute on the remote side when fetching. See | |
79f43f3d | 1602 | option \--upload-pack of linkgit:git-fetch-pack[1]. |
5dee29ac | 1603 | |
047f636d | 1604 | remote.<name>.tagopt:: |
79f43f3d | 1605 | Setting this value to \--no-tags disables automatic tag following when |
944163a4 ST |
1606 | fetching from remote <name>. Setting it to \--tags will fetch every |
1607 | tag from remote <name>, even if they are not reachable from remote | |
1608 | branch heads. | |
047f636d | 1609 | |
c578f51d DB |
1610 | remote.<name>.vcs:: |
1611 | Setting this to a value <vcs> will cause git to interact with | |
1612 | the remote with the git-remote-<vcs> helper. | |
1613 | ||
1918278e TT |
1614 | remotes.<group>:: |
1615 | The list of remotes which are fetched by "git remote update | |
5162e697 | 1616 | <group>". See linkgit:git-remote[1]. |
1918278e | 1617 | |
b6945f57 | 1618 | repack.usedeltabaseoffset:: |
22c79eab NP |
1619 | By default, linkgit:git-repack[1] creates packs that use |
1620 | delta-base offset. If you need to share your repository with | |
1621 | git older than version 1.4.4, either directly or via a dumb | |
1622 | protocol such as http, then you need to set this option to | |
1623 | "false" and repack. Access from old git versions over the | |
1624 | native protocol are unaffected by this option. | |
b6945f57 | 1625 | |
b0f34c3d MM |
1626 | rerere.autoupdate:: |
1627 | When set to true, `git-rerere` updates the index with the | |
1628 | resulting contents after it cleanly resolves conflicts using | |
1629 | previously recorded resolution. Defaults to false. | |
1630 | ||
1631 | rerere.enabled:: | |
1632 | Activate recording of resolved conflicts, so that identical | |
1633 | conflict hunks can be resolved automatically, should they | |
1634 | be encountered again. linkgit:git-rerere[1] command is by | |
1635 | default enabled if you create `rr-cache` directory under | |
1636 | `$GIT_DIR`, but can be disabled by setting this option to false. | |
1637 | ||
65180c66 YD |
1638 | sendemail.identity:: |
1639 | A configuration identity. When given, causes values in the | |
1640 | 'sendemail.<identity>' subsection to take precedence over | |
1641 | values in the 'sendemail' section. The default identity is | |
1642 | the value of 'sendemail.identity'. | |
1643 | ||
1644 | sendemail.smtpencryption:: | |
1645 | See linkgit:git-send-email[1] for description. Note that this | |
1646 | setting is not subject to the 'identity' mechanism. | |
1647 | ||
1648 | sendemail.smtpssl:: | |
1649 | Deprecated alias for 'sendemail.smtpencryption = ssl'. | |
1650 | ||
1651 | sendemail.<identity>.*:: | |
1652 | Identity-specific versions of the 'sendemail.*' parameters | |
1653 | found below, taking precedence over those when the this | |
1654 | identity is selected, through command-line or | |
1655 | 'sendemail.identity'. | |
1656 | ||
1657 | sendemail.aliasesfile:: | |
1658 | sendemail.aliasfiletype:: | |
1659 | sendemail.bcc:: | |
1660 | sendemail.cc:: | |
1661 | sendemail.cccmd:: | |
1662 | sendemail.chainreplyto:: | |
1663 | sendemail.confirm:: | |
1664 | sendemail.envelopesender:: | |
1665 | sendemail.from:: | |
1666 | sendemail.multiedit:: | |
1667 | sendemail.signedoffbycc:: | |
1668 | sendemail.smtppass:: | |
1669 | sendemail.suppresscc:: | |
1670 | sendemail.suppressfrom:: | |
1671 | sendemail.to:: | |
69cf7bfd | 1672 | sendemail.smtpdomain:: |
65180c66 YD |
1673 | sendemail.smtpserver:: |
1674 | sendemail.smtpserverport:: | |
1675 | sendemail.smtpuser:: | |
1676 | sendemail.thread:: | |
1677 | sendemail.validate:: | |
1678 | See linkgit:git-send-email[1] for description. | |
1679 | ||
1680 | sendemail.signedoffcc:: | |
1681 | Deprecated alias for 'sendemail.signedoffbycc'. | |
1682 | ||
1ab661dd | 1683 | showbranch.default:: |
5162e697 DM |
1684 | The default set of branches for linkgit:git-show-branch[1]. |
1685 | See linkgit:git-show-branch[1]. | |
1ab661dd | 1686 | |
46f721c8 | 1687 | status.relativePaths:: |
5162e697 | 1688 | By default, linkgit:git-status[1] shows paths relative to the |
46f721c8 JK |
1689 | current directory. Setting this variable to `false` shows paths |
1690 | relative to the repository root (this was the default for git | |
1691 | prior to v1.5.4). | |
1692 | ||
d6293d1f MSO |
1693 | status.showUntrackedFiles:: |
1694 | By default, linkgit:git-status[1] and linkgit:git-commit[1] show | |
1695 | files which are not currently tracked by Git. Directories which | |
1696 | contain only untracked files, are shown with the directory name | |
1697 | only. Showing untracked files means that Git needs to lstat() all | |
1698 | all the files in the whole repository, which might be slow on some | |
1699 | systems. So, this variable controls how the commands displays | |
1700 | the untracked files. Possible values are: | |
1701 | + | |
1702 | -- | |
1703 | - 'no' - Show no untracked files | |
1704 | - 'normal' - Shows untracked files and directories | |
1705 | - 'all' - Shows also individual files in untracked directories. | |
1706 | -- | |
1707 | + | |
1708 | If this variable is not specified, it defaults to 'normal'. | |
1709 | This variable can be overridden with the -u|--untracked-files option | |
1710 | of linkgit:git-status[1] and linkgit:git-commit[1]. | |
1711 | ||
4b2343fa MG |
1712 | status.submodulesummary:: |
1713 | Defaults to false. | |
1714 | If this is set to a non zero number or true (identical to -1 or an | |
1715 | unlimited number), the submodule summary will be enabled and a | |
1716 | summary of commits for modified submodules will be shown (see | |
1717 | --summary-limit option of linkgit:git-submodule[1]). | |
1718 | ||
ce1a79b6 | 1719 | tar.umask:: |
687157c7 RS |
1720 | This variable can be used to restrict the permission bits of |
1721 | tar archive entries. The default is 0002, which turns off the | |
1722 | world write bit. The special value "user" indicates that the | |
1723 | archiving user's umask will be used instead. See umask(2) and | |
5162e697 | 1724 | linkgit:git-archive[1]. |
ce1a79b6 | 1725 | |
b0f34c3d MM |
1726 | transfer.unpackLimit:: |
1727 | When `fetch.unpackLimit` or `receive.unpackLimit` are | |
1728 | not set, the value of this variable is used instead. | |
1729 | The default value is 100. | |
1730 | ||
55029ae4 DB |
1731 | url.<base>.insteadOf:: |
1732 | Any URL that starts with this value will be rewritten to | |
1733 | start, instead, with <base>. In cases where some site serves a | |
1734 | large number of repositories, and serves them with multiple | |
1735 | access methods, and some users need to use different access | |
1736 | methods, this feature allows people to specify any of the | |
1737 | equivalent URLs and have git automatically rewrite the URL to | |
1738 | the best alternative for the particular user, even for a | |
844112ca JH |
1739 | never-before-seen repository on the site. When more than one |
1740 | insteadOf strings match a given URL, the longest match is used. | |
55029ae4 | 1741 | |
1c2eafb8 JT |
1742 | url.<base>.pushInsteadOf:: |
1743 | Any URL that starts with this value will not be pushed to; | |
1744 | instead, it will be rewritten to start with <base>, and the | |
1745 | resulting URL will be pushed to. In cases where some site serves | |
1746 | a large number of repositories, and serves them with multiple | |
1747 | access methods, some of which do not allow push, this feature | |
1748 | allows people to specify a pull-only URL and have git | |
1749 | automatically use an appropriate URL to push, even for a | |
1750 | never-before-seen repository on the site. When more than one | |
1751 | pushInsteadOf strings match a given URL, the longest match is | |
1752 | used. If a remote has an explicit pushurl, git will ignore this | |
1753 | setting for that remote. | |
1754 | ||
1ab661dd PB |
1755 | user.email:: |
1756 | Your email address to be recorded in any newly created commits. | |
28a94f88 | 1757 | Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and |
5162e697 | 1758 | 'EMAIL' environment variables. See linkgit:git-commit-tree[1]. |
1ab661dd PB |
1759 | |
1760 | user.name:: | |
1761 | Your full name to be recorded in any newly created commits. | |
abda1ef5 | 1762 | Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' |
5162e697 | 1763 | environment variables. See linkgit:git-commit-tree[1]. |
1ab661dd | 1764 | |
d67778ec | 1765 | user.signingkey:: |
5162e697 | 1766 | If linkgit:git-tag[1] is not selecting the key you want it to |
d67778ec AP |
1767 | automatically when creating a signed tag, you can override the |
1768 | default selection with this variable. This option is passed | |
1769 | unchanged to gpg's --local-user parameter, so you may specify a key | |
1770 | using any method that gpg supports. | |
1771 | ||
983a9eeb CC |
1772 | web.browser:: |
1773 | Specify a web browser that may be used by some commands. | |
1774 | Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] | |
1775 | may use it. |