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