Merge branch 'es/osx-header-pollutes-mask-macro' into maint
[git/git.git] / Documentation / config.txt
2 ------------------
4 The Git configuration file contains a number of variables that affect
5 the Git commands' behavior. The `.git/config` file in each repository
6 is used to store the configuration for that repository, and
7 `$HOME/.gitconfig` is used to store a per-user configuration as
8 fallback values for the `.git/config` file. The file `/etc/gitconfig`
9 can be used to store a system-wide default configuration.
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
14 dot-separated segment and the section name is everything before the last
15 dot. The variable names are case-insensitive, allow only alphanumeric
16 characters and `-`, and must start with an alphabetic character. Some
17 variables may appear multiple times; we say then that the variable is
18 multivalued.
20 Syntax
21 ~~~~~~
23 The syntax is fairly flexible and permissive; whitespaces are mostly
24 ignored. The '#' and ';' characters begin comments to the end of line,
25 blank lines are ignored.
27 The file consists of sections and variables. A section begins with
28 the name of the section in square brackets and continues until the next
29 section begins. Section names are case-insensitive. Only alphanumeric
30 characters, `-` and `.` are allowed in section names. Each variable
31 must belong to some section, which means that there must be a section
32 header before the first setting of a variable.
34 Sections can be further divided into subsections. To begin a subsection
35 put its name in double quotes, separated by space from the section name,
36 in the section header, like in the example below:
38 --------
39 [section "subsection"]
41 --------
43 Subsection names are case sensitive and can contain any characters except
44 newline (doublequote `"` and backslash can be included by escaping them
45 as `\"` and `\\`, respectively). Section headers cannot span multiple
46 lines. Variables may belong directly to a section or to a given subsection.
47 You can have `[section]` if you have `[section "subsection"]`, but you
48 don't need to.
50 There is also a deprecated `[section.subsection]` syntax. With this
51 syntax, the subsection name is converted to lower-case and is also
52 compared case sensitively. These subsection names follow the same
53 restrictions as section names.
55 All the other lines (and the remainder of the line after the section
56 header) are recognized as setting variables, in the form
57 'name = value' (or just 'name', which is a short-hand to say that
58 the variable is the boolean "true").
59 The variable names are case-insensitive, allow only alphanumeric characters
60 and `-`, and must start with an alphabetic character.
62 A line that defines a value can be continued to the next line by
63 ending it with a `\`; the backquote and the end-of-line are
64 stripped. Leading whitespaces after 'name =', the remainder of the
65 line after the first comment character '#' or ';', and trailing
66 whitespaces of the line are discarded unless they are enclosed in
67 double quotes. Internal whitespaces within the value are retained
68 verbatim.
70 Inside double quotes, double quote `"` and backslash `\` characters
71 must be escaped: use `\"` for `"` and `\\` for `\`.
73 The following escape sequences (beside `\"` and `\\`) are recognized:
74 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
75 and `\b` for backspace (BS). Other char escape sequences (including octal
76 escape sequences) are invalid.
79 Includes
80 ~~~~~~~~
82 You can include one config file from another by setting the special
83 `include.path` variable to the name of the file to be included. The
84 included file is expanded immediately, as if its contents had been
85 found at the location of the include directive. If the value of the
86 `include.path` variable is a relative path, the path is considered to be
87 relative to the configuration file in which the include directive was
88 found. The value of `include.path` is subject to tilde expansion: `~/`
89 is expanded to the value of `$HOME`, and `~user/` to the specified
90 user's home directory. See below for examples.
92 Example
93 ~~~~~~~
95 # Core variables
96 [core]
97 ; Don't trust file modes
98 filemode = false
100 # Our diff algorithm
101 [diff]
102 external = /usr/local/bin/diff-wrapper
103 renames = true
105 [branch "devel"]
106 remote = origin
107 merge = refs/heads/devel
109 # Proxy settings
110 [core]
111 gitProxy="ssh" for ""
112 gitProxy=default-proxy ; for the rest
114 [include]
115 path = /path/to/ ; include by absolute path
116 path = foo ; expand "foo" relative to the current file
117 path = ~/foo ; expand "foo" in your $HOME directory
120 Values
121 ~~~~~~
123 Values of many variables are treated as a simple string, but there
124 are variables that take values of specific types and there are rules
125 as to how to spell them.
127 boolean::
129 When a variable is said to take a boolean value, many
130 synonyms are accepted for 'true' and 'false'; these are all
131 case-insensitive.
133 true;; Boolean true can be spelled as `yes`, `on`, `true`,
134 or `1`. Also, a variable defined without `= <value>`
135 is taken as true.
137 false;; Boolean false can be spelled as `no`, `off`,
138 `false`, or `0`.
139 +
140 When converting value to the canonical form using '--bool' type
141 specifier; 'git config' will ensure that the output is "true" or
142 "false" (spelled in lowercase).
144 integer::
145 The value for many variables that specify various sizes can
146 be suffixed with `k`, `M`,... to mean "scale the number by
147 1024", "by 1024x1024", etc.
149 color::
150 The value for a variables that takes a color is a list of
151 colors (at most two) and attributes (at most one), separated
152 by spaces. The colors accepted are `normal`, `black`,
153 `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
154 `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
155 `reverse`. The first color given is the foreground; the
156 second is the background. The position of the attribute, if
157 any, doesn't matter. Attributes may be turned off specifically
158 by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
159 +
160 Colors (foreground and background) may also be given as numbers between
161 0 and 255; these use ANSI 256-color mode (but note that not all
162 terminals may support this). If your terminal supports it, you may also
163 specify 24-bit RGB values as hex, like `#ff0ab3`.
164 +
165 The attributes are meant to be reset at the beginning of each item
166 in the colored output, so setting color.decorate.branch to `black`
167 will paint that branch name in a plain `black`, even if the previous
168 thing on the same output line (e.g. opening parenthesis before the
169 list of branch names in `log --decorate` output) is set to be
170 painted with `bold` or some other attribute.
173 Variables
174 ~~~~~~~~~
176 Note that this list is non-comprehensive and not necessarily complete.
177 For command-specific variables, you will find a more detailed description
178 in the appropriate manual page.
180 Other git-related tools may and do use their own variables. When
181 inventing new variables for use in your own tool, make sure their
182 names do not conflict with those that are used by Git itself and
183 other popular tools, and describe them in your documentation.
186 advice.*::
187 These variables control various optional help messages designed to
188 aid new users. All 'advice.*' variables default to 'true', and you
189 can tell Git that you do not need help by setting these to 'false':
190 +
191 --
192 pushUpdateRejected::
193 Set this variable to 'false' if you want to disable
194 'pushNonFFCurrent',
195 'pushNonFFMatching', 'pushAlreadyExists',
196 'pushFetchFirst', and 'pushNeedsForce'
197 simultaneously.
198 pushNonFFCurrent::
199 Advice shown when linkgit:git-push[1] fails due to a
200 non-fast-forward update to the current branch.
201 pushNonFFMatching::
202 Advice shown when you ran linkgit:git-push[1] and pushed
203 'matching refs' explicitly (i.e. you used ':', or
204 specified a refspec that isn't your current branch) and
205 it resulted in a non-fast-forward error.
206 pushAlreadyExists::
207 Shown when linkgit:git-push[1] rejects an update that
208 does not qualify for fast-forwarding (e.g., a tag.)
209 pushFetchFirst::
210 Shown when linkgit:git-push[1] rejects an update that
211 tries to overwrite a remote ref that points at an
212 object we do not have.
213 pushNeedsForce::
214 Shown when linkgit:git-push[1] rejects an update that
215 tries to overwrite a remote ref that points at an
216 object that is not a commit-ish, or make the remote
217 ref point at an object that is not a commit-ish.
218 statusHints::
219 Show directions on how to proceed from the current
220 state in the output of linkgit:git-status[1], in
221 the template shown when writing commit messages in
222 linkgit:git-commit[1], and in the help message shown
223 by linkgit:git-checkout[1] when switching branch.
224 statusUoption::
225 Advise to consider using the `-u` option to linkgit:git-status[1]
226 when the command takes more than 2 seconds to enumerate untracked
227 files.
228 commitBeforeMerge::
229 Advice shown when linkgit:git-merge[1] refuses to
230 merge to avoid overwriting local changes.
231 resolveConflict::
232 Advice shown by various commands when conflicts
233 prevent the operation from being performed.
234 implicitIdentity::
235 Advice on how to set your identity configuration when
236 your information is guessed from the system username and
237 domain name.
238 detachedHead::
239 Advice shown when you used linkgit:git-checkout[1] to
240 move to the detach HEAD state, to instruct how to create
241 a local branch after the fact.
242 amWorkDir::
243 Advice that shows the location of the patch file when
244 linkgit:git-am[1] fails to apply it.
245 rmHints::
246 In case of failure in the output of linkgit:git-rm[1],
247 show directions on how to proceed from the current state.
248 --
250 core.fileMode::
251 Tells Git if the executable bit of files in the working tree
252 is to be honored.
253 +
254 Some filesystems lose the executable bit when a file that is
255 marked as executable is checked out, or checks out an
256 non-executable file with executable bit on.
257 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
258 to see if it handles the executable bit correctly
259 and this variable is automatically set as necessary.
260 +
261 A repository, however, may be on a filesystem that handles
262 the filemode correctly, and this variable is set to 'true'
263 when created, but later may be made accessible from another
264 environment that loses the filemode (e.g. exporting ext4 via
265 CIFS mount, visiting a Cygwin created repository with
266 Git for Windows or Eclipse).
267 In such a case it may be necessary to set this variable to 'false'.
268 See linkgit:git-update-index[1].
269 +
270 The default is true (when core.filemode is not specified in the config file).
272 core.ignoreCase::
273 If true, this option enables various workarounds to enable
274 Git to work better on filesystems that are not case sensitive,
275 like FAT. For example, if a directory listing finds
276 "makefile" when Git expects "Makefile", Git will assume
277 it is really the same file, and continue to remember it as
278 "Makefile".
279 +
280 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
281 will probe and set core.ignoreCase true if appropriate when the repository
282 is created.
284 core.precomposeUnicode::
285 This option is only used by Mac OS implementation of Git.
286 When core.precomposeUnicode=true, Git reverts the unicode decomposition
287 of filenames done by Mac OS. This is useful when sharing a repository
288 between Mac OS and Linux or Windows.
289 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
290 When false, file names are handled fully transparent by Git,
291 which is backward compatible with older versions of Git.
293 core.protectHFS::
294 If set to true, do not allow checkout of paths that would
295 be considered equivalent to `.git` on an HFS+ filesystem.
296 Defaults to `true` on Mac OS, and `false` elsewhere.
298 core.protectNTFS::
299 If set to true, do not allow checkout of paths that would
300 cause problems with the NTFS filesystem, e.g. conflict with
301 8.3 "short" names.
302 Defaults to `true` on Windows, and `false` elsewhere.
304 core.trustctime::
305 If false, the ctime differences between the index and the
306 working tree are ignored; useful when the inode change time
307 is regularly modified by something outside Git (file system
308 crawlers and some backup systems).
309 See linkgit:git-update-index[1]. True by default.
311 core.checkStat::
312 Determines which stat fields to match between the index
313 and work tree. The user can set this to 'default' or
314 'minimal'. Default (or explicitly 'default'), is to check
315 all fields, including the sub-second part of mtime and ctime.
317 core.quotePath::
318 The commands that output paths (e.g. 'ls-files',
319 'diff'), when not given the `-z` option, will quote
320 "unusual" characters in the pathname by enclosing the
321 pathname in a double-quote pair and with backslashes the
322 same way strings in C source code are quoted. If this
323 variable is set to false, the bytes higher than 0x80 are
324 not quoted but output as verbatim. Note that double
325 quote, backslash and control characters are always
326 quoted without `-z` regardless of the setting of this
327 variable.
329 core.eol::
330 Sets the line ending type to use in the working directory for
331 files that have the `text` property set. Alternatives are
332 'lf', 'crlf' and 'native', which uses the platform's native
333 line ending. The default value is `native`. See
334 linkgit:gitattributes[5] for more information on end-of-line
335 conversion.
337 core.safecrlf::
338 If true, makes Git check if converting `CRLF` is reversible when
339 end-of-line conversion is active. Git will verify if a command
340 modifies a file in the work tree either directly or indirectly.
341 For example, committing a file followed by checking out the
342 same file should yield the original file in the work tree. If
343 this is not the case for the current setting of
344 `core.autocrlf`, Git will reject the file. The variable can
345 be set to "warn", in which case Git will only warn about an
346 irreversible conversion but continue the operation.
347 +
348 CRLF conversion bears a slight chance of corrupting data.
349 When it is enabled, Git will convert CRLF to LF during commit and LF to
350 CRLF during checkout. A file that contains a mixture of LF and
351 CRLF before the commit cannot be recreated by Git. For text
352 files this is the right thing to do: it corrects line endings
353 such that we have only LF line endings in the repository.
354 But for binary files that are accidentally classified as text the
355 conversion can corrupt data.
356 +
357 If you recognize such corruption early you can easily fix it by
358 setting the conversion type explicitly in .gitattributes. Right
359 after committing you still have the original file in your work
360 tree and this file is not yet corrupted. You can explicitly tell
361 Git that this file is binary and Git will handle the file
362 appropriately.
363 +
364 Unfortunately, the desired effect of cleaning up text files with
365 mixed line endings and the undesired effect of corrupting binary
366 files cannot be distinguished. In both cases CRLFs are removed
367 in an irreversible way. For text files this is the right thing
368 to do because CRLFs are line endings, while for binary files
369 converting CRLFs corrupts data.
370 +
371 Note, this safety check does not mean that a checkout will generate a
372 file identical to the original file for a different setting of
373 `core.eol` and `core.autocrlf`, but only for the current one. For
374 example, a text file with `LF` would be accepted with `core.eol=lf`
375 and could later be checked out with `core.eol=crlf`, in which case the
376 resulting file would contain `CRLF`, although the original file
377 contained `LF`. However, in both work trees the line endings would be
378 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
379 file with mixed line endings would be reported by the `core.safecrlf`
380 mechanism.
382 core.autocrlf::
383 Setting this variable to "true" is almost the same as setting
384 the `text` attribute to "auto" on all files except that text
385 files are not guaranteed to be normalized: files that contain
386 `CRLF` in the repository will not be touched. Use this
387 setting if you want to have `CRLF` line endings in your
388 working directory even though the repository does not have
389 normalized line endings. This variable can be set to 'input',
390 in which case no output conversion is performed.
392 core.symlinks::
393 If false, symbolic links are checked out as small plain files that
394 contain the link text. linkgit:git-update-index[1] and
395 linkgit:git-add[1] will not change the recorded type to regular
396 file. Useful on filesystems like FAT that do not support
397 symbolic links.
398 +
399 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
400 will probe and set core.symlinks false if appropriate when the repository
401 is created.
403 core.gitProxy::
404 A "proxy command" to execute (as 'command host port') instead
405 of establishing direct connection to the remote server when
406 using the Git protocol for fetching. If the variable value is
407 in the "COMMAND for DOMAIN" format, the command is applied only
408 on hostnames ending with the specified domain string. This variable
409 may be set multiple times and is matched in the given order;
410 the first match wins.
411 +
412 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
413 (which always applies universally, without the special "for"
414 handling).
415 +
416 The special string `none` can be used as the proxy command to
417 specify that no proxy be used for a given domain pattern.
418 This is useful for excluding servers inside a firewall from
419 proxy use, while defaulting to a common proxy for external domains.
421 core.ignoreStat::
422 If true, Git will avoid using lstat() calls to detect if files have
423 changed by setting the "assume-unchanged" bit for those tracked files
424 which it has updated identically in both the index and working tree.
425 +
426 When files are modified outside of Git, the user will need to stage
427 the modified files explicitly (e.g. see 'Examples' section in
428 linkgit:git-update-index[1]).
429 Git will not normally detect changes to those files.
430 +
431 This is useful on systems where lstat() calls are very slow, such as
432 CIFS/Microsoft Windows.
433 +
434 False by default.
436 core.preferSymlinkRefs::
437 Instead of the default "symref" format for HEAD
438 and other symbolic reference files, use symbolic links.
439 This is sometimes needed to work with old scripts that
440 expect HEAD to be a symbolic link.
442 core.bare::
443 If true this repository is assumed to be 'bare' and has no
444 working directory associated with it. If this is the case a
445 number of commands that require a working directory will be
446 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
447 +
448 This setting is automatically guessed by linkgit:git-clone[1] or
449 linkgit:git-init[1] when the repository was created. By default a
450 repository that ends in "/.git" is assumed to be not bare (bare =
451 false), while all other repositories are assumed to be bare (bare
452 = true).
454 core.worktree::
455 Set the path to the root of the working tree.
456 This can be overridden by the GIT_WORK_TREE environment
457 variable and the '--work-tree' command-line option.
458 The value can be an absolute path or relative to the path to
459 the .git directory, which is either specified by --git-dir
460 or GIT_DIR, or automatically discovered.
461 If --git-dir or GIT_DIR is specified but none of
462 --work-tree, GIT_WORK_TREE and core.worktree is specified,
463 the current working directory is regarded as the top level
464 of your working tree.
465 +
466 Note that this variable is honored even when set in a configuration
467 file in a ".git" subdirectory of a directory and its value differs
468 from the latter directory (e.g. "/path/to/.git/config" has
469 core.worktree set to "/different/path"), which is most likely a
470 misconfiguration. Running Git commands in the "/path/to" directory will
471 still use "/different/path" as the root of the work tree and can cause
472 confusion unless you know what you are doing (e.g. you are creating a
473 read-only snapshot of the same index to a location different from the
474 repository's usual working tree).
476 core.logAllRefUpdates::
477 Enable the reflog. Updates to a ref <ref> is logged to the file
478 "$GIT_DIR/logs/<ref>", by appending the new and old
479 SHA-1, the date/time and the reason of the update, but
480 only when the file exists. If this configuration
481 variable is set to true, missing "$GIT_DIR/logs/<ref>"
482 file is automatically created for branch heads (i.e. under
483 refs/heads/), remote refs (i.e. under refs/remotes/),
484 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
485 +
486 This information can be used to determine what commit
487 was the tip of a branch "2 days ago".
488 +
489 This value is true by default in a repository that has
490 a working directory associated with it, and false by
491 default in a bare repository.
493 core.repositoryFormatVersion::
494 Internal variable identifying the repository format and layout
495 version.
497 core.sharedRepository::
498 When 'group' (or 'true'), the repository is made shareable between
499 several users in a group (making sure all the files and objects are
500 group-writable). When 'all' (or 'world' or 'everybody'), the
501 repository will be readable by all users, additionally to being
502 group-shareable. When 'umask' (or 'false'), Git will use permissions
503 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
504 files in the repository will have this mode value. '0xxx' will override
505 user's umask value (whereas the other options will only override
506 requested parts of the user's umask value). Examples: '0660' will make
507 the repo read/write-able for the owner and group, but inaccessible to
508 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
509 repository that is group-readable but not group-writable.
510 See linkgit:git-init[1]. False by default.
512 core.warnAmbiguousRefs::
513 If true, Git will warn you if the ref name you passed it is ambiguous
514 and might match multiple refs in the repository. True by default.
516 core.compression::
517 An integer -1..9, indicating a default compression level.
518 -1 is the zlib default. 0 means no compression,
519 and 1..9 are various speed/size tradeoffs, 9 being slowest.
520 If set, this provides a default to other compression variables,
521 such as 'core.looseCompression' and 'pack.compression'.
523 core.looseCompression::
524 An integer -1..9, indicating the compression level for objects that
525 are not in a pack file. -1 is the zlib default. 0 means no
526 compression, and 1..9 are various speed/size tradeoffs, 9 being
527 slowest. If not set, defaults to core.compression. If that is
528 not set, defaults to 1 (best speed).
530 core.packedGitWindowSize::
531 Number of bytes of a pack file to map into memory in a
532 single mapping operation. Larger window sizes may allow
533 your system to process a smaller number of large pack files
534 more quickly. Smaller window sizes will negatively affect
535 performance due to increased calls to the operating system's
536 memory manager, but may improve performance when accessing
537 a large number of large pack files.
538 +
539 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
540 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
541 be reasonable for all users/operating systems. You probably do
542 not need to adjust this value.
543 +
544 Common unit suffixes of 'k', 'm', or 'g' are supported.
546 core.packedGitLimit::
547 Maximum number of bytes to map simultaneously into memory
548 from pack files. If Git needs to access more than this many
549 bytes at once to complete an operation it will unmap existing
550 regions to reclaim virtual address space within the process.
551 +
552 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
553 This should be reasonable for all users/operating systems, except on
554 the largest projects. You probably do not need to adjust this value.
555 +
556 Common unit suffixes of 'k', 'm', or 'g' are supported.
558 core.deltaBaseCacheLimit::
559 Maximum number of bytes to reserve for caching base objects
560 that may be referenced by multiple deltified objects. By storing the
561 entire decompressed base objects in a cache Git is able
562 to avoid unpacking and decompressing frequently used base
563 objects multiple times.
564 +
565 Default is 96 MiB on all platforms. This should be reasonable
566 for all users/operating systems, except on the largest projects.
567 You probably do not need to adjust this value.
568 +
569 Common unit suffixes of 'k', 'm', or 'g' are supported.
571 core.bigFileThreshold::
572 Files larger than this size are stored deflated, without
573 attempting delta compression. Storing large files without
574 delta compression avoids excessive memory usage, at the
575 slight expense of increased disk usage. Additionally files
576 larger than this size are always treated as binary.
577 +
578 Default is 512 MiB on all platforms. This should be reasonable
579 for most projects as source code and other text files can still
580 be delta compressed, but larger binary media files won't be.
581 +
582 Common unit suffixes of 'k', 'm', or 'g' are supported.
584 core.excludesFile::
585 In addition to '.gitignore' (per-directory) and
586 '.git/info/exclude', Git looks into this file for patterns
587 of files which are not meant to be tracked. "`~/`" is expanded
588 to the value of `$HOME` and "`~user/`" to the specified user's
589 home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
590 If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
591 is used instead. See linkgit:gitignore[5].
593 core.askPass::
594 Some commands (e.g. svn and http interfaces) that interactively
595 ask for a password can be told to use an external program given
596 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
597 environment variable. If not set, fall back to the value of the
598 'SSH_ASKPASS' environment variable or, failing that, a simple password
599 prompt. The external program shall be given a suitable prompt as
600 command-line argument and write the password on its STDOUT.
602 core.attributesFile::
603 In addition to '.gitattributes' (per-directory) and
604 '.git/info/attributes', Git looks into this file for attributes
605 (see linkgit:gitattributes[5]). Path expansions are made the same
606 way as for `core.excludesFile`. Its default value is
607 $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
608 set or empty, $HOME/.config/git/attributes is used instead.
610 core.editor::
611 Commands such as `commit` and `tag` that lets you edit
612 messages by launching an editor uses the value of this
613 variable when it is set, and the environment variable
614 `GIT_EDITOR` is not set. See linkgit:git-var[1].
616 core.commentChar::
617 Commands such as `commit` and `tag` that lets you edit
618 messages consider a line that begins with this character
619 commented, and removes them after the editor returns
620 (default '#').
621 +
622 If set to "auto", `git-commit` would select a character that is not
623 the beginning character of any line in existing commit messages.
625 sequence.editor::
626 Text editor used by `git rebase -i` for editing the rebase instruction file.
627 The value is meant to be interpreted by the shell when it is used.
628 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
629 When not configured the default commit message editor is used instead.
631 core.pager::
632 Text viewer for use by Git commands (e.g., 'less'). The value
633 is meant to be interpreted by the shell. The order of preference
634 is the `$GIT_PAGER` environment variable, then `core.pager`
635 configuration, then `$PAGER`, and then the default chosen at
636 compile time (usually 'less').
637 +
638 When the `LESS` environment variable is unset, Git sets it to `FRX`
639 (if `LESS` environment variable is set, Git does not change it at
640 all). If you want to selectively override Git's default setting
641 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
642 be passed to the shell by Git, which will translate the final
643 command to `LESS=FRX less -S`. The environment does not set the
644 `S` option but the command line does, instructing less to truncate
645 long lines. Similarly, setting `core.pager` to `less -+F` will
646 deactivate the `F` option specified by the environment from the
647 command-line, deactivating the "quit if one screen" behavior of
648 `less`. One can specifically activate some flags for particular
649 commands: for example, setting `pager.blame` to `less -S` enables
650 line truncation only for `git blame`.
651 +
652 Likewise, when the `LV` environment variable is unset, Git sets it
653 to `-c`. You can override this setting by exporting `LV` with
654 another value or setting `core.pager` to `lv +c`.
656 core.whitespace::
657 A comma separated list of common whitespace problems to
658 notice. 'git diff' will use `color.diff.whitespace` to
659 highlight them, and 'git apply --whitespace=error' will
660 consider them as errors. You can prefix `-` to disable
661 any of them (e.g. `-trailing-space`):
662 +
663 * `blank-at-eol` treats trailing whitespaces at the end of the line
664 as an error (enabled by default).
665 * `space-before-tab` treats a space character that appears immediately
666 before a tab character in the initial indent part of the line as an
667 error (enabled by default).
668 * `indent-with-non-tab` treats a line that is indented with space
669 characters instead of the equivalent tabs as an error (not enabled by
670 default).
671 * `tab-in-indent` treats a tab character in the initial indent part of
672 the line as an error (not enabled by default).
673 * `blank-at-eof` treats blank lines added at the end of file as an error
674 (enabled by default).
675 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
676 `blank-at-eof`.
677 * `cr-at-eol` treats a carriage-return at the end of line as
678 part of the line terminator, i.e. with it, `trailing-space`
679 does not trigger if the character before such a carriage-return
680 is not a whitespace (not enabled by default).
681 * `tabwidth=<n>` tells how many character positions a tab occupies; this
682 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
683 errors. The default tab width is 8. Allowed values are 1 to 63.
685 core.fsyncObjectFiles::
686 This boolean will enable 'fsync()' when writing object files.
687 +
688 This is a total waste of time and effort on a filesystem that orders
689 data writes properly, but can be useful for filesystems that do not use
690 journalling (traditional UNIX filesystems) or that only journal metadata
691 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
693 core.preloadIndex::
694 Enable parallel index preload for operations like 'git diff'
695 +
696 This can speed up operations like 'git diff' and 'git status' especially
697 on filesystems like NFS that have weak caching semantics and thus
698 relatively high IO latencies. When enabled, Git will do the
699 index comparison to the filesystem data in parallel, allowing
700 overlapping IO's. Defaults to true.
702 core.createObject::
703 You can set this to 'link', in which case a hardlink followed by
704 a delete of the source are used to make sure that object creation
705 will not overwrite existing objects.
706 +
707 On some file system/operating system combinations, this is unreliable.
708 Set this config setting to 'rename' there; However, This will remove the
709 check that makes sure that existing object files will not get overwritten.
711 core.notesRef::
712 When showing commit messages, also show notes which are stored in
713 the given ref. The ref must be fully qualified. If the given
714 ref does not exist, it is not an error but means that no
715 notes should be printed.
716 +
717 This setting defaults to "refs/notes/commits", and it can be overridden by
718 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
720 core.sparseCheckout::
721 Enable "sparse checkout" feature. See section "Sparse checkout" in
722 linkgit:git-read-tree[1] for more information.
724 core.abbrev::
725 Set the length object names are abbreviated to. If unspecified,
726 many commands abbreviate to 7 hexdigits, which may not be enough
727 for abbreviated object names to stay unique for sufficiently long
728 time.
730 add.ignoreErrors::
731 add.ignore-errors (deprecated)::
732 Tells 'git add' to continue adding files when some files cannot be
733 added due to indexing errors. Equivalent to the '--ignore-errors'
734 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
735 as it does not follow the usual naming convention for configuration
736 variables.
738 alias.*::
739 Command aliases for the linkgit:git[1] command wrapper - e.g.
740 after defining "alias.last = cat-file commit HEAD", the invocation
741 "git last" is equivalent to "git cat-file commit HEAD". To avoid
742 confusion and troubles with script usage, aliases that
743 hide existing Git commands are ignored. Arguments are split by
744 spaces, the usual shell quoting and escaping is supported.
745 A quote pair or a backslash can be used to quote them.
746 +
747 If the alias expansion is prefixed with an exclamation point,
748 it will be treated as a shell command. For example, defining
749 " = !gitk --all --not ORIG_HEAD", the invocation
750 "git new" is equivalent to running the shell command
751 "gitk --all --not ORIG_HEAD". Note that shell commands will be
752 executed from the top-level directory of a repository, which may
753 not necessarily be the current directory.
754 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
755 from the original current directory. See linkgit:git-rev-parse[1].
757 am.keepcr::
758 If true, git-am will call git-mailsplit for patches in mbox format
759 with parameter '--keep-cr'. In this case git-mailsplit will
760 not remove `\r` from lines ending with `\r\n`. Can be overridden
761 by giving '--no-keep-cr' from the command line.
762 See linkgit:git-am[1], linkgit:git-mailsplit[1].
764 apply.ignoreWhitespace::
765 When set to 'change', tells 'git apply' to ignore changes in
766 whitespace, in the same way as the '--ignore-space-change'
767 option.
768 When set to one of: no, none, never, false tells 'git apply' to
769 respect all whitespace differences.
770 See linkgit:git-apply[1].
772 apply.whitespace::
773 Tells 'git apply' how to handle whitespaces, in the same way
774 as the '--whitespace' option. See linkgit:git-apply[1].
776 branch.autoSetupMerge::
777 Tells 'git branch' and 'git checkout' to set up new branches
778 so that linkgit:git-pull[1] will appropriately merge from the
779 starting point branch. Note that even if this option is not set,
780 this behavior can be chosen per-branch using the `--track`
781 and `--no-track` options. The valid settings are: `false` -- no
782 automatic setup is done; `true` -- automatic setup is done when the
783 starting point is a remote-tracking branch; `always` --
784 automatic setup is done when the starting point is either a
785 local branch or remote-tracking
786 branch. This option defaults to true.
788 branch.autoSetupRebase::
789 When a new branch is created with 'git branch' or 'git checkout'
790 that tracks another branch, this variable tells Git to set
791 up pull to rebase instead of merge (see "branch.<name>.rebase").
792 When `never`, rebase is never automatically set to true.
793 When `local`, rebase is set to true for tracked branches of
794 other local branches.
795 When `remote`, rebase is set to true for tracked branches of
796 remote-tracking branches.
797 When `always`, rebase will be set to true for all tracking
798 branches.
799 See "branch.autoSetupMerge" for details on how to set up a
800 branch to track another branch.
801 This option defaults to never.
803 branch.<name>.remote::
804 When on branch <name>, it tells 'git fetch' and 'git push'
805 which remote to fetch from/push to. The remote to push to
806 may be overridden with `remote.pushDefault` (for all branches).
807 The remote to push to, for the current branch, may be further
808 overridden by `branch.<name>.pushRemote`. If no remote is
809 configured, or if you are not on any branch, it defaults to
810 `origin` for fetching and `remote.pushDefault` for pushing.
811 Additionally, `.` (a period) is the current local repository
812 (a dot-repository), see `branch.<name>.merge`'s final note below.
814 branch.<name>.pushRemote::
815 When on branch <name>, it overrides `branch.<name>.remote` for
816 pushing. It also overrides `remote.pushDefault` for pushing
817 from branch <name>. When you pull from one place (e.g. your
818 upstream) and push to another place (e.g. your own publishing
819 repository), you would want to set `remote.pushDefault` to
820 specify the remote to push to for all branches, and use this
821 option to override it for a specific branch.
823 branch.<name>.merge::
824 Defines, together with branch.<name>.remote, the upstream branch
825 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
826 branch to merge and can also affect 'git push' (see push.default).
827 When in branch <name>, it tells 'git fetch' the default
828 refspec to be marked for merging in FETCH_HEAD. The value is
829 handled like the remote part of a refspec, and must match a
830 ref which is fetched from the remote given by
831 "branch.<name>.remote".
832 The merge information is used by 'git pull' (which at first calls
833 'git fetch') to lookup the default branch for merging. Without
834 this option, 'git pull' defaults to merge the first refspec fetched.
835 Specify multiple values to get an octopus merge.
836 If you wish to setup 'git pull' so that it merges into <name> from
837 another branch in the local repository, you can point
838 branch.<name>.merge to the desired branch, and use the relative path
839 setting `.` (a period) for branch.<name>.remote.
841 branch.<name>.mergeOptions::
842 Sets default options for merging into branch <name>. The syntax and
843 supported options are the same as those of linkgit:git-merge[1], but
844 option values containing whitespace characters are currently not
845 supported.
847 branch.<name>.rebase::
848 When true, rebase the branch <name> on top of the fetched branch,
849 instead of merging the default branch from the default remote when
850 "git pull" is run. See "pull.rebase" for doing this in a non
851 branch-specific manner.
852 +
853 When preserve, also pass `--preserve-merges` along to 'git rebase'
854 so that locally committed merge commits will not be flattened
855 by running 'git pull'.
856 +
857 *NOTE*: this is a possibly dangerous operation; do *not* use
858 it unless you understand the implications (see linkgit:git-rebase[1]
859 for details).
861 branch.<name>.description::
862 Branch description, can be edited with
863 `git branch --edit-description`. Branch description is
864 automatically added in the format-patch cover letter or
865 request-pull summary.
867 browser.<tool>.cmd::
868 Specify the command to invoke the specified browser. The
869 specified command is evaluated in shell with the URLs passed
870 as arguments. (See linkgit:git-web{litdd}browse[1].)
872 browser.<tool>.path::
873 Override the path for the given tool that may be used to
874 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
875 working repository in gitweb (see linkgit:git-instaweb[1]).
877 clean.requireForce::
878 A boolean to make git-clean do nothing unless given -f,
879 -i or -n. Defaults to true.
881 color.branch::
882 A boolean to enable/disable color in the output of
883 linkgit:git-branch[1]. May be set to `always`,
884 `false` (or `never`) or `auto` (or `true`), in which case colors are used
885 only when the output is to a terminal. Defaults to false.
887 color.branch.<slot>::
888 Use customized color for branch coloration. `<slot>` is one of
889 `current` (the current branch), `local` (a local branch),
890 `remote` (a remote-tracking branch in refs/remotes/),
891 `upstream` (upstream tracking branch), `plain` (other
892 refs).
894 color.diff::
895 Whether to use ANSI escape sequences to add color to patches.
896 If this is set to `always`, linkgit:git-diff[1],
897 linkgit:git-log[1], and linkgit:git-show[1] will use color
898 for all patches. If it is set to `true` or `auto`, those
899 commands will only use color when output is to the terminal.
900 Defaults to false.
901 +
902 This does not affect linkgit:git-format-patch[1] or the
903 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
904 command line with the `--color[=<when>]` option.
906 color.diff.<slot>::
907 Use customized color for diff colorization. `<slot>` specifies
908 which part of the patch to use the specified color, and is one
909 of `context` (context text - `plain` is a historical synonym),
910 `meta` (metainformation), `frag`
911 (hunk header), 'func' (function in hunk header), `old` (removed lines),
912 `new` (added lines), `commit` (commit headers), or `whitespace`
913 (highlighting whitespace errors).
915 color.decorate.<slot>::
916 Use customized color for 'git log --decorate' output. `<slot>` is one
917 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
918 branches, remote-tracking branches, tags, stash and HEAD, respectively.
920 color.grep::
921 When set to `always`, always highlight matches. When `false` (or
922 `never`), never. When set to `true` or `auto`, use color only
923 when the output is written to the terminal. Defaults to `false`.
925 color.grep.<slot>::
926 Use customized color for grep colorization. `<slot>` specifies which
927 part of the line to use the specified color, and is one of
928 +
929 --
930 `context`;;
931 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
932 `filename`;;
933 filename prefix (when not using `-h`)
934 `function`;;
935 function name lines (when using `-p`)
936 `linenumber`;;
937 line number prefix (when using `-n`)
938 `match`;;
939 matching text (same as setting `matchContext` and `matchSelected`)
940 `matchContext`;;
941 matching text in context lines
942 `matchSelected`;;
943 matching text in selected lines
944 `selected`;;
945 non-matching text in selected lines
946 `separator`;;
947 separators between fields on a line (`:`, `-`, and `=`)
948 and between hunks (`--`)
949 --
951 color.interactive::
952 When set to `always`, always use colors for interactive prompts
953 and displays (such as those used by "git-add --interactive" and
954 "git-clean --interactive"). When false (or `never`), never.
955 When set to `true` or `auto`, use colors only when the output is
956 to the terminal. Defaults to false.
958 color.interactive.<slot>::
959 Use customized color for 'git add --interactive' and 'git clean
960 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
961 or `error`, for four distinct types of normal output from
962 interactive commands.
964 color.pager::
965 A boolean to enable/disable colored output when the pager is in
966 use (default is true).
968 color.showBranch::
969 A boolean to enable/disable color in the output of
970 linkgit:git-show-branch[1]. May be set to `always`,
971 `false` (or `never`) or `auto` (or `true`), in which case colors are used
972 only when the output is to a terminal. Defaults to false.
974 color.status::
975 A boolean to enable/disable color in the output of
976 linkgit:git-status[1]. May be set to `always`,
977 `false` (or `never`) or `auto` (or `true`), in which case colors are used
978 only when the output is to a terminal. Defaults to false.
980 color.status.<slot>::
981 Use customized color for status colorization. `<slot>` is
982 one of `header` (the header text of the status message),
983 `added` or `updated` (files which are added but not committed),
984 `changed` (files which are changed but not added in the index),
985 `untracked` (files which are not tracked by Git),
986 `branch` (the current branch),
987 `nobranch` (the color the 'no branch' warning is shown in, defaulting
988 to red), or
989 `unmerged` (files which have unmerged changes).
991 color.ui::
992 This variable determines the default value for variables such
993 as `color.diff` and `color.grep` that control the use of color
994 per command family. Its scope will expand as more commands learn
995 configuration to set a default for the `--color` option. Set it
996 to `false` or `never` if you prefer Git commands not to use
997 color unless enabled explicitly with some other configuration
998 or the `--color` option. Set it to `always` if you want all
999 output not intended for machine consumption to use color, to
1000 `true` or `auto` (this is the default since Git 1.8.4) if you
1001 want such output to use color when written to the terminal.
1003 column.ui::
1004 Specify whether supported commands should output in columns.
1005 This variable consists of a list of tokens separated by spaces
1006 or commas:
1007 +
1008 These options control when the feature should be enabled
1009 (defaults to 'never'):
1010 +
1011 --
1012 `always`;;
1013 always show in columns
1014 `never`;;
1015 never show in columns
1016 `auto`;;
1017 show in columns if the output is to the terminal
1018 --
1019 +
1020 These options control layout (defaults to 'column'). Setting any
1021 of these implies 'always' if none of 'always', 'never', or 'auto' are
1022 specified.
1023 +
1024 --
1025 `column`;;
1026 fill columns before rows
1027 `row`;;
1028 fill rows before columns
1029 `plain`;;
1030 show in one column
1031 --
1032 +
1033 Finally, these options can be combined with a layout option (defaults
1034 to 'nodense'):
1035 +
1036 --
1037 `dense`;;
1038 make unequal size columns to utilize more space
1039 `nodense`;;
1040 make equal size columns
1041 --
1043 column.branch::
1044 Specify whether to output branch listing in `git branch` in columns.
1045 See `column.ui` for details.
1047 column.clean::
1048 Specify the layout when list items in `git clean -i`, which always
1049 shows files and directories in columns. See `column.ui` for details.
1051 column.status::
1052 Specify whether to output untracked files in `git status` in columns.
1053 See `column.ui` for details.
1055 column.tag::
1056 Specify whether to output tag listing in `git tag` in columns.
1057 See `column.ui` for details.
1059 commit.cleanup::
1060 This setting overrides the default of the `--cleanup` option in
1061 `git commit`. See linkgit:git-commit[1] for details. Changing the
1062 default can be useful when you always want to keep lines that begin
1063 with comment character `#` in your log message, in which case you
1064 would do `git config commit.cleanup whitespace` (note that you will
1065 have to remove the help lines that begin with `#` in the commit log
1066 template yourself, if you do this).
1068 commit.gpgSign::
1070 A boolean to specify whether all commits should be GPG signed.
1071 Use of this option when doing operations such as rebase can
1072 result in a large number of commits being signed. It may be
1073 convenient to use an agent to avoid typing your GPG passphrase
1074 several times.
1076 commit.status::
1077 A boolean to enable/disable inclusion of status information in the
1078 commit message template when using an editor to prepare the commit
1079 message. Defaults to true.
1081 commit.template::
1082 Specify a file to use as the template for new commit messages.
1083 "`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
1084 specified user's home directory.
1086 credential.helper::
1087 Specify an external helper to be called when a username or
1088 password credential is needed; the helper may consult external
1089 storage to avoid prompting the user for the credentials. See
1090 linkgit:gitcredentials[7] for details.
1092 credential.useHttpPath::
1093 When acquiring credentials, consider the "path" component of an http
1094 or https URL to be important. Defaults to false. See
1095 linkgit:gitcredentials[7] for more information.
1097 credential.username::
1098 If no username is set for a network authentication, use this username
1099 by default. See credential.<context>.* below, and
1100 linkgit:gitcredentials[7].
1102 credential.<url>.*::
1103 Any of the credential.* options above can be applied selectively to
1104 some credentials. For example "credential."
1105 would set the default username only for https connections to
1106 See linkgit:gitcredentials[7] for details on how URLs are
1107 matched.
1109 include::diff-config.txt[]
1111 difftool.<tool>.path::
1112 Override the path for the given tool. This is useful in case
1113 your tool is not in the PATH.
1115 difftool.<tool>.cmd::
1116 Specify the command to invoke the specified diff tool.
1117 The specified command is evaluated in shell with the following
1118 variables available: 'LOCAL' is set to the name of the temporary
1119 file containing the contents of the diff pre-image and 'REMOTE'
1120 is set to the name of the temporary file containing the contents
1121 of the diff post-image.
1123 difftool.prompt::
1124 Prompt before each invocation of the diff tool.
1126 fetch.recurseSubmodules::
1127 This option can be either set to a boolean value or to 'on-demand'.
1128 Setting it to a boolean changes the behavior of fetch and pull to
1129 unconditionally recurse into submodules when set to true or to not
1130 recurse at all when set to false. When set to 'on-demand' (the default
1131 value), fetch and pull will only recurse into a populated submodule
1132 when its superproject retrieves a commit that updates the submodule's
1133 reference.
1135 fetch.fsckObjects::
1136 If it is set to true, git-fetch-pack will check all fetched
1137 objects. It will abort in the case of a malformed object or a
1138 broken link. The result of an abort are only dangling objects.
1139 Defaults to false. If not set, the value of `transfer.fsckObjects`
1140 is used instead.
1142 fetch.unpackLimit::
1143 If the number of objects fetched over the Git native
1144 transfer is below this
1145 limit, then the objects will be unpacked into loose object
1146 files. However if the number of received objects equals or
1147 exceeds this limit then the received pack will be stored as
1148 a pack, after adding any missing delta bases. Storing the
1149 pack from a push can make the push operation complete faster,
1150 especially on slow filesystems. If not set, the value of
1151 `transfer.unpackLimit` is used instead.
1153 fetch.prune::
1154 If true, fetch will automatically behave as if the `--prune`
1155 option was given on the command line. See also `remote.<name>.prune`.
1157 format.attach::
1158 Enable multipart/mixed attachments as the default for
1159 'format-patch'. The value can also be a double quoted string
1160 which will enable attachments as the default and set the
1161 value as the boundary. See the --attach option in
1162 linkgit:git-format-patch[1].
1164 format.numbered::
1165 A boolean which can enable or disable sequence numbers in patch
1166 subjects. It defaults to "auto" which enables it only if there
1167 is more than one patch. It can be enabled or disabled for all
1168 messages by setting it to "true" or "false". See --numbered
1169 option in linkgit:git-format-patch[1].
1171 format.headers::
1172 Additional email headers to include in a patch to be submitted
1173 by mail. See linkgit:git-format-patch[1].
1177 Additional recipients to include in a patch to be submitted
1178 by mail. See the --to and --cc options in
1179 linkgit:git-format-patch[1].
1181 format.subjectPrefix::
1182 The default for format-patch is to output files with the '[PATCH]'
1183 subject prefix. Use this variable to change that prefix.
1185 format.signature::
1186 The default for format-patch is to output a signature containing
1187 the Git version number. Use this variable to change that default.
1188 Set this variable to the empty string ("") to suppress
1189 signature generation.
1191 format.signatureFile::
1192 Works just like format.signature except the contents of the
1193 file specified by this variable will be used as the signature.
1195 format.suffix::
1196 The default for format-patch is to output files with the suffix
1197 `.patch`. Use this variable to change that suffix (make sure to
1198 include the dot if you want it).
1200 format.pretty::
1201 The default pretty format for log/show/whatchanged command,
1202 See linkgit:git-log[1], linkgit:git-show[1],
1203 linkgit:git-whatchanged[1].
1205 format.thread::
1206 The default threading style for 'git format-patch'. Can be
1207 a boolean value, or `shallow` or `deep`. `shallow` threading
1208 makes every mail a reply to the head of the series,
1209 where the head is chosen from the cover letter, the
1210 `--in-reply-to`, and the first patch mail, in this order.
1211 `deep` threading makes every mail a reply to the previous one.
1212 A true boolean value is the same as `shallow`, and a false
1213 value disables threading.
1215 format.signOff::
1216 A boolean value which lets you enable the `-s/--signoff` option of
1217 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1218 patch should be a conscious act and means that you certify you have
1219 the rights to submit this work under the same open source license.
1220 Please see the 'SubmittingPatches' document for further discussion.
1222 format.coverLetter::
1223 A boolean that controls whether to generate a cover-letter when
1224 format-patch is invoked, but in addition can be set to "auto", to
1225 generate a cover-letter only when there's more than one patch.
1227 filter.<driver>.clean::
1228 The command which is used to convert the content of a worktree
1229 file to a blob upon checkin. See linkgit:gitattributes[5] for
1230 details.
1232 filter.<driver>.smudge::
1233 The command which is used to convert the content of a blob
1234 object to a worktree file upon checkout. See
1235 linkgit:gitattributes[5] for details.
1237 gc.aggressiveDepth::
1238 The depth parameter used in the delta compression
1239 algorithm used by 'git gc --aggressive'. This defaults
1240 to 250.
1242 gc.aggressiveWindow::
1243 The window size parameter used in the delta compression
1244 algorithm used by 'git gc --aggressive'. This defaults
1245 to 250.
1248 When there are approximately more than this many loose
1249 objects in the repository, `git gc --auto` will pack them.
1250 Some Porcelain commands use this command to perform a
1251 light-weight garbage collection from time to time. The
1252 default value is 6700. Setting this to 0 disables it.
1254 gc.autoPackLimit::
1255 When there are more than this many packs that are not
1256 marked with `*.keep` file in the repository, `git gc
1257 --auto` consolidates them into one larger pack. The
1258 default value is 50. Setting this to 0 disables it.
1260 gc.autoDetach::
1261 Make `git gc --auto` return immediately and run in background
1262 if the system supports it. Default is true.
1264 gc.packRefs::
1265 Running `git pack-refs` in a repository renders it
1266 unclonable by Git versions prior to over dumb
1267 transports such as HTTP. This variable determines whether
1268 'git gc' runs `git pack-refs`. This can be set to `notbare`
1269 to enable it within all non-bare repos or it can be set to a
1270 boolean value. The default is `true`.
1272 gc.pruneExpire::
1273 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1274 Override the grace period with this config variable. The value
1275 "now" may be used to disable this grace period and always prune
1276 unreachable objects immediately.
1278 gc.reflogExpire::
1279 gc.<pattern>.reflogExpire::
1280 'git reflog expire' removes reflog entries older than
1281 this time; defaults to 90 days. With "<pattern>" (e.g.
1282 "refs/stash") in the middle the setting applies only to
1283 the refs that match the <pattern>.
1285 gc.reflogExpireUnreachable::
1286 gc.<ref>.reflogExpireUnreachable::
1287 'git reflog expire' removes reflog entries older than
1288 this time and are not reachable from the current tip;
1289 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
1290 in the middle, the setting applies only to the refs that
1291 match the <pattern>.
1293 gc.rerereResolved::
1294 Records of conflicted merge you resolved earlier are
1295 kept for this many days when 'git rerere gc' is run.
1296 The default is 60 days. See linkgit:git-rerere[1].
1298 gc.rerereUnresolved::
1299 Records of conflicted merge you have not resolved are
1300 kept for this many days when 'git rerere gc' is run.
1301 The default is 15 days. See linkgit:git-rerere[1].
1303 gitcvs.commitMsgAnnotation::
1304 Append this string to each commit message. Set to empty string
1305 to disable this feature. Defaults to "via git-CVS emulator".
1307 gitcvs.enabled::
1308 Whether the CVS server interface is enabled for this repository.
1309 See linkgit:git-cvsserver[1].
1311 gitcvs.logFile::
1312 Path to a log file where the CVS server interface well... logs
1313 various stuff. See linkgit:git-cvsserver[1].
1315 gitcvs.usecrlfattr::
1316 If true, the server will look up the end-of-line conversion
1317 attributes for files to determine the '-k' modes to use. If
1318 the attributes force Git to treat a file as text,
1319 the '-k' mode will be left blank so CVS clients will
1320 treat it as text. If they suppress text conversion, the file
1321 will be set with '-kb' mode, which suppresses any newline munging
1322 the client might otherwise do. If the attributes do not allow
1323 the file type to be determined, then 'gitcvs.allBinary' is
1324 used. See linkgit:gitattributes[5].
1326 gitcvs.allBinary::
1327 This is used if 'gitcvs.usecrlfattr' does not resolve
1328 the correct '-kb' mode to use. If true, all
1329 unresolved files are sent to the client in
1330 mode '-kb'. This causes the client to treat them
1331 as binary files, which suppresses any newline munging it
1332 otherwise might do. Alternatively, if it is set to "guess",
1333 then the contents of the file are examined to decide if
1334 it is binary, similar to 'core.autocrlf'.
1336 gitcvs.dbName::
1337 Database used by git-cvsserver to cache revision information
1338 derived from the Git repository. The exact meaning depends on the
1339 used database driver, for SQLite (which is the default driver) this
1340 is a filename. Supports variable substitution (see
1341 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1342 Default: '%Ggitcvs.%m.sqlite'
1344 gitcvs.dbDriver::
1345 Used Perl DBI driver. You can specify any available driver
1346 for this here, but it might not work. git-cvsserver is tested
1347 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1348 reported *not* to work with 'DBD::mysql'. Experimental feature.
1349 May not contain double colons (`:`). Default: 'SQLite'.
1350 See linkgit:git-cvsserver[1].
1352 gitcvs.dbUser, gitcvs.dbPass::
1353 Database user and password. Only useful if setting 'gitcvs.dbDriver',
1354 since SQLite has no concept of database users and/or passwords.
1355 'gitcvs.dbUser' supports variable substitution (see
1356 linkgit:git-cvsserver[1] for details).
1358 gitcvs.dbTableNamePrefix::
1359 Database table name prefix. Prepended to the names of any
1360 database tables used, allowing a single database to be used
1361 for several repositories. Supports variable substitution (see
1362 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1363 characters will be replaced with underscores.
1365 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1366 'gitcvs.allBinary' can also be specified as
1367 'gitcvs.<access_method>.<varname>' (where 'access_method'
1368 is one of "ext" and "pserver") to make them apply only for the given
1369 access method.
1371 gitweb.category::
1372 gitweb.description::
1373 gitweb.owner::
1374 gitweb.url::
1375 See linkgit:gitweb[1] for description.
1377 gitweb.avatar::
1378 gitweb.blame::
1379 gitweb.grep::
1380 gitweb.highlight::
1381 gitweb.patches::
1382 gitweb.pickaxe::
1383 gitweb.remote_heads::
1384 gitweb.showSizes::
1385 gitweb.snapshot::
1386 See linkgit:gitweb.conf[5] for description.
1388 grep.lineNumber::
1389 If set to true, enable '-n' option by default.
1391 grep.patternType::
1392 Set the default matching behavior. Using a value of 'basic', 'extended',
1393 'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
1394 '--fixed-strings', or '--perl-regexp' option accordingly, while the
1395 value 'default' will return to the default matching behavior.
1397 grep.extendedRegexp::
1398 If set to true, enable '--extended-regexp' option by default. This
1399 option is ignored when the 'grep.patternType' option is set to a value
1400 other than 'default'.
1402 gpg.program::
1403 Use this custom program instead of "gpg" found on $PATH when
1404 making or verifying a PGP signature. The program must support the
1405 same command-line interface as GPG, namely, to verify a detached
1406 signature, "gpg --verify $file - <$signature" is run, and the
1407 program is expected to signal a good signature by exiting with
1408 code 0, and to generate an ASCII-armored detached signature, the
1409 standard input of "gpg -bsau $key" is fed with the contents to be
1410 signed, and the program is expected to send the result to its
1411 standard output.
1413 gui.commitMsgWidth::
1414 Defines how wide the commit message window is in the
1415 linkgit:git-gui[1]. "75" is the default.
1417 gui.diffContext::
1418 Specifies how many context lines should be used in calls to diff
1419 made by the linkgit:git-gui[1]. The default is "5".
1421 gui.displayUntracked::
1422 Determines if linkgit::git-gui[1] shows untracked files
1423 in the file list. The default is "true".
1425 gui.encoding::
1426 Specifies the default encoding to use for displaying of
1427 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1428 It can be overridden by setting the 'encoding' attribute
1429 for relevant files (see linkgit:gitattributes[5]).
1430 If this option is not set, the tools default to the
1431 locale encoding.
1433 gui.matchTrackingBranch::
1434 Determines if new branches created with linkgit:git-gui[1] should
1435 default to tracking remote branches with matching names or
1436 not. Default: "false".
1438 gui.newBranchTemplate::
1439 Is used as suggested name when creating new branches using the
1440 linkgit:git-gui[1].
1442 gui.pruneDuringFetch::
1443 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1444 performing a fetch. The default value is "false".
1446 gui.trustmtime::
1447 Determines if linkgit:git-gui[1] should trust the file modification
1448 timestamp or not. By default the timestamps are not trusted.
1450 gui.spellingDictionary::
1451 Specifies the dictionary used for spell checking commit messages in
1452 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1453 off.
1455 gui.fastCopyBlame::
1456 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1457 location detection. It makes blame significantly faster on huge
1458 repositories at the expense of less thorough copy detection.
1460 gui.copyBlameThreshold::
1461 Specifies the threshold to use in 'git gui blame' original location
1462 detection, measured in alphanumeric characters. See the
1463 linkgit:git-blame[1] manual for more information on copy detection.
1465 gui.blamehistoryctx::
1466 Specifies the radius of history context in days to show in
1467 linkgit:gitk[1] for the selected commit, when the `Show History
1468 Context` menu item is invoked from 'git gui blame'. If this
1469 variable is set to zero, the whole history is shown.
1471 guitool.<name>.cmd::
1472 Specifies the shell command line to execute when the corresponding item
1473 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1474 mandatory for every tool. The command is executed from the root of
1475 the working directory, and in the environment it receives the name of
1476 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1477 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1478 the head is detached, 'CUR_BRANCH' is empty).
1480 guitool.<name>.needsFile::
1481 Run the tool only if a diff is selected in the GUI. It guarantees
1482 that 'FILENAME' is not empty.
1484 guitool.<name>.noConsole::
1485 Run the command silently, without creating a window to display its
1486 output.
1488 guitool.<name>.noRescan::
1489 Don't rescan the working directory for changes after the tool
1490 finishes execution.
1492 guitool.<name>.confirm::
1493 Show a confirmation dialog before actually running the tool.
1495 guitool.<name>.argPrompt::
1496 Request a string argument from the user, and pass it to the tool
1497 through the 'ARGS' environment variable. Since requesting an
1498 argument implies confirmation, the 'confirm' option has no effect
1499 if this is enabled. If the option is set to 'true', 'yes', or '1',
1500 the dialog uses a built-in generic prompt; otherwise the exact
1501 value of the variable is used.
1503 guitool.<name>.revPrompt::
1504 Request a single valid revision from the user, and set the
1505 'REVISION' environment variable. In other aspects this option
1506 is similar to 'argPrompt', and can be used together with it.
1508 guitool.<name>.revUnmerged::
1509 Show only unmerged branches in the 'revPrompt' subdialog.
1510 This is useful for tools similar to merge or rebase, but not
1511 for things like checkout or reset.
1513 guitool.<name>.title::
1514 Specifies the title to use for the prompt dialog. The default
1515 is the tool name.
1517 guitool.<name>.prompt::
1518 Specifies the general prompt string to display at the top of
1519 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1520 The default value includes the actual command.
1522 help.browser::
1523 Specify the browser that will be used to display help in the
1524 'web' format. See linkgit:git-help[1].
1526 help.format::
1527 Override the default help format used by linkgit:git-help[1].
1528 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1529 the default. 'web' and 'html' are the same.
1531 help.autoCorrect::
1532 Automatically correct and execute mistyped commands after
1533 waiting for the given number of deciseconds (0.1 sec). If more
1534 than one command can be deduced from the entered text, nothing
1535 will be executed. If the value of this option is negative,
1536 the corrected command will be executed immediately. If the
1537 value is 0 - the command will be just shown but not executed.
1538 This is the default.
1540 help.htmlPath::
1541 Specify the path where the HTML documentation resides. File system paths
1542 and URLs are supported. HTML pages will be prefixed with this path when
1543 help is displayed in the 'web' format. This defaults to the documentation
1544 path of your Git installation.
1546 http.proxy::
1547 Override the HTTP proxy, normally configured using the 'http_proxy',
1548 'https_proxy', and 'all_proxy' environment variables (see
1549 `curl(1)`). This can be overridden on a per-remote basis; see
1550 remote.<name>.proxy
1552 http.cookieFile::
1553 File containing previously stored cookie lines which should be used
1554 in the Git http session, if they match the server. The file format
1555 of the file to read cookies from should be plain HTTP headers or
1556 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1557 NOTE that the file specified with http.cookieFile is only used as
1558 input unless http.saveCookies is set.
1560 http.saveCookies::
1561 If set, store cookies received during requests to the file specified by
1562 http.cookieFile. Has no effect if http.cookieFile is unset.
1564 http.sslVerify::
1565 Whether to verify the SSL certificate when fetching or pushing
1566 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1567 variable.
1569 http.sslCert::
1570 File containing the SSL certificate when fetching or pushing
1571 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1572 variable.
1574 http.sslKey::
1575 File containing the SSL private key when fetching or pushing
1576 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1577 variable.
1579 http.sslCertPasswordProtected::
1580 Enable Git's password prompt for the SSL certificate. Otherwise
1581 OpenSSL will prompt the user, possibly many times, if the
1582 certificate or private key is encrypted. Can be overridden by the
1583 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1585 http.sslCAInfo::
1586 File containing the certificates to verify the peer with when
1587 fetching or pushing over HTTPS. Can be overridden by the
1588 'GIT_SSL_CAINFO' environment variable.
1590 http.sslCAPath::
1591 Path containing files with the CA certificates to verify the peer
1592 with when fetching or pushing over HTTPS. Can be overridden
1593 by the 'GIT_SSL_CAPATH' environment variable.
1595 http.sslTry::
1596 Attempt to use AUTH SSL/TLS and encrypted data transfers
1597 when connecting via regular FTP protocol. This might be needed
1598 if the FTP server requires it for security reasons or you wish
1599 to connect securely whenever remote FTP server supports it.
1600 Default is false since it might trigger certificate verification
1601 errors on misconfigured servers.
1603 http.maxRequests::
1604 How many HTTP requests to launch in parallel. Can be overridden
1605 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1607 http.minSessions::
1608 The number of curl sessions (counted across slots) to be kept across
1609 requests. They will not be ended with curl_easy_cleanup() until
1610 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1611 value will be capped at 1. Defaults to 1.
1613 http.postBuffer::
1614 Maximum size in bytes of the buffer used by smart HTTP
1615 transports when POSTing data to the remote system.
1616 For requests larger than this buffer size, HTTP/1.1 and
1617 Transfer-Encoding: chunked is used to avoid creating a
1618 massive pack file locally. Default is 1 MiB, which is
1619 sufficient for most requests.
1621 http.lowSpeedLimit, http.lowSpeedTime::
1622 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1623 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1624 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1625 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1627 http.noEPSV::
1628 A boolean which disables using of EPSV ftp command by curl.
1629 This can helpful with some "poor" ftp servers which don't
1630 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1631 environment variable. Default is false (curl will use EPSV).
1633 http.userAgent::
1634 The HTTP USER_AGENT string presented to an HTTP server. The default
1635 value represents the version of the client Git such as git/1.7.1.
1636 This option allows you to override this value to a more common value
1637 such as Mozilla/4.0. This may be necessary, for instance, if
1638 connecting through a firewall that restricts HTTP connections to a set
1639 of common USER_AGENT strings (but not including those like git/1.7.1).
1640 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1642 http.<url>.*::
1643 Any of the http.* options above can be applied selectively to some URLs.
1644 For a config key to match a URL, each element of the config key is
1645 compared to that of the URL, in the following order:
1646 +
1647 --
1648 . Scheme (e.g., `https` in ``). This field
1649 must match exactly between the config key and the URL.
1651 . Host/domain name (e.g., `` in ``).
1652 This field must match exactly between the config key and the URL.
1654 . Port number (e.g., `8080` in ``).
1655 This field must match exactly between the config key and the URL.
1656 Omitted port numbers are automatically converted to the correct
1657 default for the scheme before matching.
1659 . Path (e.g., `repo.git` in ``). The
1660 path field of the config key must match the path field of the URL
1661 either exactly or as a prefix of slash-delimited path elements. This means
1662 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1663 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1664 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1665 key with just path `foo/`).
1667 . User name (e.g., `user` in ``). If
1668 the config key has a user name it must match the user name in the
1669 URL exactly. If the config key does not have a user name, that
1670 config key will match a URL with any user name (including none),
1671 but at a lower precedence than a config key with a user name.
1672 --
1673 +
1674 The list above is ordered by decreasing precedence; a URL that matches
1675 a config key's path is preferred to one that matches its user name. For example,
1676 if the URL is `` a config key match of
1677 `` will be preferred over a config key match of
1678 ``.
1679 +
1680 All URLs are normalized before attempting any matching (the password part,
1681 if embedded in the URL, is always ignored for matching purposes) so that
1682 equivalent URLs that are simply spelled differently will match properly.
1683 Environment variable settings always override any matches. The URLs that are
1684 matched against are those given directly to Git commands. This means any URLs
1685 visited as a result of a redirection do not participate in matching.
1687 i18n.commitEncoding::
1688 Character encoding the commit messages are stored in; Git itself
1689 does not care per se, but this information is necessary e.g. when
1690 importing commits from emails or in the gitk graphical history
1691 browser (and possibly at other places in the future or in other
1692 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1694 i18n.logOutputEncoding::
1695 Character encoding the commit messages are converted to when
1696 running 'git log' and friends.
1698 imap::
1699 The configuration variables in the 'imap' section are described
1700 in linkgit:git-imap-send[1].
1702 index.version::
1703 Specify the version with which new index files should be
1704 initialized. This does not affect existing repositories.
1706 init.templateDir::
1707 Specify the directory from which templates will be copied.
1708 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1710 instaweb.browser::
1711 Specify the program that will be used to browse your working
1712 repository in gitweb. See linkgit:git-instaweb[1].
1714 instaweb.httpd::
1715 The HTTP daemon command-line to start gitweb on your working
1716 repository. See linkgit:git-instaweb[1].
1718 instaweb.local::
1719 If true the web server started by linkgit:git-instaweb[1] will
1720 be bound to the local IP (
1722 instaweb.modulePath::
1723 The default module path for linkgit:git-instaweb[1] to use
1724 instead of /usr/lib/apache2/modules. Only used if httpd
1725 is Apache.
1727 instaweb.port::
1728 The port number to bind the gitweb httpd to. See
1729 linkgit:git-instaweb[1].
1731 interactive.singleKey::
1732 In interactive commands, allow the user to provide one-letter
1733 input with a single key (i.e., without hitting enter).
1734 Currently this is used by the `--patch` mode of
1735 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1736 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1737 setting is silently ignored if portable keystroke input
1738 is not available; requires the Perl module Term::ReadKey.
1740 log.abbrevCommit::
1741 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1742 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1743 override this option with `--no-abbrev-commit`.
1746 Set the default date-time mode for the 'log' command.
1747 Setting a value for is similar to using 'git log''s
1748 `--date` option. Possible values are `relative`, `local`,
1749 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1750 for details.
1752 log.decorate::
1753 Print out the ref names of any commits that are shown by the log
1754 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1755 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1756 specified, the full ref name (including prefix) will be printed.
1757 This is the same as the log commands '--decorate' option.
1759 log.showRoot::
1760 If true, the initial commit will be shown as a big creation event.
1761 This is equivalent to a diff against an empty tree.
1762 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1763 normally hide the root commit will now show it. True by default.
1765 log.mailmap::
1766 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1767 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1769 mailinfo.scissors::
1770 If true, makes linkgit:git-mailinfo[1] (and therefore
1771 linkgit:git-am[1]) act by default as if the --scissors option
1772 was provided on the command-line. When active, this features
1773 removes everything from the message body before a scissors
1774 line (i.e. consisting mainly of ">8", "8<" and "-").
1776 mailmap.file::
1777 The location of an augmenting mailmap file. The default
1778 mailmap, located in the root of the repository, is loaded
1779 first, then the mailmap file pointed to by this variable.
1780 The location of the mailmap file may be in a repository
1781 subdirectory, or somewhere outside of the repository itself.
1782 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1784 mailmap.blob::
1785 Like `mailmap.file`, but consider the value as a reference to a
1786 blob in the repository. If both `mailmap.file` and
1787 `mailmap.blob` are given, both are parsed, with entries from
1788 `mailmap.file` taking precedence. In a bare repository, this
1789 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1790 defaults to empty.
1792 man.viewer::
1793 Specify the programs that may be used to display help in the
1794 'man' format. See linkgit:git-help[1].
1796 man.<tool>.cmd::
1797 Specify the command to invoke the specified man viewer. The
1798 specified command is evaluated in shell with the man page
1799 passed as argument. (See linkgit:git-help[1].)
1801 man.<tool>.path::
1802 Override the path for the given tool that may be used to
1803 display help in the 'man' format. See linkgit:git-help[1].
1805 include::merge-config.txt[]
1807 mergetool.<tool>.path::
1808 Override the path for the given tool. This is useful in case
1809 your tool is not in the PATH.
1811 mergetool.<tool>.cmd::
1812 Specify the command to invoke the specified merge tool. The
1813 specified command is evaluated in shell with the following
1814 variables available: 'BASE' is the name of a temporary file
1815 containing the common base of the files to be merged, if available;
1816 'LOCAL' is the name of a temporary file containing the contents of
1817 the file on the current branch; 'REMOTE' is the name of a temporary
1818 file containing the contents of the file from the branch being
1819 merged; 'MERGED' contains the name of the file to which the merge
1820 tool should write the results of a successful merge.
1822 mergetool.<tool>.trustExitCode::
1823 For a custom merge command, specify whether the exit code of
1824 the merge command can be used to determine whether the merge was
1825 successful. If this is not set to true then the merge target file
1826 timestamp is checked and the merge assumed to have been successful
1827 if the file has been updated, otherwise the user is prompted to
1828 indicate the success of the merge.
1830 mergetool.meld.hasOutput::
1831 Older versions of `meld` do not support the `--output` option.
1832 Git will attempt to detect whether `meld` supports `--output`
1833 by inspecting the output of `meld --help`. Configuring
1834 `mergetool.meld.hasOutput` will make Git skip these checks and
1835 use the configured value instead. Setting `mergetool.meld.hasOutput`
1836 to `true` tells Git to unconditionally use the `--output` option,
1837 and `false` avoids using `--output`.
1839 mergetool.keepBackup::
1840 After performing a merge, the original file with conflict markers
1841 can be saved as a file with a `.orig` extension. If this variable
1842 is set to `false` then this file is not preserved. Defaults to
1843 `true` (i.e. keep the backup files).
1845 mergetool.keepTemporaries::
1846 When invoking a custom merge tool, Git uses a set of temporary
1847 files to pass to the tool. If the tool returns an error and this
1848 variable is set to `true`, then these temporary files will be
1849 preserved, otherwise they will be removed after the tool has
1850 exited. Defaults to `false`.
1852 mergetool.writeToTemp::
1853 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1854 conflicting files in the worktree by default. Git will attempt
1855 to use a temporary directory for these files when set `true`.
1856 Defaults to `false`.
1858 mergetool.prompt::
1859 Prompt before each invocation of the merge resolution program.
1861 notes.displayRef::
1862 The (fully qualified) refname from which to show notes when
1863 showing commit messages. The value of this variable can be set
1864 to a glob, in which case notes from all matching refs will be
1865 shown. You may also specify this configuration variable
1866 several times. A warning will be issued for refs that do not
1867 exist, but a glob that does not match any refs is silently
1868 ignored.
1869 +
1870 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1871 environment variable, which must be a colon separated list of refs or
1872 globs.
1873 +
1874 The effective value of "core.notesRef" (possibly overridden by
1875 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1876 displayed.
1878 notes.rewrite.<command>::
1879 When rewriting commits with <command> (currently `amend` or
1880 `rebase`) and this variable is set to `true`, Git
1881 automatically copies your notes from the original to the
1882 rewritten commit. Defaults to `true`, but see
1883 "notes.rewriteRef" below.
1885 notes.rewriteMode::
1886 When copying notes during a rewrite (see the
1887 "notes.rewrite.<command>" option), determines what to do if
1888 the target commit already has a note. Must be one of
1889 `overwrite`, `concatenate`, or `ignore`. Defaults to
1890 `concatenate`.
1891 +
1892 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1893 environment variable.
1895 notes.rewriteRef::
1896 When copying notes during a rewrite, specifies the (fully
1897 qualified) ref whose notes should be copied. The ref may be a
1898 glob, in which case notes in all matching refs will be copied.
1899 You may also specify this configuration several times.
1900 +
1901 Does not have a default value; you must configure this variable to
1902 enable note rewriting. Set it to `refs/notes/commits` to enable
1903 rewriting for the default commit notes.
1904 +
1905 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1906 environment variable, which must be a colon separated list of refs or
1907 globs.
1909 pack.window::
1910 The size of the window used by linkgit:git-pack-objects[1] when no
1911 window size is given on the command line. Defaults to 10.
1913 pack.depth::
1914 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1915 maximum depth is given on the command line. Defaults to 50.
1917 pack.windowMemory::
1918 The maximum size of memory that is consumed by each thread
1919 in linkgit:git-pack-objects[1] for pack window memory when
1920 no limit is given on the command line. The value can be
1921 suffixed with "k", "m", or "g". When left unconfigured (or
1922 set explicitly to 0), there will be no limit.
1924 pack.compression::
1925 An integer -1..9, indicating the compression level for objects
1926 in a pack file. -1 is the zlib default. 0 means no
1927 compression, and 1..9 are various speed/size tradeoffs, 9 being
1928 slowest. If not set, defaults to core.compression. If that is
1929 not set, defaults to -1, the zlib default, which is "a default
1930 compromise between speed and compression (currently equivalent
1931 to level 6)."
1932 +
1933 Note that changing the compression level will not automatically recompress
1934 all existing objects. You can force recompression by passing the -F option
1935 to linkgit:git-repack[1].
1937 pack.deltaCacheSize::
1938 The maximum memory in bytes used for caching deltas in
1939 linkgit:git-pack-objects[1] before writing them out to a pack.
1940 This cache is used to speed up the writing object phase by not
1941 having to recompute the final delta result once the best match
1942 for all objects is found. Repacking large repositories on machines
1943 which are tight with memory might be badly impacted by this though,
1944 especially if this cache pushes the system into swapping.
1945 A value of 0 means no limit. The smallest size of 1 byte may be
1946 used to virtually disable this cache. Defaults to 256 MiB.
1948 pack.deltaCacheLimit::
1949 The maximum size of a delta, that is cached in
1950 linkgit:git-pack-objects[1]. This cache is used to speed up the
1951 writing object phase by not having to recompute the final delta
1952 result once the best match for all objects is found. Defaults to 1000.
1954 pack.threads::
1955 Specifies the number of threads to spawn when searching for best
1956 delta matches. This requires that linkgit:git-pack-objects[1]
1957 be compiled with pthreads otherwise this option is ignored with a
1958 warning. This is meant to reduce packing time on multiprocessor
1959 machines. The required amount of memory for the delta search window
1960 is however multiplied by the number of threads.
1961 Specifying 0 will cause Git to auto-detect the number of CPU's
1962 and set the number of threads accordingly.
1964 pack.indexVersion::
1965 Specify the default pack index version. Valid values are 1 for
1966 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1967 the new pack index with capabilities for packs larger than 4 GB
1968 as well as proper protection against the repacking of corrupted
1969 packs. Version 2 is the default. Note that version 2 is enforced
1970 and this config option ignored whenever the corresponding pack is
1971 larger than 2 GB.
1972 +
1973 If you have an old Git that does not understand the version 2 `*.idx` file,
1974 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1975 that will copy both `*.pack` file and corresponding `*.idx` file from the
1976 other side may give you a repository that cannot be accessed with your
1977 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1978 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1979 the `*.idx` file.
1981 pack.packSizeLimit::
1982 The maximum size of a pack. This setting only affects
1983 packing to a file when repacking, i.e. the git:// protocol
1984 is unaffected. It can be overridden by the `--max-pack-size`
1985 option of linkgit:git-repack[1]. The minimum size allowed is
1986 limited to 1 MiB. The default is unlimited.
1987 Common unit suffixes of 'k', 'm', or 'g' are
1988 supported.
1990 pack.useBitmaps::
1991 When true, git will use pack bitmaps (if available) when packing
1992 to stdout (e.g., during the server side of a fetch). Defaults to
1993 true. You should not generally need to turn this off unless
1994 you are debugging pack bitmaps.
1996 pack.writeBitmaps (deprecated)::
1997 This is a deprecated synonym for `repack.writeBitmaps`.
1999 pack.writeBitmapHashCache::
2000 When true, git will include a "hash cache" section in the bitmap
2001 index (if one is written). This cache can be used to feed git's
2002 delta heuristics, potentially leading to better deltas between
2003 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2004 between an older, bitmapped pack and objects that have been
2005 pushed since the last gc). The downside is that it consumes 4
2006 bytes per object of disk space, and that JGit's bitmap
2007 implementation does not understand it, causing it to complain if
2008 Git and JGit are used on the same repository. Defaults to false.
2010 pager.<cmd>::
2011 If the value is boolean, turns on or off pagination of the
2012 output of a particular Git subcommand when writing to a tty.
2013 Otherwise, turns on pagination for the subcommand using the
2014 pager specified by the value of `pager.<cmd>`. If `--paginate`
2015 or `--no-pager` is specified on the command line, it takes
2016 precedence over this option. To disable pagination for all
2017 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2019 pretty.<name>::
2020 Alias for a --pretty= format string, as specified in
2021 linkgit:git-log[1]. Any aliases defined here can be used just
2022 as the built-in pretty formats could. For example,
2023 running `git config pretty.changelog "format:* %H %s"`
2024 would cause the invocation `git log --pretty=changelog`
2025 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2026 Note that an alias with the same name as a built-in format
2027 will be silently ignored.
2029 pull.ff::
2030 By default, Git does not create an extra merge commit when merging
2031 a commit that is a descendant of the current commit. Instead, the
2032 tip of the current branch is fast-forwarded. When set to `false`,
2033 this variable tells Git to create an extra merge commit in such
2034 a case (equivalent to giving the `--no-ff` option from the command
2035 line). When set to `only`, only such fast-forward merges are
2036 allowed (equivalent to giving the `--ff-only` option from the
2037 command line). This setting overrides `merge.ff` when pulling.
2039 pull.rebase::
2040 When true, rebase branches on top of the fetched branch, instead
2041 of merging the default branch from the default remote when "git
2042 pull" is run. See "branch.<name>.rebase" for setting this on a
2043 per-branch basis.
2044 +
2045 When preserve, also pass `--preserve-merges` along to 'git rebase'
2046 so that locally committed merge commits will not be flattened
2047 by running 'git pull'.
2048 +
2049 *NOTE*: this is a possibly dangerous operation; do *not* use
2050 it unless you understand the implications (see linkgit:git-rebase[1]
2051 for details).
2053 pull.octopus::
2054 The default merge strategy to use when pulling multiple branches
2055 at once.
2057 pull.twohead::
2058 The default merge strategy to use when pulling a single branch.
2060 push.default::
2061 Defines the action `git push` should take if no refspec is
2062 explicitly given. Different values are well-suited for
2063 specific workflows; for instance, in a purely central workflow
2064 (i.e. the fetch source is equal to the push destination),
2065 `upstream` is probably what you want. Possible values are:
2066 +
2067 --
2069 * `nothing` - do not push anything (error out) unless a refspec is
2070 explicitly given. This is primarily meant for people who want to
2071 avoid mistakes by always being explicit.
2073 * `current` - push the current branch to update a branch with the same
2074 name on the receiving end. Works in both central and non-central
2075 workflows.
2077 * `upstream` - push the current branch back to the branch whose
2078 changes are usually integrated into the current branch (which is
2079 called `@{upstream}`). This mode only makes sense if you are
2080 pushing to the same repository you would normally pull from
2081 (i.e. central workflow).
2083 * `simple` - in centralized workflow, work like `upstream` with an
2084 added safety to refuse to push if the upstream branch's name is
2085 different from the local one.
2086 +
2087 When pushing to a remote that is different from the remote you normally
2088 pull from, work as `current`. This is the safest option and is suited
2089 for beginners.
2090 +
2091 This mode has become the default in Git 2.0.
2093 * `matching` - push all branches having the same name on both ends.
2094 This makes the repository you are pushing to remember the set of
2095 branches that will be pushed out (e.g. if you always push 'maint'
2096 and 'master' there and no other branches, the repository you push
2097 to will have these two branches, and your local 'maint' and
2098 'master' will be pushed there).
2099 +
2100 To use this mode effectively, you have to make sure _all_ the
2101 branches you would push out are ready to be pushed out before
2102 running 'git push', as the whole point of this mode is to allow you
2103 to push all of the branches in one go. If you usually finish work
2104 on only one branch and push out the result, while other branches are
2105 unfinished, this mode is not for you. Also this mode is not
2106 suitable for pushing into a shared central repository, as other
2107 people may add new branches there, or update the tip of existing
2108 branches outside your control.
2109 +
2110 This used to be the default, but not since Git 2.0 (`simple` is the
2111 new default).
2113 --
2115 push.followTags::
2116 If set to true enable '--follow-tags' option by default. You
2117 may override this configuration at time of push by specifying
2118 '--no-follow-tags'.
2121 rebase.stat::
2122 Whether to show a diffstat of what changed upstream since the last
2123 rebase. False by default.
2125 rebase.autoSquash::
2126 If set to true enable '--autosquash' option by default.
2128 rebase.autoStash::
2129 When set to true, automatically create a temporary stash
2130 before the operation begins, and apply it after the operation
2131 ends. This means that you can run rebase on a dirty worktree.
2132 However, use with care: the final stash application after a
2133 successful rebase might result in non-trivial conflicts.
2134 Defaults to false.
2136 receive.advertiseAtomic::
2137 By default, git-receive-pack will advertise the atomic push
2138 capability to its clients. If you don't want to this capability
2139 to be advertised, set this variable to false.
2141 receive.autogc::
2142 By default, git-receive-pack will run "git-gc --auto" after
2143 receiving data from git-push and updating refs. You can stop
2144 it by setting this variable to false.
2146 receive.certNonceSeed::
2147 By setting this variable to a string, `git receive-pack`
2148 will accept a `git push --signed` and verifies it by using
2149 a "nonce" protected by HMAC using this string as a secret
2150 key.
2152 receive.certNonceSlop::
2153 When a `git push --signed` sent a push certificate with a
2154 "nonce" that was issued by a receive-pack serving the same
2155 repository within this many seconds, export the "nonce"
2156 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2157 hooks (instead of what the receive-pack asked the sending
2158 side to include). This may allow writing checks in
2159 `pre-receive` and `post-receive` a bit easier. Instead of
2160 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2161 that records by how many seconds the nonce is stale to
2162 decide if they want to accept the certificate, they only
2163 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2165 receive.fsckObjects::
2166 If it is set to true, git-receive-pack will check all received
2167 objects. It will abort in the case of a malformed object or a
2168 broken link. The result of an abort are only dangling objects.
2169 Defaults to false. If not set, the value of `transfer.fsckObjects`
2170 is used instead.
2172 receive.unpackLimit::
2173 If the number of objects received in a push is below this
2174 limit then the objects will be unpacked into loose object
2175 files. However if the number of received objects equals or
2176 exceeds this limit then the received pack will be stored as
2177 a pack, after adding any missing delta bases. Storing the
2178 pack from a push can make the push operation complete faster,
2179 especially on slow filesystems. If not set, the value of
2180 `transfer.unpackLimit` is used instead.
2182 receive.denyDeletes::
2183 If set to true, git-receive-pack will deny a ref update that deletes
2184 the ref. Use this to prevent such a ref deletion via a push.
2186 receive.denyDeleteCurrent::
2187 If set to true, git-receive-pack will deny a ref update that
2188 deletes the currently checked out branch of a non-bare repository.
2190 receive.denyCurrentBranch::
2191 If set to true or "refuse", git-receive-pack will deny a ref update
2192 to the currently checked out branch of a non-bare repository.
2193 Such a push is potentially dangerous because it brings the HEAD
2194 out of sync with the index and working tree. If set to "warn",
2195 print a warning of such a push to stderr, but allow the push to
2196 proceed. If set to false or "ignore", allow such pushes with no
2197 message. Defaults to "refuse".
2198 +
2199 Another option is "updateInstead" which will update the working
2200 tree if pushing into the current branch. This option is
2201 intended for synchronizing working directories when one side is not easily
2202 accessible via interactive ssh (e.g. a live web site, hence the requirement
2203 that the working directory be clean). This mode also comes in handy when
2204 developing inside a VM to test and fix code on different Operating Systems.
2205 +
2206 By default, "updateInstead" will refuse the push if the working tree or
2207 the index have any difference from the HEAD, but the `push-to-checkout`
2208 hook can be used to customize this. See linkgit:githooks[5].
2210 receive.denyNonFastForwards::
2211 If set to true, git-receive-pack will deny a ref update which is
2212 not a fast-forward. Use this to prevent such an update via a push,
2213 even if that push is forced. This configuration variable is
2214 set when initializing a shared repository.
2216 receive.hideRefs::
2217 String(s) `receive-pack` uses to decide which refs to omit
2218 from its initial advertisement. Use more than one
2219 definitions to specify multiple prefix strings. A ref that
2220 are under the hierarchies listed on the value of this
2221 variable is excluded, and is hidden when responding to `git
2222 push`, and an attempt to update or delete a hidden ref by
2223 `git push` is rejected.
2225 receive.updateServerInfo::
2226 If set to true, git-receive-pack will run git-update-server-info
2227 after receiving data from git-push and updating refs.
2229 receive.shallowUpdate::
2230 If set to true, .git/shallow can be updated when new refs
2231 require new shallow roots. Otherwise those refs are rejected.
2233 remote.pushDefault::
2234 The remote to push to by default. Overrides
2235 `branch.<name>.remote` for all branches, and is overridden by
2236 `branch.<name>.pushRemote` for specific branches.
2238 remote.<name>.url::
2239 The URL of a remote repository. See linkgit:git-fetch[1] or
2240 linkgit:git-push[1].
2242 remote.<name>.pushurl::
2243 The push URL of a remote repository. See linkgit:git-push[1].
2245 remote.<name>.proxy::
2246 For remotes that require curl (http, https and ftp), the URL to
2247 the proxy to use for that remote. Set to the empty string to
2248 disable proxying for that remote.
2250 remote.<name>.fetch::
2251 The default set of "refspec" for linkgit:git-fetch[1]. See
2252 linkgit:git-fetch[1].
2254 remote.<name>.push::
2255 The default set of "refspec" for linkgit:git-push[1]. See
2256 linkgit:git-push[1].
2258 remote.<name>.mirror::
2259 If true, pushing to this remote will automatically behave
2260 as if the `--mirror` option was given on the command line.
2262 remote.<name>.skipDefaultUpdate::
2263 If true, this remote will be skipped by default when updating
2264 using linkgit:git-fetch[1] or the `update` subcommand of
2265 linkgit:git-remote[1].
2267 remote.<name>.skipFetchAll::
2268 If true, this remote will be skipped by default when updating
2269 using linkgit:git-fetch[1] or the `update` subcommand of
2270 linkgit:git-remote[1].
2272 remote.<name>.receivepack::
2273 The default program to execute on the remote side when pushing. See
2274 option --receive-pack of linkgit:git-push[1].
2276 remote.<name>.uploadpack::
2277 The default program to execute on the remote side when fetching. See
2278 option --upload-pack of linkgit:git-fetch-pack[1].
2280 remote.<name>.tagOpt::
2281 Setting this value to --no-tags disables automatic tag following when
2282 fetching from remote <name>. Setting it to --tags will fetch every
2283 tag from remote <name>, even if they are not reachable from remote
2284 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2285 override this setting. See options --tags and --no-tags of
2286 linkgit:git-fetch[1].
2288 remote.<name>.vcs::
2289 Setting this to a value <vcs> will cause Git to interact with
2290 the remote with the git-remote-<vcs> helper.
2292 remote.<name>.prune::
2293 When set to true, fetching from this remote by default will also
2294 remove any remote-tracking references that no longer exist on the
2295 remote (as if the `--prune` option was given on the command line).
2296 Overrides `fetch.prune` settings, if any.
2298 remotes.<group>::
2299 The list of remotes which are fetched by "git remote update
2300 <group>". See linkgit:git-remote[1].
2302 repack.useDeltaBaseOffset::
2303 By default, linkgit:git-repack[1] creates packs that use
2304 delta-base offset. If you need to share your repository with
2305 Git older than version 1.4.4, either directly or via a dumb
2306 protocol such as http, then you need to set this option to
2307 "false" and repack. Access from old Git versions over the
2308 native protocol are unaffected by this option.
2310 repack.packKeptObjects::
2311 If set to true, makes `git repack` act as if
2312 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2313 details. Defaults to `false` normally, but `true` if a bitmap
2314 index is being written (either via `--write-bitmap-index` or
2315 `repack.writeBitmaps`).
2317 repack.writeBitmaps::
2318 When true, git will write a bitmap index when packing all
2319 objects to disk (e.g., when `git repack -a` is run). This
2320 index can speed up the "counting objects" phase of subsequent
2321 packs created for clones and fetches, at the cost of some disk
2322 space and extra time spent on the initial repack. Defaults to
2323 false.
2325 rerere.autoUpdate::
2326 When set to true, `git-rerere` updates the index with the
2327 resulting contents after it cleanly resolves conflicts using
2328 previously recorded resolution. Defaults to false.
2330 rerere.enabled::
2331 Activate recording of resolved conflicts, so that identical
2332 conflict hunks can be resolved automatically, should they be
2333 encountered again. By default, linkgit:git-rerere[1] is
2334 enabled if there is an `rr-cache` directory under the
2335 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2336 repository.
2338 sendemail.identity::
2339 A configuration identity. When given, causes values in the
2340 'sendemail.<identity>' subsection to take precedence over
2341 values in the 'sendemail' section. The default identity is
2342 the value of 'sendemail.identity'.
2344 sendemail.smtpEncryption::
2345 See linkgit:git-send-email[1] for description. Note that this
2346 setting is not subject to the 'identity' mechanism.
2348 sendemail.smtpssl (deprecated)::
2349 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2351 sendemail.smtpsslcertpath::
2352 Path to ca-certificates (either a directory or a single file).
2353 Set it to an empty string to disable certificate verification.
2355 sendemail.<identity>.*::
2356 Identity-specific versions of the 'sendemail.*' parameters
2357 found below, taking precedence over those when the this
2358 identity is selected, through command-line or
2359 'sendemail.identity'.
2361 sendemail.aliasesFile::
2362 sendemail.aliasFileType::
2363 sendemail.annotate::
2364 sendemail.bcc::
2366 sendemail.ccCmd::
2367 sendemail.chainReplyTo::
2368 sendemail.confirm::
2369 sendemail.envelopeSender::
2370 sendemail.from::
2371 sendemail.multiEdit::
2372 sendemail.signedoffbycc::
2373 sendemail.smtpPass::
2374 sendemail.suppresscc::
2375 sendemail.suppressFrom::
2377 sendemail.smtpDomain::
2378 sendemail.smtpServer::
2379 sendemail.smtpServerPort::
2380 sendemail.smtpServerOption::
2381 sendemail.smtpUser::
2382 sendemail.thread::
2383 sendemail.transferEncoding::
2384 sendemail.validate::
2385 sendemail.xmailer::
2386 See linkgit:git-send-email[1] for description.
2388 sendemail.signedoffcc (deprecated)::
2389 Deprecated alias for 'sendemail.signedoffbycc'.
2391 showbranch.default::
2392 The default set of branches for linkgit:git-show-branch[1].
2393 See linkgit:git-show-branch[1].
2395 status.relativePaths::
2396 By default, linkgit:git-status[1] shows paths relative to the
2397 current directory. Setting this variable to `false` shows paths
2398 relative to the repository root (this was the default for Git
2399 prior to v1.5.4).
2401 status.short::
2402 Set to true to enable --short by default in linkgit:git-status[1].
2403 The option --no-short takes precedence over this variable.
2405 status.branch::
2406 Set to true to enable --branch by default in linkgit:git-status[1].
2407 The option --no-branch takes precedence over this variable.
2409 status.displayCommentPrefix::
2410 If set to true, linkgit:git-status[1] will insert a comment
2411 prefix before each output line (starting with
2412 `core.commentChar`, i.e. `#` by default). This was the
2413 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2414 Defaults to false.
2416 status.showUntrackedFiles::
2417 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2418 files which are not currently tracked by Git. Directories which
2419 contain only untracked files, are shown with the directory name
2420 only. Showing untracked files means that Git needs to lstat() all
2421 the files in the whole repository, which might be slow on some
2422 systems. So, this variable controls how the commands displays
2423 the untracked files. Possible values are:
2424 +
2425 --
2426 * `no` - Show no untracked files.
2427 * `normal` - Show untracked files and directories.
2428 * `all` - Show also individual files in untracked directories.
2429 --
2430 +
2431 If this variable is not specified, it defaults to 'normal'.
2432 This variable can be overridden with the -u|--untracked-files option
2433 of linkgit:git-status[1] and linkgit:git-commit[1].
2435 status.submoduleSummary::
2436 Defaults to false.
2437 If this is set to a non zero number or true (identical to -1 or an
2438 unlimited number), the submodule summary will be enabled and a
2439 summary of commits for modified submodules will be shown (see
2440 --summary-limit option of linkgit:git-submodule[1]). Please note
2441 that the summary output command will be suppressed for all
2442 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2443 for those submodules where `submodule.<name>.ignore=all`. The only
2444 exception to that rule is that status and commit will show staged
2445 submodule changes. To
2446 also view the summary for ignored submodules you can either use
2447 the --ignore-submodules=dirty command-line option or the 'git
2448 submodule summary' command, which shows a similar output but does
2449 not honor these settings.
2451 submodule.<name>.path::
2452 submodule.<name>.url::
2453 The path within this project and URL for a submodule. These
2454 variables are initially populated by 'git submodule init'. See
2455 linkgit:git-submodule[1] and linkgit:gitmodules[5] for
2456 details.
2458 submodule.<name>.update::
2459 The default update procedure for a submodule. This variable
2460 is populated by `git submodule init` from the
2461 linkgit:gitmodules[5] file. See description of 'update'
2462 command in linkgit:git-submodule[1].
2464 submodule.<name>.branch::
2465 The remote branch name for a submodule, used by `git submodule
2466 update --remote`. Set this option to override the value found in
2467 the `.gitmodules` file. See linkgit:git-submodule[1] and
2468 linkgit:gitmodules[5] for details.
2470 submodule.<name>.fetchRecurseSubmodules::
2471 This option can be used to control recursive fetching of this
2472 submodule. It can be overridden by using the --[no-]recurse-submodules
2473 command-line option to "git fetch" and "git pull".
2474 This setting will override that from in the linkgit:gitmodules[5]
2475 file.
2477 submodule.<name>.ignore::
2478 Defines under what circumstances "git status" and the diff family show
2479 a submodule as modified. When set to "all", it will never be considered
2480 modified (but it will nonetheless show up in the output of status and
2481 commit when it has been staged), "dirty" will ignore all changes
2482 to the submodules work tree and
2483 takes only differences between the HEAD of the submodule and the commit
2484 recorded in the superproject into account. "untracked" will additionally
2485 let submodules with modified tracked files in their work tree show up.
2486 Using "none" (the default when this option is not set) also shows
2487 submodules that have untracked files in their work tree as changed.
2488 This setting overrides any setting made in .gitmodules for this submodule,
2489 both settings can be overridden on the command line by using the
2490 "--ignore-submodules" option. The 'git submodule' commands are not
2491 affected by this setting.
2493 tag.sort::
2494 This variable controls the sort ordering of tags when displayed by
2495 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2496 value of this variable will be used as the default.
2498 tar.umask::
2499 This variable can be used to restrict the permission bits of
2500 tar archive entries. The default is 0002, which turns off the
2501 world write bit. The special value "user" indicates that the
2502 archiving user's umask will be used instead. See umask(2) and
2503 linkgit:git-archive[1].
2505 transfer.fsckObjects::
2506 When `fetch.fsckObjects` or `receive.fsckObjects` are
2507 not set, the value of this variable is used instead.
2508 Defaults to false.
2510 transfer.hideRefs::
2511 This variable can be used to set both `receive.hideRefs`
2512 and `uploadpack.hideRefs` at the same time to the same
2513 values. See entries for these other variables.
2515 transfer.unpackLimit::
2516 When `fetch.unpackLimit` or `receive.unpackLimit` are
2517 not set, the value of this variable is used instead.
2518 The default value is 100.
2520 uploadarchive.allowUnreachable::
2521 If true, allow clients to use `git archive --remote` to request
2522 any tree, whether reachable from the ref tips or not. See the
2523 discussion in the `SECURITY` section of
2524 linkgit:git-upload-archive[1] for more details. Defaults to
2525 `false`.
2527 uploadpack.hideRefs::
2528 String(s) `upload-pack` uses to decide which refs to omit
2529 from its initial advertisement. Use more than one
2530 definitions to specify multiple prefix strings. A ref that
2531 are under the hierarchies listed on the value of this
2532 variable is excluded, and is hidden from `git ls-remote`,
2533 `git fetch`, etc. An attempt to fetch a hidden ref by `git
2534 fetch` will fail. See also `uploadpack.allowtipsha1inwant`.
2536 uploadpack.allowtipsha1inwant::
2537 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2538 to accept a fetch request that asks for an object at the tip
2539 of a hidden ref (by default, such a request is rejected).
2540 see also `uploadpack.hideRefs`.
2542 uploadpack.keepAlive::
2543 When `upload-pack` has started `pack-objects`, there may be a
2544 quiet period while `pack-objects` prepares the pack. Normally
2545 it would output progress information, but if `--quiet` was used
2546 for the fetch, `pack-objects` will output nothing at all until
2547 the pack data begins. Some clients and networks may consider
2548 the server to be hung and give up. Setting this option instructs
2549 `upload-pack` to send an empty keepalive packet every
2550 `uploadpack.keepAlive` seconds. Setting this option to 0
2551 disables keepalive packets entirely. The default is 5 seconds.
2553 url.<base>.insteadOf::
2554 Any URL that starts with this value will be rewritten to
2555 start, instead, with <base>. In cases where some site serves a
2556 large number of repositories, and serves them with multiple
2557 access methods, and some users need to use different access
2558 methods, this feature allows people to specify any of the
2559 equivalent URLs and have Git automatically rewrite the URL to
2560 the best alternative for the particular user, even for a
2561 never-before-seen repository on the site. When more than one
2562 insteadOf strings match a given URL, the longest match is used.
2564 url.<base>.pushInsteadOf::
2565 Any URL that starts with this value will not be pushed to;
2566 instead, it will be rewritten to start with <base>, and the
2567 resulting URL will be pushed to. In cases where some site serves
2568 a large number of repositories, and serves them with multiple
2569 access methods, some of which do not allow push, this feature
2570 allows people to specify a pull-only URL and have Git
2571 automatically use an appropriate URL to push, even for a
2572 never-before-seen repository on the site. When more than one
2573 pushInsteadOf strings match a given URL, the longest match is
2574 used. If a remote has an explicit pushurl, Git will ignore this
2575 setting for that remote.
2578 Your email address to be recorded in any newly created commits.
2579 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
2580 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
2583 Your full name to be recorded in any newly created commits.
2584 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
2585 environment variables. See linkgit:git-commit-tree[1].
2587 user.signingKey::
2588 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2589 key you want it to automatically when creating a signed tag or
2590 commit, you can override the default selection with this variable.
2591 This option is passed unchanged to gpg's --local-user parameter,
2592 so you may specify a key using any method that gpg supports.
2594 versionsort.prereleaseSuffix::
2595 When version sort is used in linkgit:git-tag[1], prerelease
2596 tags (e.g. "1.0-rc1") may appear after the main release
2597 "1.0". By specifying the suffix "-rc" in this variable,
2598 "1.0-rc1" will appear before "1.0".
2599 +
2600 This variable can be specified multiple times, once per suffix. The
2601 order of suffixes in the config file determines the sorting order
2602 (e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
2603 is sorted before 1.0-rcXX). The sorting order between different
2604 suffixes is undefined if they are in multiple config files.
2606 web.browser::
2607 Specify a web browser that may be used by some commands.
2608 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2609 may use it.