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