4 The git configuration file contains a number of variables that affect
5 the git command's 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 and only alphanumeric
16 characters are allowed. Some variables may appear multiple times.
21 The syntax is fairly flexible and permissive; whitespaces are mostly
22 ignored. The '#' and ';' characters begin comments to the end of line,
23 blank lines are ignored.
25 The file consists of sections and variables. A section begins with
26 the name of the section in square brackets and continues until the next
27 section begins. Section names are not case sensitive. Only alphanumeric
28 characters, `-` and `.` are allowed in section names. Each variable
29 must belong to some section, which means that there must be a section
30 header before the first setting of a variable.
32 Sections can be further divided into subsections. To begin a subsection
33 put its name in double quotes, separated by space from the section name,
34 in the section header, like in the example below:
37 [section "subsection"]
41 Subsection names are case sensitive and can contain any characters except
42 newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
43 respectively). Section headers cannot span multiple
44 lines. Variables may belong directly to a section or to a given subsection.
45 You can have `[section]` if you have `[section "subsection"]`, but you
48 There is also a case insensitive alternative `[section.subsection]` syntax.
49 In this syntax, subsection names follow the same restrictions as for section
52 All the other lines (and the remainder of the line after the section
53 header) are recognized as setting variables, in the form
54 'name = value'. If there is no equal sign on the line, the entire line
55 is taken as 'name' and the variable is recognized as boolean "true".
56 The variable names are case-insensitive and only alphanumeric
57 characters and `-` are allowed. There can be more than one value
58 for a given variable; we say then that variable is multivalued.
60 Leading and trailing whitespace in a variable value is discarded.
61 Internal whitespace within a variable value is retained verbatim.
63 The values following the equals sign in variable assign are all either
64 a string, an integer, or a boolean. Boolean values may be given as yes/no,
65 1/0, true/false or on/off. Case is not significant in boolean values, when
66 converting value to the canonical form using '--bool' type specifier;
67 'git config' will ensure that the output is "true" or "false".
69 String values may be entirely or partially enclosed in double quotes.
70 You need to enclose variable values in double quotes if you want to
71 preserve leading or trailing whitespace, or if the variable value contains
72 comment characters (i.e. it contains '#' or ';').
73 Double quote `"` and backslash `\` characters in variable values must
74 be escaped: use `\"` for `"` and `\\` for `\`.
76 The following escape sequences (beside `\"` and `\\`) are recognized:
77 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
78 and `\b` for backspace (BS). No other char escape sequence, nor octal
79 char sequences are valid.
81 Variable values ending in a `\` are continued on the next line in the
82 customary UNIX fashion.
84 Some variables may require a special value format.
91 ; Don't trust file modes
96 external = /usr/local/bin/diff-wrapper
101 merge = refs/heads/devel
105 gitProxy="ssh" for "kernel.org"
106 gitProxy=default-proxy ; for the rest
111 Note that this list is non-comprehensive and not necessarily complete.
112 For command-specific variables, you will find a more detailed description
113 in the appropriate manual page. You will find a description of non-core
114 porcelain configuration variables in the respective porcelain documentation.
117 When set to 'true', display the given optional help message.
118 When set to 'false', do not display. The configuration variables
123 Advice shown when linkgit:git-push[1] refuses
124 non-fast-forward refs. Default: true.
126 Directions on how to stage/unstage/add shown in the
127 output of linkgit:git-status[1] and the template shown
128 when writing commit messages. Default: true.
130 Advice shown when linkgit:git-merge[1] refuses to
131 merge to avoid overwriting local changes.
134 Advices shown by various commands when conflicts
135 prevent the operation from being performed.
138 Advice on how to set your identity configuration when
139 your information is guessed from the system username and
140 domain name. Default: true.
143 Advice shown when you used linkgit::git-checkout[1] to
144 move to the detach HEAD state, to instruct how to create
145 a local branch after the fact. Default: true.
149 If false, the executable bit differences between the index and
150 the working tree are ignored; useful on broken filesystems like FAT.
151 See linkgit:git-update-index[1].
153 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
154 will probe and set core.fileMode false if appropriate when the
155 repository is created.
158 (Windows-only) If true (which is the default), mark newly-created
159 directories and files whose name starts with a dot as hidden.
160 If 'dotGitOnly', only the .git/ directory is hidden, but no other
161 files starting with a dot.
163 core.ignoreCygwinFSTricks::
164 This option is only used by Cygwin implementation of Git. If false,
165 the Cygwin stat() and lstat() functions are used. This may be useful
166 if your repository consists of a few separate directories joined in
167 one hierarchy using Cygwin mount. If true, Git uses native Win32 API
168 whenever it is possible and falls back to Cygwin functions only to
169 handle symbol links. The native mode is more than twice faster than
170 normal Cygwin l/stat() functions. True by default, unless core.filemode
171 is true, in which case ignoreCygwinFSTricks is ignored as Cygwin's
172 POSIX emulation is required to support core.filemode.
175 If true, this option enables various workarounds to enable
176 git to work better on filesystems that are not case sensitive,
177 like FAT. For example, if a directory listing finds
178 "makefile" when git expects "Makefile", git will assume
179 it is really the same file, and continue to remember it as
182 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
183 will probe and set core.ignorecase true if appropriate when the repository
187 If false, the ctime differences between the index and the
188 working tree are ignored; useful when the inode change time
189 is regularly modified by something outside Git (file system
190 crawlers and some backup systems).
191 See linkgit:git-update-index[1]. True by default.
194 The commands that output paths (e.g. 'ls-files',
195 'diff'), when not given the `-z` option, will quote
196 "unusual" characters in the pathname by enclosing the
197 pathname in a double-quote pair and with backslashes the
198 same way strings in C source code are quoted. If this
199 variable is set to false, the bytes higher than 0x80 are
200 not quoted but output as verbatim. Note that double
201 quote, backslash and control characters are always
202 quoted without `-z` regardless of the setting of this
206 Sets the line ending type to use in the working directory for
207 files that have the `text` property set. Alternatives are
208 'lf', 'crlf' and 'native', which uses the platform's native
209 line ending. The default value is `native`. See
210 linkgit:gitattributes[5] for more information on end-of-line
214 If true, makes git check if converting `CRLF` is reversible when
215 end-of-line conversion is active. Git will verify if a command
216 modifies a file in the work tree either directly or indirectly.
217 For example, committing a file followed by checking out the
218 same file should yield the original file in the work tree. If
219 this is not the case for the current setting of
220 `core.autocrlf`, git will reject the file. The variable can
221 be set to "warn", in which case git will only warn about an
222 irreversible conversion but continue the operation.
224 CRLF conversion bears a slight chance of corrupting data.
225 When it is enabled, git will convert CRLF to LF during commit and LF to
226 CRLF during checkout. A file that contains a mixture of LF and
227 CRLF before the commit cannot be recreated by git. For text
228 files this is the right thing to do: it corrects line endings
229 such that we have only LF line endings in the repository.
230 But for binary files that are accidentally classified as text the
231 conversion can corrupt data.
233 If you recognize such corruption early you can easily fix it by
234 setting the conversion type explicitly in .gitattributes. Right
235 after committing you still have the original file in your work
236 tree and this file is not yet corrupted. You can explicitly tell
237 git that this file is binary and git will handle the file
240 Unfortunately, the desired effect of cleaning up text files with
241 mixed line endings and the undesired effect of corrupting binary
242 files cannot be distinguished. In both cases CRLFs are removed
243 in an irreversible way. For text files this is the right thing
244 to do because CRLFs are line endings, while for binary files
245 converting CRLFs corrupts data.
247 Note, this safety check does not mean that a checkout will generate a
248 file identical to the original file for a different setting of
249 `core.eol` and `core.autocrlf`, but only for the current one. For
250 example, a text file with `LF` would be accepted with `core.eol=lf`
251 and could later be checked out with `core.eol=crlf`, in which case the
252 resulting file would contain `CRLF`, although the original file
253 contained `LF`. However, in both work trees the line endings would be
254 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
255 file with mixed line endings would be reported by the `core.safecrlf`
259 Setting this variable to "true" is almost the same as setting
260 the `text` attribute to "auto" on all files except that text
261 files are not guaranteed to be normalized: files that contain
262 `CRLF` in the repository will not be touched. Use this
263 setting if you want to have `CRLF` line endings in your
264 working directory even though the repository does not have
265 normalized line endings. This variable can be set to 'input',
266 in which case no output conversion is performed.
269 If false, symbolic links are checked out as small plain files that
270 contain the link text. linkgit:git-update-index[1] and
271 linkgit:git-add[1] will not change the recorded type to regular
272 file. Useful on filesystems like FAT that do not support
275 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
276 will probe and set core.symlinks false if appropriate when the repository
280 A "proxy command" to execute (as 'command host port') instead
281 of establishing direct connection to the remote server when
282 using the git protocol for fetching. If the variable value is
283 in the "COMMAND for DOMAIN" format, the command is applied only
284 on hostnames ending with the specified domain string. This variable
285 may be set multiple times and is matched in the given order;
286 the first match wins.
288 Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
289 (which always applies universally, without the special "for"
292 The special string `none` can be used as the proxy command to
293 specify that no proxy be used for a given domain pattern.
294 This is useful for excluding servers inside a firewall from
295 proxy use, while defaulting to a common proxy for external domains.
298 If true, commands which modify both the working tree and the index
299 will mark the updated paths with the "assume unchanged" bit in the
300 index. These marked files are then assumed to stay unchanged in the
301 working tree, until you mark them otherwise manually - Git will not
302 detect the file changes by lstat() calls. This is useful on systems
303 where those are very slow, such as Microsoft Windows.
304 See linkgit:git-update-index[1].
307 core.preferSymlinkRefs::
308 Instead of the default "symref" format for HEAD
309 and other symbolic reference files, use symbolic links.
310 This is sometimes needed to work with old scripts that
311 expect HEAD to be a symbolic link.
314 If true this repository is assumed to be 'bare' and has no
315 working directory associated with it. If this is the case a
316 number of commands that require a working directory will be
317 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
319 This setting is automatically guessed by linkgit:git-clone[1] or
320 linkgit:git-init[1] when the repository was created. By default a
321 repository that ends in "/.git" is assumed to be not bare (bare =
322 false), while all other repositories are assumed to be bare (bare
326 Set the path to the root of the working tree.
327 This can be overridden by the GIT_WORK_TREE environment
328 variable and the '--work-tree' command line option.
329 The value can be an absolute path or relative to the path to
330 the .git directory, which is either specified by --git-dir
331 or GIT_DIR, or automatically discovered.
332 If --git-dir or GIT_DIR is specified but none of
333 --work-tree, GIT_WORK_TREE and core.worktree is specified,
334 the current working directory is regarded as the top level
335 of your working tree.
337 Note that this variable is honored even when set in a configuration
338 file in a ".git" subdirectory of a directory and its value differs
339 from the latter directory (e.g. "/path/to/.git/config" has
340 core.worktree set to "/different/path"), which is most likely a
341 misconfiguration. Running git commands in the "/path/to" directory will
342 still use "/different/path" as the root of the work tree and can cause
343 confusion unless you know what you are doing (e.g. you are creating a
344 read-only snapshot of the same index to a location different from the
345 repository's usual working tree).
347 core.logAllRefUpdates::
348 Enable the reflog. Updates to a ref <ref> is logged to the file
349 "$GIT_DIR/logs/<ref>", by appending the new and old
350 SHA1, the date/time and the reason of the update, but
351 only when the file exists. If this configuration
352 variable is set to true, missing "$GIT_DIR/logs/<ref>"
353 file is automatically created for branch heads (i.e. under
354 refs/heads/), remote refs (i.e. under refs/remotes/),
355 note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
357 This information can be used to determine what commit
358 was the tip of a branch "2 days ago".
360 This value is true by default in a repository that has
361 a working directory associated with it, and false by
362 default in a bare repository.
364 core.repositoryFormatVersion::
365 Internal variable identifying the repository format and layout
368 core.sharedRepository::
369 When 'group' (or 'true'), the repository is made shareable between
370 several users in a group (making sure all the files and objects are
371 group-writable). When 'all' (or 'world' or 'everybody'), the
372 repository will be readable by all users, additionally to being
373 group-shareable. When 'umask' (or 'false'), git will use permissions
374 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
375 files in the repository will have this mode value. '0xxx' will override
376 user's umask value (whereas the other options will only override
377 requested parts of the user's umask value). Examples: '0660' will make
378 the repo read/write-able for the owner and group, but inaccessible to
379 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
380 repository that is group-readable but not group-writable.
381 See linkgit:git-init[1]. False by default.
383 core.warnAmbiguousRefs::
384 If true, git will warn you if the ref name you passed it is ambiguous
385 and might match multiple refs in the .git/refs/ tree. True by default.
388 An integer -1..9, indicating a default compression level.
389 -1 is the zlib default. 0 means no compression,
390 and 1..9 are various speed/size tradeoffs, 9 being slowest.
391 If set, this provides a default to other compression variables,
392 such as 'core.loosecompression' and 'pack.compression'.
394 core.loosecompression::
395 An integer -1..9, indicating the compression level for objects that
396 are not in a pack file. -1 is the zlib default. 0 means no
397 compression, and 1..9 are various speed/size tradeoffs, 9 being
398 slowest. If not set, defaults to core.compression. If that is
399 not set, defaults to 1 (best speed).
401 core.packedGitWindowSize::
402 Number of bytes of a pack file to map into memory in a
403 single mapping operation. Larger window sizes may allow
404 your system to process a smaller number of large pack files
405 more quickly. Smaller window sizes will negatively affect
406 performance due to increased calls to the operating system's
407 memory manager, but may improve performance when accessing
408 a large number of large pack files.
410 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
411 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
412 be reasonable for all users/operating systems. You probably do
413 not need to adjust this value.
415 Common unit suffixes of 'k', 'm', or 'g' are supported.
417 core.packedGitLimit::
418 Maximum number of bytes to map simultaneously into memory
419 from pack files. If Git needs to access more than this many
420 bytes at once to complete an operation it will unmap existing
421 regions to reclaim virtual address space within the process.
423 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
424 This should be reasonable for all users/operating systems, except on
425 the largest projects. You probably do not need to adjust this value.
427 Common unit suffixes of 'k', 'm', or 'g' are supported.
429 core.deltaBaseCacheLimit::
430 Maximum number of bytes to reserve for caching base objects
431 that may be referenced by multiple deltified objects. By storing the
432 entire decompressed base objects in a cache Git is able
433 to avoid unpacking and decompressing frequently used base
434 objects multiple times.
436 Default is 16 MiB on all platforms. This should be reasonable
437 for all users/operating systems, except on the largest projects.
438 You probably do not need to adjust this value.
440 Common unit suffixes of 'k', 'm', or 'g' are supported.
442 core.bigFileThreshold::
443 Files larger than this size are stored deflated, without
444 attempting delta compression. Storing large files without
445 delta compression avoids excessive memory usage, at the
446 slight expense of increased disk usage.
448 Default is 512 MiB on all platforms. This should be reasonable
449 for most projects as source code and other text files can still
450 be delta compressed, but larger binary media files won't be.
452 Common unit suffixes of 'k', 'm', or 'g' are supported.
455 In addition to '.gitignore' (per-directory) and
456 '.git/info/exclude', git looks into this file for patterns
457 of files which are not meant to be tracked. "{tilde}/" is expanded
458 to the value of `$HOME` and "{tilde}user/" to the specified user's
459 home directory. See linkgit:gitignore[5].
462 Some commands (e.g. svn and http interfaces) that interactively
463 ask for a password can be told to use an external program given
464 via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
465 environment variable. If not set, fall back to the value of the
466 'SSH_ASKPASS' environment variable or, failing that, a simple password
467 prompt. The external program shall be given a suitable prompt as
468 command line argument and write the password on its STDOUT.
470 core.attributesfile::
471 In addition to '.gitattributes' (per-directory) and
472 '.git/info/attributes', git looks into this file for attributes
473 (see linkgit:gitattributes[5]). Path expansions are made the same
474 way as for `core.excludesfile`.
477 Commands such as `commit` and `tag` that lets you edit
478 messages by launching an editor uses the value of this
479 variable when it is set, and the environment variable
480 `GIT_EDITOR` is not set. See linkgit:git-var[1].
483 The command that git will use to paginate output. Can
484 be overridden with the `GIT_PAGER` environment
485 variable. Note that git sets the `LESS` environment
486 variable to `FRSX` if it is unset when it runs the
487 pager. One can change these settings by setting the
488 `LESS` variable to some other value. Alternately,
489 these settings can be overridden on a project or
490 global basis by setting the `core.pager` option.
491 Setting `core.pager` has no affect on the `LESS`
492 environment variable behaviour above, so if you want
493 to override git's default settings this way, you need
494 to be explicit. For example, to disable the S option
495 in a backward compatible manner, set `core.pager`
496 to `less -+$LESS -FRX`. This will be passed to the
497 shell by git, which will translate the final command to
498 `LESS=FRSX less -+FRSX -FRX`.
501 A comma separated list of common whitespace problems to
502 notice. 'git diff' will use `color.diff.whitespace` to
503 highlight them, and 'git apply --whitespace=error' will
504 consider them as errors. You can prefix `-` to disable
505 any of them (e.g. `-trailing-space`):
507 * `blank-at-eol` treats trailing whitespaces at the end of the line
508 as an error (enabled by default).
509 * `space-before-tab` treats a space character that appears immediately
510 before a tab character in the initial indent part of the line as an
511 error (enabled by default).
512 * `indent-with-non-tab` treats a line that is indented with 8 or more
513 space characters as an error (not enabled by default).
514 * `tab-in-indent` treats a tab character in the initial indent part of
515 the line as an error (not enabled by default).
516 * `blank-at-eof` treats blank lines added at the end of file as an error
517 (enabled by default).
518 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
520 * `cr-at-eol` treats a carriage-return at the end of line as
521 part of the line terminator, i.e. with it, `trailing-space`
522 does not trigger if the character before such a carriage-return
523 is not a whitespace (not enabled by default).
524 * `tabwidth=<n>` tells how many character positions a tab occupies; this
525 is relevant for `indent-with-non-tab` and when git fixes `tab-in-indent`
526 errors. The default tab width is 8. Allowed values are 1 to 63.
528 core.fsyncobjectfiles::
529 This boolean will enable 'fsync()' when writing object files.
531 This is a total waste of time and effort on a filesystem that orders
532 data writes properly, but can be useful for filesystems that do not use
533 journalling (traditional UNIX filesystems) or that only journal metadata
534 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
537 Enable parallel index preload for operations like 'git diff'
539 This can speed up operations like 'git diff' and 'git status' especially
540 on filesystems like NFS that have weak caching semantics and thus
541 relatively high IO latencies. With this set to 'true', git will do the
542 index comparison to the filesystem data in parallel, allowing
546 You can set this to 'link', in which case a hardlink followed by
547 a delete of the source are used to make sure that object creation
548 will not overwrite existing objects.
550 On some file system/operating system combinations, this is unreliable.
551 Set this config setting to 'rename' there; However, This will remove the
552 check that makes sure that existing object files will not get overwritten.
555 When showing commit messages, also show notes which are stored in
556 the given ref. The ref must be fully qualified. If the given
557 ref does not exist, it is not an error but means that no
558 notes should be printed.
560 This setting defaults to "refs/notes/commits", and it can be overridden by
561 the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
563 core.sparseCheckout::
564 Enable "sparse checkout" feature. See section "Sparse checkout" in
565 linkgit:git-read-tree[1] for more information.
568 Set the length object names are abbreviated to. If unspecified,
569 many commands abbreviate to 7 hexdigits, which may not be enough
570 for abbreviated object names to stay unique for sufficiently long
575 Tells 'git add' to continue adding files when some files cannot be
576 added due to indexing errors. Equivalent to the '--ignore-errors'
577 option of linkgit:git-add[1]. Older versions of git accept only
578 `add.ignore-errors`, which does not follow the usual naming
579 convention for configuration variables. Newer versions of git
580 honor `add.ignoreErrors` as well.
583 Command aliases for the linkgit:git[1] command wrapper - e.g.
584 after defining "alias.last = cat-file commit HEAD", the invocation
585 "git last" is equivalent to "git cat-file commit HEAD". To avoid
586 confusion and troubles with script usage, aliases that
587 hide existing git commands are ignored. Arguments are split by
588 spaces, the usual shell quoting and escaping is supported.
589 quote pair and a backslash can be used to quote them.
591 If the alias expansion is prefixed with an exclamation point,
592 it will be treated as a shell command. For example, defining
593 "alias.new = !gitk --all --not ORIG_HEAD", the invocation
594 "git new" is equivalent to running the shell command
595 "gitk --all --not ORIG_HEAD". Note that shell commands will be
596 executed from the top-level directory of a repository, which may
597 not necessarily be the current directory.
598 'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
599 from the original current directory. See linkgit:git-rev-parse[1].
602 If true, git-am will call git-mailsplit for patches in mbox format
603 with parameter '--keep-cr'. In this case git-mailsplit will
604 not remove `\r` from lines ending with `\r\n`. Can be overridden
605 by giving '--no-keep-cr' from the command line.
606 See linkgit:git-am[1], linkgit:git-mailsplit[1].
608 apply.ignorewhitespace::
609 When set to 'change', tells 'git apply' to ignore changes in
610 whitespace, in the same way as the '--ignore-space-change'
612 When set to one of: no, none, never, false tells 'git apply' to
613 respect all whitespace differences.
614 See linkgit:git-apply[1].
617 Tells 'git apply' how to handle whitespaces, in the same way
618 as the '--whitespace' option. See linkgit:git-apply[1].
620 branch.autosetupmerge::
621 Tells 'git branch' and 'git checkout' to set up new branches
622 so that linkgit:git-pull[1] will appropriately merge from the
623 starting point branch. Note that even if this option is not set,
624 this behavior can be chosen per-branch using the `--track`
625 and `--no-track` options. The valid settings are: `false` -- no
626 automatic setup is done; `true` -- automatic setup is done when the
627 starting point is a remote-tracking branch; `always` --
628 automatic setup is done when the starting point is either a
629 local branch or remote-tracking
630 branch. This option defaults to true.
632 branch.autosetuprebase::
633 When a new branch is created with 'git branch' or 'git checkout'
634 that tracks another branch, this variable tells git to set
635 up pull to rebase instead of merge (see "branch.<name>.rebase").
636 When `never`, rebase is never automatically set to true.
637 When `local`, rebase is set to true for tracked branches of
638 other local branches.
639 When `remote`, rebase is set to true for tracked branches of
640 remote-tracking branches.
641 When `always`, rebase will be set to true for all tracking
643 See "branch.autosetupmerge" for details on how to set up a
644 branch to track another branch.
645 This option defaults to never.
647 branch.<name>.remote::
648 When in branch <name>, it tells 'git fetch' and 'git push' which
649 remote to fetch from/push to. It defaults to `origin` if no remote is
650 configured. `origin` is also used if you are not on any branch.
652 branch.<name>.merge::
653 Defines, together with branch.<name>.remote, the upstream branch
654 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
655 branch to merge and can also affect 'git push' (see push.default).
656 When in branch <name>, it tells 'git fetch' the default
657 refspec to be marked for merging in FETCH_HEAD. The value is
658 handled like the remote part of a refspec, and must match a
659 ref which is fetched from the remote given by
660 "branch.<name>.remote".
661 The merge information is used by 'git pull' (which at first calls
662 'git fetch') to lookup the default branch for merging. Without
663 this option, 'git pull' defaults to merge the first refspec fetched.
664 Specify multiple values to get an octopus merge.
665 If you wish to setup 'git pull' so that it merges into <name> from
666 another branch in the local repository, you can point
667 branch.<name>.merge to the desired branch, and use the special setting
668 `.` (a period) for branch.<name>.remote.
670 branch.<name>.mergeoptions::
671 Sets default options for merging into branch <name>. The syntax and
672 supported options are the same as those of linkgit:git-merge[1], but
673 option values containing whitespace characters are currently not
676 branch.<name>.rebase::
677 When true, rebase the branch <name> on top of the fetched branch,
678 instead of merging the default branch from the default remote when
680 *NOTE*: this is a possibly dangerous operation; do *not* use
681 it unless you understand the implications (see linkgit:git-rebase[1]
685 Specify the command to invoke the specified browser. The
686 specified command is evaluated in shell with the URLs passed
687 as arguments. (See linkgit:git-web{litdd}browse[1].)
689 browser.<tool>.path::
690 Override the path for the given tool that may be used to
691 browse HTML help (see '-w' option in linkgit:git-help[1]) or a
692 working repository in gitweb (see linkgit:git-instaweb[1]).
695 A boolean to make git-clean do nothing unless given -f
696 or -n. Defaults to true.
699 A boolean to enable/disable color in the output of
700 linkgit:git-branch[1]. May be set to `always`,
701 `false` (or `never`) or `auto` (or `true`), in which case colors are used
702 only when the output is to a terminal. Defaults to false.
704 color.branch.<slot>::
705 Use customized color for branch coloration. `<slot>` is one of
706 `current` (the current branch), `local` (a local branch),
707 `remote` (a remote-tracking branch in refs/remotes/), `plain` (other
710 The value for these configuration variables is a list of colors (at most
711 two) and attributes (at most one), separated by spaces. The colors
712 accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
713 `magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
714 `blink` and `reverse`. The first color given is the foreground; the
715 second is the background. The position of the attribute, if any,
719 Whether to use ANSI escape sequences to add color to patches.
720 If this is set to `always`, linkgit:git-diff[1],
721 linkgit:git-log[1], and linkgit:git-show[1] will use color
722 for all patches. If it is set to `true` or `auto`, those
723 commands will only use color when output is to the terminal.
726 This does not affect linkgit:git-format-patch[1] nor the
727 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
728 command line with the `--color[=<when>]` option.
731 Use customized color for diff colorization. `<slot>` specifies
732 which part of the patch to use the specified color, and is one
733 of `plain` (context text), `meta` (metainformation), `frag`
734 (hunk header), 'func' (function in hunk header), `old` (removed lines),
735 `new` (added lines), `commit` (commit headers), or `whitespace`
736 (highlighting whitespace errors). The values of these variables may be
737 specified as in color.branch.<slot>.
739 color.decorate.<slot>::
740 Use customized color for 'git log --decorate' output. `<slot>` is one
741 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
742 branches, remote-tracking branches, tags, stash and HEAD, respectively.
745 When set to `always`, always highlight matches. When `false` (or
746 `never`), never. When set to `true` or `auto`, use color only
747 when the output is written to the terminal. Defaults to `false`.
750 Use customized color for grep colorization. `<slot>` specifies which
751 part of the line to use the specified color, and is one of
755 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
757 filename prefix (when not using `-h`)
759 function name lines (when using `-p`)
761 line number prefix (when using `-n`)
765 non-matching text in selected lines
767 separators between fields on a line (`:`, `-`, and `=`)
768 and between hunks (`--`)
771 The values of these variables may be specified as in color.branch.<slot>.
774 When set to `always`, always use colors for interactive prompts
775 and displays (such as those used by "git-add --interactive").
776 When false (or `never`), never. When set to `true` or `auto`, use
777 colors only when the output is to the terminal. Defaults to false.
779 color.interactive.<slot>::
780 Use customized color for 'git add --interactive'
781 output. `<slot>` may be `prompt`, `header`, `help` or `error`, for
782 four distinct types of normal output from interactive
783 commands. The values of these variables may be specified as
784 in color.branch.<slot>.
787 A boolean to enable/disable colored output when the pager is in
788 use (default is true).
791 A boolean to enable/disable color in the output of
792 linkgit:git-show-branch[1]. May be set to `always`,
793 `false` (or `never`) or `auto` (or `true`), in which case colors are used
794 only when the output is to a terminal. Defaults to false.
797 A boolean to enable/disable color in the output of
798 linkgit:git-status[1]. May be set to `always`,
799 `false` (or `never`) or `auto` (or `true`), in which case colors are used
800 only when the output is to a terminal. Defaults to false.
802 color.status.<slot>::
803 Use customized color for status colorization. `<slot>` is
804 one of `header` (the header text of the status message),
805 `added` or `updated` (files which are added but not committed),
806 `changed` (files which are changed but not added in the index),
807 `untracked` (files which are not tracked by git),
808 `branch` (the current branch), or
809 `nobranch` (the color the 'no branch' warning is shown in, defaulting
810 to red). The values of these variables may be specified as in
814 This variable determines the default value for variables such
815 as `color.diff` and `color.grep` that control the use of color
816 per command family. Its scope will expand as more commands learn
817 configuration to set a default for the `--color` option. Set it
818 to `always` if you want all output not intended for machine
819 consumption to use color, to `true` or `auto` if you want such
820 output to use color when written to the terminal, or to `false` or
821 `never` if you prefer git commands not to use color unless enabled
822 explicitly with some other configuration or the `--color` option.
825 A boolean to enable/disable inclusion of status information in the
826 commit message template when using an editor to prepare the commit
827 message. Defaults to true.
830 Specify a file to use as the template for new commit messages.
831 "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
832 specified user's home directory.
834 include::diff-config.txt[]
836 difftool.<tool>.path::
837 Override the path for the given tool. This is useful in case
838 your tool is not in the PATH.
840 difftool.<tool>.cmd::
841 Specify the command to invoke the specified diff tool.
842 The specified command is evaluated in shell with the following
843 variables available: 'LOCAL' is set to the name of the temporary
844 file containing the contents of the diff pre-image and 'REMOTE'
845 is set to the name of the temporary file containing the contents
846 of the diff post-image.
849 Prompt before each invocation of the diff tool.
852 A POSIX Extended Regular Expression used to determine what is a "word"
853 when performing word-by-word difference calculations. Character
854 sequences that match the regular expression are "words", all other
855 characters are *ignorable* whitespace.
857 fetch.recurseSubmodules::
858 This option can be either set to a boolean value or to 'on-demand'.
859 Setting it to a boolean changes the behavior of fetch and pull to
860 unconditionally recurse into submodules when set to true or to not
861 recurse at all when set to false. When set to 'on-demand' (the default
862 value), fetch and pull will only recurse into a populated submodule
863 when its superproject retrieves a commit that updates the submodule's
867 If it is set to true, git-fetch-pack will check all fetched
868 objects. It will abort in the case of a malformed object or a
869 broken link. The result of an abort are only dangling objects.
870 Defaults to false. If not set, the value of `transfer.fsckObjects`
874 If the number of objects fetched over the git native
875 transfer is below this
876 limit, then the objects will be unpacked into loose object
877 files. However if the number of received objects equals or
878 exceeds this limit then the received pack will be stored as
879 a pack, after adding any missing delta bases. Storing the
880 pack from a push can make the push operation complete faster,
881 especially on slow filesystems. If not set, the value of
882 `transfer.unpackLimit` is used instead.
885 Enable multipart/mixed attachments as the default for
886 'format-patch'. The value can also be a double quoted string
887 which will enable attachments as the default and set the
888 value as the boundary. See the --attach option in
889 linkgit:git-format-patch[1].
892 A boolean which can enable or disable sequence numbers in patch
893 subjects. It defaults to "auto" which enables it only if there
894 is more than one patch. It can be enabled or disabled for all
895 messages by setting it to "true" or "false". See --numbered
896 option in linkgit:git-format-patch[1].
899 Additional email headers to include in a patch to be submitted
900 by mail. See linkgit:git-format-patch[1].
904 Additional recipients to include in a patch to be submitted
905 by mail. See the --to and --cc options in
906 linkgit:git-format-patch[1].
908 format.subjectprefix::
909 The default for format-patch is to output files with the '[PATCH]'
910 subject prefix. Use this variable to change that prefix.
913 The default for format-patch is to output a signature containing
914 the git version number. Use this variable to change that default.
915 Set this variable to the empty string ("") to suppress
916 signature generation.
919 The default for format-patch is to output files with the suffix
920 `.patch`. Use this variable to change that suffix (make sure to
921 include the dot if you want it).
924 The default pretty format for log/show/whatchanged command,
925 See linkgit:git-log[1], linkgit:git-show[1],
926 linkgit:git-whatchanged[1].
929 The default threading style for 'git format-patch'. Can be
930 a boolean value, or `shallow` or `deep`. `shallow` threading
931 makes every mail a reply to the head of the series,
932 where the head is chosen from the cover letter, the
933 `\--in-reply-to`, and the first patch mail, in this order.
934 `deep` threading makes every mail a reply to the previous one.
935 A true boolean value is the same as `shallow`, and a false
936 value disables threading.
939 A boolean value which lets you enable the `-s/--signoff` option of
940 format-patch by default. *Note:* Adding the Signed-off-by: line to a
941 patch should be a conscious act and means that you certify you have
942 the rights to submit this work under the same open source license.
943 Please see the 'SubmittingPatches' document for further discussion.
945 filter.<driver>.clean::
946 The command which is used to convert the content of a worktree
947 file to a blob upon checkin. See linkgit:gitattributes[5] for
950 filter.<driver>.smudge::
951 The command which is used to convert the content of a blob
952 object to a worktree file upon checkout. See
953 linkgit:gitattributes[5] for details.
955 gc.aggressiveWindow::
956 The window size parameter used in the delta compression
957 algorithm used by 'git gc --aggressive'. This defaults
961 When there are approximately more than this many loose
962 objects in the repository, `git gc --auto` will pack them.
963 Some Porcelain commands use this command to perform a
964 light-weight garbage collection from time to time. The
965 default value is 6700. Setting this to 0 disables it.
968 When there are more than this many packs that are not
969 marked with `*.keep` file in the repository, `git gc
970 --auto` consolidates them into one larger pack. The
971 default value is 50. Setting this to 0 disables it.
974 Running `git pack-refs` in a repository renders it
975 unclonable by Git versions prior to 1.5.1.2 over dumb
976 transports such as HTTP. This variable determines whether
977 'git gc' runs `git pack-refs`. This can be set to `notbare`
978 to enable it within all non-bare repos or it can be set to a
979 boolean value. The default is `true`.
982 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
983 Override the grace period with this config variable. The value
984 "now" may be used to disable this grace period and always prune
985 unreachable objects immediately.
988 gc.<pattern>.reflogexpire::
989 'git reflog expire' removes reflog entries older than
990 this time; defaults to 90 days. With "<pattern>" (e.g.
991 "refs/stash") in the middle the setting applies only to
992 the refs that match the <pattern>.
994 gc.reflogexpireunreachable::
995 gc.<ref>.reflogexpireunreachable::
996 'git reflog expire' removes reflog entries older than
997 this time and are not reachable from the current tip;
998 defaults to 30 days. With "<pattern>" (e.g. "refs/stash")
999 in the middle, the setting applies only to the refs that
1000 match the <pattern>.
1003 Records of conflicted merge you resolved earlier are
1004 kept for this many days when 'git rerere gc' is run.
1005 The default is 60 days. See linkgit:git-rerere[1].
1007 gc.rerereunresolved::
1008 Records of conflicted merge you have not resolved are
1009 kept for this many days when 'git rerere gc' is run.
1010 The default is 15 days. See linkgit:git-rerere[1].
1012 gitcvs.commitmsgannotation::
1013 Append this string to each commit message. Set to empty string
1014 to disable this feature. Defaults to "via git-CVS emulator".
1017 Whether the CVS server interface is enabled for this repository.
1018 See linkgit:git-cvsserver[1].
1021 Path to a log file where the CVS server interface well... logs
1022 various stuff. See linkgit:git-cvsserver[1].
1024 gitcvs.usecrlfattr::
1025 If true, the server will look up the end-of-line conversion
1026 attributes for files to determine the '-k' modes to use. If
1027 the attributes force git to treat a file as text,
1028 the '-k' mode will be left blank so CVS clients will
1029 treat it as text. If they suppress text conversion, the file
1030 will be set with '-kb' mode, which suppresses any newline munging
1031 the client might otherwise do. If the attributes do not allow
1032 the file type to be determined, then 'gitcvs.allbinary' is
1033 used. See linkgit:gitattributes[5].
1036 This is used if 'gitcvs.usecrlfattr' does not resolve
1037 the correct '-kb' mode to use. If true, all
1038 unresolved files are sent to the client in
1039 mode '-kb'. This causes the client to treat them
1040 as binary files, which suppresses any newline munging it
1041 otherwise might do. Alternatively, if it is set to "guess",
1042 then the contents of the file are examined to decide if
1043 it is binary, similar to 'core.autocrlf'.
1046 Database used by git-cvsserver to cache revision information
1047 derived from the git repository. The exact meaning depends on the
1048 used database driver, for SQLite (which is the default driver) this
1049 is a filename. Supports variable substitution (see
1050 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1051 Default: '%Ggitcvs.%m.sqlite'
1054 Used Perl DBI driver. You can specify any available driver
1055 for this here, but it might not work. git-cvsserver is tested
1056 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1057 reported *not* to work with 'DBD::mysql'. Experimental feature.
1058 May not contain double colons (`:`). Default: 'SQLite'.
1059 See linkgit:git-cvsserver[1].
1061 gitcvs.dbuser, gitcvs.dbpass::
1062 Database user and password. Only useful if setting 'gitcvs.dbdriver',
1063 since SQLite has no concept of database users and/or passwords.
1064 'gitcvs.dbuser' supports variable substitution (see
1065 linkgit:git-cvsserver[1] for details).
1067 gitcvs.dbTableNamePrefix::
1068 Database table name prefix. Prepended to the names of any
1069 database tables used, allowing a single database to be used
1070 for several repositories. Supports variable substitution (see
1071 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1072 characters will be replaced with underscores.
1074 All gitcvs variables except for 'gitcvs.usecrlfattr' and
1075 'gitcvs.allbinary' can also be specified as
1076 'gitcvs.<access_method>.<varname>' (where 'access_method'
1077 is one of "ext" and "pserver") to make them apply only for the given
1081 If set to true, enable '-n' option by default.
1083 grep.extendedRegexp::
1084 If set to true, enable '--extended-regexp' option by default.
1086 gui.commitmsgwidth::
1087 Defines how wide the commit message window is in the
1088 linkgit:git-gui[1]. "75" is the default.
1091 Specifies how many context lines should be used in calls to diff
1092 made by the linkgit:git-gui[1]. The default is "5".
1095 Specifies the default encoding to use for displaying of
1096 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1097 It can be overridden by setting the 'encoding' attribute
1098 for relevant files (see linkgit:gitattributes[5]).
1099 If this option is not set, the tools default to the
1102 gui.matchtrackingbranch::
1103 Determines if new branches created with linkgit:git-gui[1] should
1104 default to tracking remote branches with matching names or
1105 not. Default: "false".
1107 gui.newbranchtemplate::
1108 Is used as suggested name when creating new branches using the
1111 gui.pruneduringfetch::
1112 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1113 performing a fetch. The default value is "false".
1116 Determines if linkgit:git-gui[1] should trust the file modification
1117 timestamp or not. By default the timestamps are not trusted.
1119 gui.spellingdictionary::
1120 Specifies the dictionary used for spell checking commit messages in
1121 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1125 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1126 location detection. It makes blame significantly faster on huge
1127 repositories at the expense of less thorough copy detection.
1129 gui.copyblamethreshold::
1130 Specifies the threshold to use in 'git gui blame' original location
1131 detection, measured in alphanumeric characters. See the
1132 linkgit:git-blame[1] manual for more information on copy detection.
1134 gui.blamehistoryctx::
1135 Specifies the radius of history context in days to show in
1136 linkgit:gitk[1] for the selected commit, when the `Show History
1137 Context` menu item is invoked from 'git gui blame'. If this
1138 variable is set to zero, the whole history is shown.
1140 guitool.<name>.cmd::
1141 Specifies the shell command line to execute when the corresponding item
1142 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1143 mandatory for every tool. The command is executed from the root of
1144 the working directory, and in the environment it receives the name of
1145 the tool as 'GIT_GUITOOL', the name of the currently selected file as
1146 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1147 the head is detached, 'CUR_BRANCH' is empty).
1149 guitool.<name>.needsfile::
1150 Run the tool only if a diff is selected in the GUI. It guarantees
1151 that 'FILENAME' is not empty.
1153 guitool.<name>.noconsole::
1154 Run the command silently, without creating a window to display its
1157 guitool.<name>.norescan::
1158 Don't rescan the working directory for changes after the tool
1161 guitool.<name>.confirm::
1162 Show a confirmation dialog before actually running the tool.
1164 guitool.<name>.argprompt::
1165 Request a string argument from the user, and pass it to the tool
1166 through the 'ARGS' environment variable. Since requesting an
1167 argument implies confirmation, the 'confirm' option has no effect
1168 if this is enabled. If the option is set to 'true', 'yes', or '1',
1169 the dialog uses a built-in generic prompt; otherwise the exact
1170 value of the variable is used.
1172 guitool.<name>.revprompt::
1173 Request a single valid revision from the user, and set the
1174 'REVISION' environment variable. In other aspects this option
1175 is similar to 'argprompt', and can be used together with it.
1177 guitool.<name>.revunmerged::
1178 Show only unmerged branches in the 'revprompt' subdialog.
1179 This is useful for tools similar to merge or rebase, but not
1180 for things like checkout or reset.
1182 guitool.<name>.title::
1183 Specifies the title to use for the prompt dialog. The default
1186 guitool.<name>.prompt::
1187 Specifies the general prompt string to display at the top of
1188 the dialog, before subsections for 'argprompt' and 'revprompt'.
1189 The default value includes the actual command.
1192 Specify the browser that will be used to display help in the
1193 'web' format. See linkgit:git-help[1].
1196 Override the default help format used by linkgit:git-help[1].
1197 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1198 the default. 'web' and 'html' are the same.
1201 Automatically correct and execute mistyped commands after
1202 waiting for the given number of deciseconds (0.1 sec). If more
1203 than one command can be deduced from the entered text, nothing
1204 will be executed. If the value of this option is negative,
1205 the corrected command will be executed immediately. If the
1206 value is 0 - the command will be just shown but not executed.
1207 This is the default.
1210 Override the HTTP proxy, normally configured using the 'http_proxy'
1211 environment variable (see linkgit:curl[1]). This can be overridden
1212 on a per-remote basis; see remote.<name>.proxy
1215 File containing previously stored cookie lines which should be used
1216 in the git http session, if they match the server. The file format
1217 of the file to read cookies from should be plain HTTP headers or
1218 the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
1219 NOTE that the file specified with http.cookiefile is only used as
1220 input. No cookies will be stored in the file.
1223 Whether to verify the SSL certificate when fetching or pushing
1224 over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
1228 File containing the SSL certificate when fetching or pushing
1229 over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
1233 File containing the SSL private key when fetching or pushing
1234 over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
1237 http.sslCertPasswordProtected::
1238 Enable git's password prompt for the SSL certificate. Otherwise
1239 OpenSSL will prompt the user, possibly many times, if the
1240 certificate or private key is encrypted. Can be overridden by the
1241 'GIT_SSL_CERT_PASSWORD_PROTECTED' environment variable.
1244 File containing the certificates to verify the peer with when
1245 fetching or pushing over HTTPS. Can be overridden by the
1246 'GIT_SSL_CAINFO' environment variable.
1249 Path containing files with the CA certificates to verify the peer
1250 with when fetching or pushing over HTTPS. Can be overridden
1251 by the 'GIT_SSL_CAPATH' environment variable.
1254 How many HTTP requests to launch in parallel. Can be overridden
1255 by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
1258 The number of curl sessions (counted across slots) to be kept across
1259 requests. They will not be ended with curl_easy_cleanup() until
1260 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1261 value will be capped at 1. Defaults to 1.
1264 Maximum size in bytes of the buffer used by smart HTTP
1265 transports when POSTing data to the remote system.
1266 For requests larger than this buffer size, HTTP/1.1 and
1267 Transfer-Encoding: chunked is used to avoid creating a
1268 massive pack file locally. Default is 1 MiB, which is
1269 sufficient for most requests.
1271 http.lowSpeedLimit, http.lowSpeedTime::
1272 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1273 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1274 Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
1275 'GIT_HTTP_LOW_SPEED_TIME' environment variables.
1278 A boolean which disables using of EPSV ftp command by curl.
1279 This can helpful with some "poor" ftp servers which don't
1280 support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
1281 environment variable. Default is false (curl will use EPSV).
1284 The HTTP USER_AGENT string presented to an HTTP server. The default
1285 value represents the version of the client git such as git/1.7.1.
1286 This option allows you to override this value to a more common value
1287 such as Mozilla/4.0. This may be necessary, for instance, if
1288 connecting through a firewall that restricts HTTP connections to a set
1289 of common USER_AGENT strings (but not including those like git/1.7.1).
1290 Can be overridden by the 'GIT_HTTP_USER_AGENT' environment variable.
1292 i18n.commitEncoding::
1293 Character encoding the commit messages are stored in; git itself
1294 does not care per se, but this information is necessary e.g. when
1295 importing commits from emails or in the gitk graphical history
1296 browser (and possibly at other places in the future or in other
1297 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1299 i18n.logOutputEncoding::
1300 Character encoding the commit messages are converted to when
1301 running 'git log' and friends.
1304 The configuration variables in the 'imap' section are described
1305 in linkgit:git-imap-send[1].
1308 Specify the directory from which templates will be copied.
1309 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1312 Specify the program that will be used to browse your working
1313 repository in gitweb. See linkgit:git-instaweb[1].
1316 The HTTP daemon command-line to start gitweb on your working
1317 repository. See linkgit:git-instaweb[1].
1320 If true the web server started by linkgit:git-instaweb[1] will
1321 be bound to the local IP (127.0.0.1).
1323 instaweb.modulepath::
1324 The default module path for linkgit:git-instaweb[1] to use
1325 instead of /usr/lib/apache2/modules. Only used if httpd
1329 The port number to bind the gitweb httpd to. See
1330 linkgit:git-instaweb[1].
1332 interactive.singlekey::
1333 In interactive commands, allow the user to provide one-letter
1334 input with a single key (i.e., without hitting enter).
1335 Currently this is used by the `\--patch` mode of
1336 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1337 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1338 setting is silently ignored if portable keystroke input
1342 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1343 linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
1344 override this option with `\--no-abbrev-commit`.
1347 Set the default date-time mode for the 'log' command.
1348 Setting a value for log.date is similar to using 'git log''s
1349 `\--date` option. Possible values are `relative`, `local`,
1350 `default`, `iso`, `rfc`, and `short`; see linkgit:git-log[1]
1354 Print out the ref names of any commits that are shown by the log
1355 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1356 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1357 specified, the full ref name (including prefix) will be printed.
1358 This is the same as the log commands '--decorate' option.
1361 If true, the initial commit will be shown as a big creation event.
1362 This is equivalent to a diff against an empty tree.
1363 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1364 normally hide the root commit will now show it. True by default.
1367 The location of an augmenting mailmap file. The default
1368 mailmap, located in the root of the repository, is loaded
1369 first, then the mailmap file pointed to by this variable.
1370 The location of the mailmap file may be in a repository
1371 subdirectory, or somewhere outside of the repository itself.
1372 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1375 Specify the programs that may be used to display help in the
1376 'man' format. See linkgit:git-help[1].
1379 Specify the command to invoke the specified man viewer. The
1380 specified command is evaluated in shell with the man page
1381 passed as argument. (See linkgit:git-help[1].)
1384 Override the path for the given tool that may be used to
1385 display help in the 'man' format. See linkgit:git-help[1].
1387 include::merge-config.txt[]
1389 mergetool.<tool>.path::
1390 Override the path for the given tool. This is useful in case
1391 your tool is not in the PATH.
1393 mergetool.<tool>.cmd::
1394 Specify the command to invoke the specified merge tool. The
1395 specified command is evaluated in shell with the following
1396 variables available: 'BASE' is the name of a temporary file
1397 containing the common base of the files to be merged, if available;
1398 'LOCAL' is the name of a temporary file containing the contents of
1399 the file on the current branch; 'REMOTE' is the name of a temporary
1400 file containing the contents of the file from the branch being
1401 merged; 'MERGED' contains the name of the file to which the merge
1402 tool should write the results of a successful merge.
1404 mergetool.<tool>.trustExitCode::
1405 For a custom merge command, specify whether the exit code of
1406 the merge command can be used to determine whether the merge was
1407 successful. If this is not set to true then the merge target file
1408 timestamp is checked and the merge assumed to have been successful
1409 if the file has been updated, otherwise the user is prompted to
1410 indicate the success of the merge.
1412 mergetool.keepBackup::
1413 After performing a merge, the original file with conflict markers
1414 can be saved as a file with a `.orig` extension. If this variable
1415 is set to `false` then this file is not preserved. Defaults to
1416 `true` (i.e. keep the backup files).
1418 mergetool.keepTemporaries::
1419 When invoking a custom merge tool, git uses a set of temporary
1420 files to pass to the tool. If the tool returns an error and this
1421 variable is set to `true`, then these temporary files will be
1422 preserved, otherwise they will be removed after the tool has
1423 exited. Defaults to `false`.
1426 Prompt before each invocation of the merge resolution program.
1429 The (fully qualified) refname from which to show notes when
1430 showing commit messages. The value of this variable can be set
1431 to a glob, in which case notes from all matching refs will be
1432 shown. You may also specify this configuration variable
1433 several times. A warning will be issued for refs that do not
1434 exist, but a glob that does not match any refs is silently
1437 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1438 environment variable, which must be a colon separated list of refs or
1441 The effective value of "core.notesRef" (possibly overridden by
1442 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1445 notes.rewrite.<command>::
1446 When rewriting commits with <command> (currently `amend` or
1447 `rebase`) and this variable is set to `true`, git
1448 automatically copies your notes from the original to the
1449 rewritten commit. Defaults to `true`, but see
1450 "notes.rewriteRef" below.
1453 When copying notes during a rewrite (see the
1454 "notes.rewrite.<command>" option), determines what to do if
1455 the target commit already has a note. Must be one of
1456 `overwrite`, `concatenate`, or `ignore`. Defaults to
1459 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1460 environment variable.
1463 When copying notes during a rewrite, specifies the (fully
1464 qualified) ref whose notes should be copied. The ref may be a
1465 glob, in which case notes in all matching refs will be copied.
1466 You may also specify this configuration several times.
1468 Does not have a default value; you must configure this variable to
1469 enable note rewriting. Set it to `refs/notes/commits` to enable
1470 rewriting for the default commit notes.
1472 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1473 environment variable, which must be a colon separated list of refs or
1477 The size of the window used by linkgit:git-pack-objects[1] when no
1478 window size is given on the command line. Defaults to 10.
1481 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1482 maximum depth is given on the command line. Defaults to 50.
1485 The window memory size limit used by linkgit:git-pack-objects[1]
1486 when no limit is given on the command line. The value can be
1487 suffixed with "k", "m", or "g". Defaults to 0, meaning no
1491 An integer -1..9, indicating the compression level for objects
1492 in a pack file. -1 is the zlib default. 0 means no
1493 compression, and 1..9 are various speed/size tradeoffs, 9 being
1494 slowest. If not set, defaults to core.compression. If that is
1495 not set, defaults to -1, the zlib default, which is "a default
1496 compromise between speed and compression (currently equivalent
1499 Note that changing the compression level will not automatically recompress
1500 all existing objects. You can force recompression by passing the -F option
1501 to linkgit:git-repack[1].
1503 pack.deltaCacheSize::
1504 The maximum memory in bytes used for caching deltas in
1505 linkgit:git-pack-objects[1] before writing them out to a pack.
1506 This cache is used to speed up the writing object phase by not
1507 having to recompute the final delta result once the best match
1508 for all objects is found. Repacking large repositories on machines
1509 which are tight with memory might be badly impacted by this though,
1510 especially if this cache pushes the system into swapping.
1511 A value of 0 means no limit. The smallest size of 1 byte may be
1512 used to virtually disable this cache. Defaults to 256 MiB.
1514 pack.deltaCacheLimit::
1515 The maximum size of a delta, that is cached in
1516 linkgit:git-pack-objects[1]. This cache is used to speed up the
1517 writing object phase by not having to recompute the final delta
1518 result once the best match for all objects is found. Defaults to 1000.
1521 Specifies the number of threads to spawn when searching for best
1522 delta matches. This requires that linkgit:git-pack-objects[1]
1523 be compiled with pthreads otherwise this option is ignored with a
1524 warning. This is meant to reduce packing time on multiprocessor
1525 machines. The required amount of memory for the delta search window
1526 is however multiplied by the number of threads.
1527 Specifying 0 will cause git to auto-detect the number of CPU's
1528 and set the number of threads accordingly.
1531 Specify the default pack index version. Valid values are 1 for
1532 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1533 the new pack index with capabilities for packs larger than 4 GB
1534 as well as proper protection against the repacking of corrupted
1535 packs. Version 2 is the default. Note that version 2 is enforced
1536 and this config option ignored whenever the corresponding pack is
1539 If you have an old git that does not understand the version 2 `{asterisk}.idx` file,
1540 cloning or fetching over a non native protocol (e.g. "http" and "rsync")
1541 that will copy both `{asterisk}.pack` file and corresponding `{asterisk}.idx` file from the
1542 other side may give you a repository that cannot be accessed with your
1543 older version of git. If the `{asterisk}.pack` file is smaller than 2 GB, however,
1544 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1545 the `{asterisk}.idx` file.
1547 pack.packSizeLimit::
1548 The maximum size of a pack. This setting only affects
1549 packing to a file when repacking, i.e. the git:// protocol
1550 is unaffected. It can be overridden by the `\--max-pack-size`
1551 option of linkgit:git-repack[1]. The minimum size allowed is
1552 limited to 1 MiB. The default is unlimited.
1553 Common unit suffixes of 'k', 'm', or 'g' are
1557 If the value is boolean, turns on or off pagination of the
1558 output of a particular git subcommand when writing to a tty.
1559 Otherwise, turns on pagination for the subcommand using the
1560 pager specified by the value of `pager.<cmd>`. If `\--paginate`
1561 or `\--no-pager` is specified on the command line, it takes
1562 precedence over this option. To disable pagination for all
1563 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1566 Alias for a --pretty= format string, as specified in
1567 linkgit:git-log[1]. Any aliases defined here can be used just
1568 as the built-in pretty formats could. For example,
1569 running `git config pretty.changelog "format:{asterisk} %H %s"`
1570 would cause the invocation `git log --pretty=changelog`
1571 to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`.
1572 Note that an alias with the same name as a built-in format
1573 will be silently ignored.
1576 The default merge strategy to use when pulling multiple branches
1580 The default merge strategy to use when pulling a single branch.
1583 Defines the action git push should take if no refspec is given
1584 on the command line, no refspec is configured in the remote, and
1585 no refspec is implied by any of the options given on the command
1586 line. Possible values are:
1588 * `nothing` - do not push anything.
1589 * `matching` - push all matching branches.
1590 All branches having the same name in both ends are considered to be
1591 matching. This is the default.
1592 * `upstream` - push the current branch to its upstream branch.
1593 * `tracking` - deprecated synonym for `upstream`.
1594 * `current` - push the current branch to a branch of the same name.
1597 Whether to show a diffstat of what changed upstream since the last
1598 rebase. False by default.
1601 If set to true enable '--autosquash' option by default.
1604 By default, git-receive-pack will run "git-gc --auto" after
1605 receiving data from git-push and updating refs. You can stop
1606 it by setting this variable to false.
1608 receive.fsckObjects::
1609 If it is set to true, git-receive-pack will check all received
1610 objects. It will abort in the case of a malformed object or a
1611 broken link. The result of an abort are only dangling objects.
1612 Defaults to false. If not set, the value of `transfer.fsckObjects`
1615 receive.unpackLimit::
1616 If the number of objects received in a push is below this
1617 limit then the objects will be unpacked into loose object
1618 files. However if the number of received objects equals or
1619 exceeds this limit then the received pack will be stored as
1620 a pack, after adding any missing delta bases. Storing the
1621 pack from a push can make the push operation complete faster,
1622 especially on slow filesystems. If not set, the value of
1623 `transfer.unpackLimit` is used instead.
1625 receive.denyDeletes::
1626 If set to true, git-receive-pack will deny a ref update that deletes
1627 the ref. Use this to prevent such a ref deletion via a push.
1629 receive.denyDeleteCurrent::
1630 If set to true, git-receive-pack will deny a ref update that
1631 deletes the currently checked out branch of a non-bare repository.
1633 receive.denyCurrentBranch::
1634 If set to true or "refuse", git-receive-pack will deny a ref update
1635 to the currently checked out branch of a non-bare repository.
1636 Such a push is potentially dangerous because it brings the HEAD
1637 out of sync with the index and working tree. If set to "warn",
1638 print a warning of such a push to stderr, but allow the push to
1639 proceed. If set to false or "ignore", allow such pushes with no
1640 message. Defaults to "refuse".
1642 There are two more options that are meant for Git experts: "updateInstead"
1643 which will run `read-tree -u -m HEAD` and "detachInstead" which will detach
1644 the HEAD so it does not need to change. Both options come with their own
1645 set of possible *complications*, but can be appropriate in rare workflows.
1647 receive.denyNonFastForwards::
1648 If set to true, git-receive-pack will deny a ref update which is
1649 not a fast-forward. Use this to prevent such an update via a push,
1650 even if that push is forced. This configuration variable is
1651 set when initializing a shared repository.
1653 receive.updateserverinfo::
1654 If set to true, git-receive-pack will run git-update-server-info
1655 after receiving data from git-push and updating refs.
1658 The URL of a remote repository. See linkgit:git-fetch[1] or
1659 linkgit:git-push[1].
1661 remote.<name>.pushurl::
1662 The push URL of a remote repository. See linkgit:git-push[1].
1664 remote.<name>.proxy::
1665 For remotes that require curl (http, https and ftp), the URL to
1666 the proxy to use for that remote. Set to the empty string to
1667 disable proxying for that remote.
1669 remote.<name>.fetch::
1670 The default set of "refspec" for linkgit:git-fetch[1]. See
1671 linkgit:git-fetch[1].
1673 remote.<name>.push::
1674 The default set of "refspec" for linkgit:git-push[1]. See
1675 linkgit:git-push[1].
1677 remote.<name>.mirror::
1678 If true, pushing to this remote will automatically behave
1679 as if the `\--mirror` option was given on the command line.
1681 remote.<name>.skipDefaultUpdate::
1682 If true, this remote will be skipped by default when updating
1683 using linkgit:git-fetch[1] or the `update` subcommand of
1684 linkgit:git-remote[1].
1686 remote.<name>.skipFetchAll::
1687 If true, this remote will be skipped by default when updating
1688 using linkgit:git-fetch[1] or the `update` subcommand of
1689 linkgit:git-remote[1].
1691 remote.<name>.receivepack::
1692 The default program to execute on the remote side when pushing. See
1693 option \--receive-pack of linkgit:git-push[1].
1695 remote.<name>.uploadpack::
1696 The default program to execute on the remote side when fetching. See
1697 option \--upload-pack of linkgit:git-fetch-pack[1].
1699 remote.<name>.tagopt::
1700 Setting this value to \--no-tags disables automatic tag following when
1701 fetching from remote <name>. Setting it to \--tags will fetch every
1702 tag from remote <name>, even if they are not reachable from remote
1703 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1704 override this setting. See options \--tags and \--no-tags of
1705 linkgit:git-fetch[1].
1708 Setting this to a value <vcs> will cause git to interact with
1709 the remote with the git-remote-<vcs> helper.
1712 The list of remotes which are fetched by "git remote update
1713 <group>". See linkgit:git-remote[1].
1715 repack.usedeltabaseoffset::
1716 By default, linkgit:git-repack[1] creates packs that use
1717 delta-base offset. If you need to share your repository with
1718 git older than version 1.4.4, either directly or via a dumb
1719 protocol such as http, then you need to set this option to
1720 "false" and repack. Access from old git versions over the
1721 native protocol are unaffected by this option.
1724 When set to true, `git-rerere` updates the index with the
1725 resulting contents after it cleanly resolves conflicts using
1726 previously recorded resolution. Defaults to false.
1729 Activate recording of resolved conflicts, so that identical
1730 conflict hunks can be resolved automatically, should they
1731 be encountered again. linkgit:git-rerere[1] command is by
1732 default enabled if you create `rr-cache` directory under
1733 `$GIT_DIR`, but can be disabled by setting this option to false.
1735 sendemail.identity::
1736 A configuration identity. When given, causes values in the
1737 'sendemail.<identity>' subsection to take precedence over
1738 values in the 'sendemail' section. The default identity is
1739 the value of 'sendemail.identity'.
1741 sendemail.smtpencryption::
1742 See linkgit:git-send-email[1] for description. Note that this
1743 setting is not subject to the 'identity' mechanism.
1746 Deprecated alias for 'sendemail.smtpencryption = ssl'.
1748 sendemail.<identity>.*::
1749 Identity-specific versions of the 'sendemail.*' parameters
1750 found below, taking precedence over those when the this
1751 identity is selected, through command-line or
1752 'sendemail.identity'.
1754 sendemail.aliasesfile::
1755 sendemail.aliasfiletype::
1759 sendemail.chainreplyto::
1761 sendemail.envelopesender::
1763 sendemail.multiedit::
1764 sendemail.signedoffbycc::
1765 sendemail.smtppass::
1766 sendemail.suppresscc::
1767 sendemail.suppressfrom::
1769 sendemail.smtpdomain::
1770 sendemail.smtpserver::
1771 sendemail.smtpserverport::
1772 sendemail.smtpserveroption::
1773 sendemail.smtpuser::
1775 sendemail.validate::
1776 See linkgit:git-send-email[1] for description.
1778 sendemail.signedoffcc::
1779 Deprecated alias for 'sendemail.signedoffbycc'.
1781 showbranch.default::
1782 The default set of branches for linkgit:git-show-branch[1].
1783 See linkgit:git-show-branch[1].
1785 status.relativePaths::
1786 By default, linkgit:git-status[1] shows paths relative to the
1787 current directory. Setting this variable to `false` shows paths
1788 relative to the repository root (this was the default for git
1791 status.showUntrackedFiles::
1792 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1793 files which are not currently tracked by Git. Directories which
1794 contain only untracked files, are shown with the directory name
1795 only. Showing untracked files means that Git needs to lstat() all
1796 all the files in the whole repository, which might be slow on some
1797 systems. So, this variable controls how the commands displays
1798 the untracked files. Possible values are:
1801 * `no` - Show no untracked files.
1802 * `normal` - Show untracked files and directories.
1803 * `all` - Show also individual files in untracked directories.
1806 If this variable is not specified, it defaults to 'normal'.
1807 This variable can be overridden with the -u|--untracked-files option
1808 of linkgit:git-status[1] and linkgit:git-commit[1].
1810 status.submodulesummary::
1812 If this is set to a non zero number or true (identical to -1 or an
1813 unlimited number), the submodule summary will be enabled and a
1814 summary of commits for modified submodules will be shown (see
1815 --summary-limit option of linkgit:git-submodule[1]).
1817 submodule.<name>.path::
1818 submodule.<name>.url::
1819 submodule.<name>.update::
1820 The path within this project, URL, and the updating strategy
1821 for a submodule. These variables are initially populated
1822 by 'git submodule init'; edit them to override the
1823 URL and other values found in the `.gitmodules` file. See
1824 linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
1826 submodule.<name>.fetchRecurseSubmodules::
1827 This option can be used to control recursive fetching of this
1828 submodule. It can be overridden by using the --[no-]recurse-submodules
1829 command line option to "git fetch" and "git pull".
1830 This setting will override that from in the linkgit:gitmodules[5]
1833 submodule.<name>.ignore::
1834 Defines under what circumstances "git status" and the diff family show
1835 a submodule as modified. When set to "all", it will never be considered
1836 modified, "dirty" will ignore all changes to the submodules work tree and
1837 takes only differences between the HEAD of the submodule and the commit
1838 recorded in the superproject into account. "untracked" will additionally
1839 let submodules with modified tracked files in their work tree show up.
1840 Using "none" (the default when this option is not set) also shows
1841 submodules that have untracked files in their work tree as changed.
1842 This setting overrides any setting made in .gitmodules for this submodule,
1843 both settings can be overridden on the command line by using the
1844 "--ignore-submodules" option.
1847 This variable can be used to restrict the permission bits of
1848 tar archive entries. The default is 0002, which turns off the
1849 world write bit. The special value "user" indicates that the
1850 archiving user's umask will be used instead. See umask(2) and
1851 linkgit:git-archive[1].
1853 transfer.fsckObjects::
1854 When `fetch.fsckObjects` or `receive.fsckObjects` are
1855 not set, the value of this variable is used instead.
1858 transfer.unpackLimit::
1859 When `fetch.unpackLimit` or `receive.unpackLimit` are
1860 not set, the value of this variable is used instead.
1861 The default value is 100.
1863 url.<base>.insteadOf::
1864 Any URL that starts with this value will be rewritten to
1865 start, instead, with <base>. In cases where some site serves a
1866 large number of repositories, and serves them with multiple
1867 access methods, and some users need to use different access
1868 methods, this feature allows people to specify any of the
1869 equivalent URLs and have git automatically rewrite the URL to
1870 the best alternative for the particular user, even for a
1871 never-before-seen repository on the site. When more than one
1872 insteadOf strings match a given URL, the longest match is used.
1874 url.<base>.pushInsteadOf::
1875 Any URL that starts with this value will not be pushed to;
1876 instead, it will be rewritten to start with <base>, and the
1877 resulting URL will be pushed to. In cases where some site serves
1878 a large number of repositories, and serves them with multiple
1879 access methods, some of which do not allow push, this feature
1880 allows people to specify a pull-only URL and have git
1881 automatically use an appropriate URL to push, even for a
1882 never-before-seen repository on the site. When more than one
1883 pushInsteadOf strings match a given URL, the longest match is
1884 used. If a remote has an explicit pushurl, git will ignore this
1885 setting for that remote.
1888 Your email address to be recorded in any newly created commits.
1889 Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and
1890 'EMAIL' environment variables. See linkgit:git-commit-tree[1].
1893 Your full name to be recorded in any newly created commits.
1894 Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
1895 environment variables. See linkgit:git-commit-tree[1].
1898 If linkgit:git-tag[1] is not selecting the key you want it to
1899 automatically when creating a signed tag, you can override the
1900 default selection with this variable. This option is passed
1901 unchanged to gpg's --local-user parameter, so you may specify a key
1902 using any method that gpg supports.
1905 Specify a web browser that may be used by some commands.
1906 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]