config: resolve symlinks in conditional include's patterns
[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 a config file from another by setting the special
83 `include.path` variable to the name of the file to be included. The
84 variable takes a pathname as its value, and is subject to tilde
85 expansion. `include.path` can be given multiple times.
87 The included file is expanded immediately, as if its contents had been
88 found at the location of the include directive. If the value of the
89 `include.path` variable is a relative path, the path is considered to
90 be relative to the configuration file in which the include directive
91 was found. See below for examples.
93 Conditional includes
94 ~~~~~~~~~~~~~~~~~~~~
96 You can include a config file from another conditionally by setting a
97 `includeIf.<condition>.path` variable to the name of the file to be
98 included. The variable's value is treated the same way as
99 `include.path`. `includeIf.<condition>.path` can be given multiple times.
101 The condition starts with a keyword followed by a colon and some data
102 whose format and meaning depends on the keyword. Supported keywords
103 are:
105 `gitdir`::
107 The data that follows the keyword `gitdir:` is used as a glob
108 pattern. If the location of the .git directory matches the
109 pattern, the include condition is met.
110 +
111 The .git location may be auto-discovered, or come from `$GIT_DIR`
112 environment variable. If the repository is auto discovered via a .git
113 file (e.g. from submodules, or a linked worktree), the .git location
114 would be the final location where the .git directory is, not where the
115 .git file is.
116 +
117 The pattern can contain standard globbing wildcards and two additional
118 ones, `**/` and `/**`, that can match multiple path components. Please
119 refer to linkgit:gitignore[5] for details. For convenience:
121 * If the pattern starts with `~/`, `~` will be substituted with the
122 content of the environment variable `HOME`.
124 * If the pattern starts with `./`, it is replaced with the directory
125 containing the current config file.
127 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
128 will be automatically prepended. For example, the pattern `foo/bar`
129 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
131 * If the pattern ends with `/`, `**` will be automatically added. For
132 example, the pattern `foo/` becomes `foo/**`. In other words, it
133 matches "foo" and everything inside, recursively.
135 `gitdir/i`::
136 This is the same as `gitdir` except that matching is done
137 case-insensitively (e.g. on case-insensitive file sytems)
139 A few more notes on matching via `gitdir` and `gitdir/i`:
141 * Symlinks in `$GIT_DIR` are not resolved before matching.
143 * Note that "../" is not special and will match literally, which is
144 unlikely what you want.
146 Example
147 ~~~~~~~
149 # Core variables
150 [core]
151 ; Don't trust file modes
152 filemode = false
154 # Our diff algorithm
155 [diff]
156 external = /usr/local/bin/diff-wrapper
157 renames = true
159 [branch "devel"]
160 remote = origin
161 merge = refs/heads/devel
163 # Proxy settings
164 [core]
165 gitProxy="ssh" for ""
166 gitProxy=default-proxy ; for the rest
168 [include]
169 path = /path/to/ ; include by absolute path
170 path = foo ; expand "foo" relative to the current file
171 path = ~/foo ; expand "foo" in your `$HOME` directory
173 ; include if $GIT_DIR is /path/to/foo/.git
174 [includeIf "gitdir:/path/to/foo/.git"]
175 path = /path/to/
177 ; include for all repositories inside /path/to/group
178 [includeIf "gitdir:/path/to/group/"]
179 path = /path/to/
181 ; include for all repositories inside $HOME/to/group
182 [includeIf "gitdir:~/to/group/"]
183 path = /path/to/
185 Values
186 ~~~~~~
188 Values of many variables are treated as a simple string, but there
189 are variables that take values of specific types and there are rules
190 as to how to spell them.
192 boolean::
194 When a variable is said to take a boolean value, many
195 synonyms are accepted for 'true' and 'false'; these are all
196 case-insensitive.
198 true;; Boolean true can be spelled as `yes`, `on`, `true`,
199 or `1`. Also, a variable defined without `= <value>`
200 is taken as true.
202 false;; Boolean false can be spelled as `no`, `off`,
203 `false`, or `0`.
204 +
205 When converting value to the canonical form using `--bool` type
206 specifier; 'git config' will ensure that the output is "true" or
207 "false" (spelled in lowercase).
209 integer::
210 The value for many variables that specify various sizes can
211 be suffixed with `k`, `M`,... to mean "scale the number by
212 1024", "by 1024x1024", etc.
214 color::
215 The value for a variable that takes a color is a list of
216 colors (at most two, one for foreground and one for background)
217 and attributes (as many as you want), separated by spaces.
218 +
219 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
220 `blue`, `magenta`, `cyan` and `white`. The first color given is the
221 foreground; the second is the background.
222 +
223 Colors may also be given as numbers between 0 and 255; these use ANSI
224 256-color mode (but note that not all terminals may support this). If
225 your terminal supports it, you may also specify 24-bit RGB values as
226 hex, like `#ff0ab3`.
227 +
228 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
229 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
230 The position of any attributes with respect to the colors
231 (before, after, or in between), doesn't matter. Specific attributes may
232 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
233 `no-ul`, etc).
234 +
235 An empty color string produces no color effect at all. This can be used
236 to avoid coloring specific elements without disabling color entirely.
237 +
238 For git's pre-defined color slots, the attributes are meant to be reset
239 at the beginning of each item in the colored output. So setting
240 `color.decorate.branch` to `black` will paint that branch name in a
241 plain `black`, even if the previous thing on the same output line (e.g.
242 opening parenthesis before the list of branch names in `log --decorate`
243 output) is set to be painted with `bold` or some other attribute.
244 However, custom log formats may do more complicated and layered
245 coloring, and the negated forms may be useful there.
247 pathname::
248 A variable that takes a pathname value can be given a
249 string that begins with "`~/`" or "`~user/`", and the usual
250 tilde expansion happens to such a string: `~/`
251 is expanded to the value of `$HOME`, and `~user/` to the
252 specified user's home directory.
255 Variables
256 ~~~~~~~~~
258 Note that this list is non-comprehensive and not necessarily complete.
259 For command-specific variables, you will find a more detailed description
260 in the appropriate manual page.
262 Other git-related tools may and do use their own variables. When
263 inventing new variables for use in your own tool, make sure their
264 names do not conflict with those that are used by Git itself and
265 other popular tools, and describe them in your documentation.
268 advice.*::
269 These variables control various optional help messages designed to
270 aid new users. All 'advice.*' variables default to 'true', and you
271 can tell Git that you do not need help by setting these to 'false':
272 +
273 --
274 pushUpdateRejected::
275 Set this variable to 'false' if you want to disable
276 'pushNonFFCurrent',
277 'pushNonFFMatching', 'pushAlreadyExists',
278 'pushFetchFirst', and 'pushNeedsForce'
279 simultaneously.
280 pushNonFFCurrent::
281 Advice shown when linkgit:git-push[1] fails due to a
282 non-fast-forward update to the current branch.
283 pushNonFFMatching::
284 Advice shown when you ran linkgit:git-push[1] and pushed
285 'matching refs' explicitly (i.e. you used ':', or
286 specified a refspec that isn't your current branch) and
287 it resulted in a non-fast-forward error.
288 pushAlreadyExists::
289 Shown when linkgit:git-push[1] rejects an update that
290 does not qualify for fast-forwarding (e.g., a tag.)
291 pushFetchFirst::
292 Shown when linkgit:git-push[1] rejects an update that
293 tries to overwrite a remote ref that points at an
294 object we do not have.
295 pushNeedsForce::
296 Shown when linkgit:git-push[1] rejects an update that
297 tries to overwrite a remote ref that points at an
298 object that is not a commit-ish, or make the remote
299 ref point at an object that is not a commit-ish.
300 statusHints::
301 Show directions on how to proceed from the current
302 state in the output of linkgit:git-status[1], in
303 the template shown when writing commit messages in
304 linkgit:git-commit[1], and in the help message shown
305 by linkgit:git-checkout[1] when switching branch.
306 statusUoption::
307 Advise to consider using the `-u` option to linkgit:git-status[1]
308 when the command takes more than 2 seconds to enumerate untracked
309 files.
310 commitBeforeMerge::
311 Advice shown when linkgit:git-merge[1] refuses to
312 merge to avoid overwriting local changes.
313 resolveConflict::
314 Advice shown by various commands when conflicts
315 prevent the operation from being performed.
316 implicitIdentity::
317 Advice on how to set your identity configuration when
318 your information is guessed from the system username and
319 domain name.
320 detachedHead::
321 Advice shown when you used linkgit:git-checkout[1] to
322 move to the detach HEAD state, to instruct how to create
323 a local branch after the fact.
324 amWorkDir::
325 Advice that shows the location of the patch file when
326 linkgit:git-am[1] fails to apply it.
327 rmHints::
328 In case of failure in the output of linkgit:git-rm[1],
329 show directions on how to proceed from the current state.
330 --
332 core.fileMode::
333 Tells Git if the executable bit of files in the working tree
334 is to be honored.
335 +
336 Some filesystems lose the executable bit when a file that is
337 marked as executable is checked out, or checks out an
338 non-executable file with executable bit on.
339 linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
340 to see if it handles the executable bit correctly
341 and this variable is automatically set as necessary.
342 +
343 A repository, however, may be on a filesystem that handles
344 the filemode correctly, and this variable is set to 'true'
345 when created, but later may be made accessible from another
346 environment that loses the filemode (e.g. exporting ext4 via
347 CIFS mount, visiting a Cygwin created repository with
348 Git for Windows or Eclipse).
349 In such a case it may be necessary to set this variable to 'false'.
350 See linkgit:git-update-index[1].
351 +
352 The default is true (when core.filemode is not specified in the config file).
354 core.hideDotFiles::
355 (Windows-only) If true, mark newly-created directories and files whose
356 name starts with a dot as hidden. If 'dotGitOnly', only the `.git/`
357 directory is hidden, but no other files starting with a dot. The
358 default mode is 'dotGitOnly'.
360 core.ignoreCase::
361 If true, this option enables various workarounds to enable
362 Git to work better on filesystems that are not case sensitive,
363 like FAT. For example, if a directory listing finds
364 "makefile" when Git expects "Makefile", Git will assume
365 it is really the same file, and continue to remember it as
366 "Makefile".
367 +
368 The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
369 will probe and set core.ignoreCase true if appropriate when the repository
370 is created.
372 core.precomposeUnicode::
373 This option is only used by Mac OS implementation of Git.
374 When core.precomposeUnicode=true, Git reverts the unicode decomposition
375 of filenames done by Mac OS. This is useful when sharing a repository
376 between Mac OS and Linux or Windows.
377 (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
378 When false, file names are handled fully transparent by Git,
379 which is backward compatible with older versions of Git.
381 core.protectHFS::
382 If set to true, do not allow checkout of paths that would
383 be considered equivalent to `.git` on an HFS+ filesystem.
384 Defaults to `true` on Mac OS, and `false` elsewhere.
386 core.protectNTFS::
387 If set to true, do not allow checkout of paths that would
388 cause problems with the NTFS filesystem, e.g. conflict with
389 8.3 "short" names.
390 Defaults to `true` on Windows, and `false` elsewhere.
392 core.trustctime::
393 If false, the ctime differences between the index and the
394 working tree are ignored; useful when the inode change time
395 is regularly modified by something outside Git (file system
396 crawlers and some backup systems).
397 See linkgit:git-update-index[1]. True by default.
399 core.untrackedCache::
400 Determines what to do about the untracked cache feature of the
401 index. It will be kept, if this variable is unset or set to
402 `keep`. It will automatically be added if set to `true`. And
403 it will automatically be removed, if set to `false`. Before
404 setting it to `true`, you should check that mtime is working
405 properly on your system.
406 See linkgit:git-update-index[1]. `keep` by default.
408 core.checkStat::
409 Determines which stat fields to match between the index
410 and work tree. The user can set this to 'default' or
411 'minimal'. Default (or explicitly 'default'), is to check
412 all fields, including the sub-second part of mtime and ctime.
414 core.quotePath::
415 The commands that output paths (e.g. 'ls-files',
416 'diff'), when not given the `-z` option, will quote
417 "unusual" characters in the pathname by enclosing the
418 pathname in a double-quote pair and with backslashes the
419 same way strings in C source code are quoted. If this
420 variable is set to false, the bytes higher than 0x80 are
421 not quoted but output as verbatim. Note that double
422 quote, backslash and control characters are always
423 quoted without `-z` regardless of the setting of this
424 variable.
426 core.eol::
427 Sets the line ending type to use in the working directory for
428 files that have the `text` property set when core.autocrlf is false.
429 Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
430 native line ending. The default value is `native`. See
431 linkgit:gitattributes[5] for more information on end-of-line
432 conversion.
434 core.safecrlf::
435 If true, makes Git check if converting `CRLF` is reversible when
436 end-of-line conversion is active. Git will verify if a command
437 modifies a file in the work tree either directly or indirectly.
438 For example, committing a file followed by checking out the
439 same file should yield the original file in the work tree. If
440 this is not the case for the current setting of
441 `core.autocrlf`, Git will reject the file. The variable can
442 be set to "warn", in which case Git will only warn about an
443 irreversible conversion but continue the operation.
444 +
445 CRLF conversion bears a slight chance of corrupting data.
446 When it is enabled, Git will convert CRLF to LF during commit and LF to
447 CRLF during checkout. A file that contains a mixture of LF and
448 CRLF before the commit cannot be recreated by Git. For text
449 files this is the right thing to do: it corrects line endings
450 such that we have only LF line endings in the repository.
451 But for binary files that are accidentally classified as text the
452 conversion can corrupt data.
453 +
454 If you recognize such corruption early you can easily fix it by
455 setting the conversion type explicitly in .gitattributes. Right
456 after committing you still have the original file in your work
457 tree and this file is not yet corrupted. You can explicitly tell
458 Git that this file is binary and Git will handle the file
459 appropriately.
460 +
461 Unfortunately, the desired effect of cleaning up text files with
462 mixed line endings and the undesired effect of corrupting binary
463 files cannot be distinguished. In both cases CRLFs are removed
464 in an irreversible way. For text files this is the right thing
465 to do because CRLFs are line endings, while for binary files
466 converting CRLFs corrupts data.
467 +
468 Note, this safety check does not mean that a checkout will generate a
469 file identical to the original file for a different setting of
470 `core.eol` and `core.autocrlf`, but only for the current one. For
471 example, a text file with `LF` would be accepted with `core.eol=lf`
472 and could later be checked out with `core.eol=crlf`, in which case the
473 resulting file would contain `CRLF`, although the original file
474 contained `LF`. However, in both work trees the line endings would be
475 consistent, that is either all `LF` or all `CRLF`, but never mixed. A
476 file with mixed line endings would be reported by the `core.safecrlf`
477 mechanism.
479 core.autocrlf::
480 Setting this variable to "true" is the same as setting
481 the `text` attribute to "auto" on all files and core.eol to "crlf".
482 Set to true if you want to have `CRLF` line endings in your
483 working directory and the repository has LF line endings.
484 This variable can be set to 'input',
485 in which case no output conversion is performed.
487 core.symlinks::
488 If false, symbolic links are checked out as small plain files that
489 contain the link text. linkgit:git-update-index[1] and
490 linkgit:git-add[1] will not change the recorded type to regular
491 file. Useful on filesystems like FAT that do not support
492 symbolic links.
493 +
494 The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
495 will probe and set core.symlinks false if appropriate when the repository
496 is created.
498 core.gitProxy::
499 A "proxy command" to execute (as 'command host port') instead
500 of establishing direct connection to the remote server when
501 using the Git protocol for fetching. If the variable value is
502 in the "COMMAND for DOMAIN" format, the command is applied only
503 on hostnames ending with the specified domain string. This variable
504 may be set multiple times and is matched in the given order;
505 the first match wins.
506 +
507 Can be overridden by the `GIT_PROXY_COMMAND` environment variable
508 (which always applies universally, without the special "for"
509 handling).
510 +
511 The special string `none` can be used as the proxy command to
512 specify that no proxy be used for a given domain pattern.
513 This is useful for excluding servers inside a firewall from
514 proxy use, while defaulting to a common proxy for external domains.
516 core.sshCommand::
517 If this variable is set, `git fetch` and `git push` will
518 use the specified command instead of `ssh` when they need to
519 connect to a remote system. The command is in the same form as
520 the `GIT_SSH_COMMAND` environment variable and is overridden
521 when the environment variable is set.
523 core.ignoreStat::
524 If true, Git will avoid using lstat() calls to detect if files have
525 changed by setting the "assume-unchanged" bit for those tracked files
526 which it has updated identically in both the index and working tree.
527 +
528 When files are modified outside of Git, the user will need to stage
529 the modified files explicitly (e.g. see 'Examples' section in
530 linkgit:git-update-index[1]).
531 Git will not normally detect changes to those files.
532 +
533 This is useful on systems where lstat() calls are very slow, such as
534 CIFS/Microsoft Windows.
535 +
536 False by default.
538 core.preferSymlinkRefs::
539 Instead of the default "symref" format for HEAD
540 and other symbolic reference files, use symbolic links.
541 This is sometimes needed to work with old scripts that
542 expect HEAD to be a symbolic link.
544 core.bare::
545 If true this repository is assumed to be 'bare' and has no
546 working directory associated with it. If this is the case a
547 number of commands that require a working directory will be
548 disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
549 +
550 This setting is automatically guessed by linkgit:git-clone[1] or
551 linkgit:git-init[1] when the repository was created. By default a
552 repository that ends in "/.git" is assumed to be not bare (bare =
553 false), while all other repositories are assumed to be bare (bare
554 = true).
556 core.worktree::
557 Set the path to the root of the working tree.
558 If `GIT_COMMON_DIR` environment variable is set, core.worktree
559 is ignored and not used for determining the root of working tree.
560 This can be overridden by the `GIT_WORK_TREE` environment
561 variable and the `--work-tree` command-line option.
562 The value can be an absolute path or relative to the path to
563 the .git directory, which is either specified by --git-dir
564 or GIT_DIR, or automatically discovered.
565 If --git-dir or GIT_DIR is specified but none of
566 --work-tree, GIT_WORK_TREE and core.worktree is specified,
567 the current working directory is regarded as the top level
568 of your working tree.
569 +
570 Note that this variable is honored even when set in a configuration
571 file in a ".git" subdirectory of a directory and its value differs
572 from the latter directory (e.g. "/path/to/.git/config" has
573 core.worktree set to "/different/path"), which is most likely a
574 misconfiguration. Running Git commands in the "/path/to" directory will
575 still use "/different/path" as the root of the work tree and can cause
576 confusion unless you know what you are doing (e.g. you are creating a
577 read-only snapshot of the same index to a location different from the
578 repository's usual working tree).
580 core.logAllRefUpdates::
581 Enable the reflog. Updates to a ref <ref> is logged to the file
582 "`$GIT_DIR/logs/<ref>`", by appending the new and old
583 SHA-1, the date/time and the reason of the update, but
584 only when the file exists. If this configuration
585 variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
586 file is automatically created for branch heads (i.e. under
587 `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
588 note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
589 If it is set to `always`, then a missing reflog is automatically
590 created for any ref under `refs/`.
591 +
592 This information can be used to determine what commit
593 was the tip of a branch "2 days ago".
594 +
595 This value is true by default in a repository that has
596 a working directory associated with it, and false by
597 default in a bare repository.
599 core.repositoryFormatVersion::
600 Internal variable identifying the repository format and layout
601 version.
603 core.sharedRepository::
604 When 'group' (or 'true'), the repository is made shareable between
605 several users in a group (making sure all the files and objects are
606 group-writable). When 'all' (or 'world' or 'everybody'), the
607 repository will be readable by all users, additionally to being
608 group-shareable. When 'umask' (or 'false'), Git will use permissions
609 reported by umask(2). When '0xxx', where '0xxx' is an octal number,
610 files in the repository will have this mode value. '0xxx' will override
611 user's umask value (whereas the other options will only override
612 requested parts of the user's umask value). Examples: '0660' will make
613 the repo read/write-able for the owner and group, but inaccessible to
614 others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
615 repository that is group-readable but not group-writable.
616 See linkgit:git-init[1]. False by default.
618 core.warnAmbiguousRefs::
619 If true, Git will warn you if the ref name you passed it is ambiguous
620 and might match multiple refs in the repository. True by default.
622 core.compression::
623 An integer -1..9, indicating a default compression level.
624 -1 is the zlib default. 0 means no compression,
625 and 1..9 are various speed/size tradeoffs, 9 being slowest.
626 If set, this provides a default to other compression variables,
627 such as `core.looseCompression` and `pack.compression`.
629 core.looseCompression::
630 An integer -1..9, indicating the compression level for objects that
631 are not in a pack file. -1 is the zlib default. 0 means no
632 compression, and 1..9 are various speed/size tradeoffs, 9 being
633 slowest. If not set, defaults to core.compression. If that is
634 not set, defaults to 1 (best speed).
636 core.packedGitWindowSize::
637 Number of bytes of a pack file to map into memory in a
638 single mapping operation. Larger window sizes may allow
639 your system to process a smaller number of large pack files
640 more quickly. Smaller window sizes will negatively affect
641 performance due to increased calls to the operating system's
642 memory manager, but may improve performance when accessing
643 a large number of large pack files.
644 +
645 Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
646 MiB on 32 bit platforms and 1 GiB on 64 bit platforms. This should
647 be reasonable for all users/operating systems. You probably do
648 not need to adjust this value.
649 +
650 Common unit suffixes of 'k', 'm', or 'g' are supported.
652 core.packedGitLimit::
653 Maximum number of bytes to map simultaneously into memory
654 from pack files. If Git needs to access more than this many
655 bytes at once to complete an operation it will unmap existing
656 regions to reclaim virtual address space within the process.
657 +
658 Default is 256 MiB on 32 bit platforms and 8 GiB on 64 bit platforms.
659 This should be reasonable for all users/operating systems, except on
660 the largest projects. You probably do not need to adjust this value.
661 +
662 Common unit suffixes of 'k', 'm', or 'g' are supported.
664 core.deltaBaseCacheLimit::
665 Maximum number of bytes to reserve for caching base objects
666 that may be referenced by multiple deltified objects. By storing the
667 entire decompressed base objects in a cache Git is able
668 to avoid unpacking and decompressing frequently used base
669 objects multiple times.
670 +
671 Default is 96 MiB on all platforms. This should be reasonable
672 for all users/operating systems, except on the largest projects.
673 You probably do not need to adjust this value.
674 +
675 Common unit suffixes of 'k', 'm', or 'g' are supported.
677 core.bigFileThreshold::
678 Files larger than this size are stored deflated, without
679 attempting delta compression. Storing large files without
680 delta compression avoids excessive memory usage, at the
681 slight expense of increased disk usage. Additionally files
682 larger than this size are always treated as binary.
683 +
684 Default is 512 MiB on all platforms. This should be reasonable
685 for most projects as source code and other text files can still
686 be delta compressed, but larger binary media files won't be.
687 +
688 Common unit suffixes of 'k', 'm', or 'g' are supported.
690 core.excludesFile::
691 Specifies the pathname to the file that contains patterns to
692 describe paths that are not meant to be tracked, in addition
693 to '.gitignore' (per-directory) and '.git/info/exclude'.
694 Defaults to `$XDG_CONFIG_HOME/git/ignore`.
695 If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
696 is used instead. See linkgit:gitignore[5].
698 core.askPass::
699 Some commands (e.g. svn and http interfaces) that interactively
700 ask for a password can be told to use an external program given
701 via the value of this variable. Can be overridden by the `GIT_ASKPASS`
702 environment variable. If not set, fall back to the value of the
703 `SSH_ASKPASS` environment variable or, failing that, a simple password
704 prompt. The external program shall be given a suitable prompt as
705 command-line argument and write the password on its STDOUT.
707 core.attributesFile::
708 In addition to '.gitattributes' (per-directory) and
709 '.git/info/attributes', Git looks into this file for attributes
710 (see linkgit:gitattributes[5]). Path expansions are made the same
711 way as for `core.excludesFile`. Its default value is
712 `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
713 set or empty, `$HOME/.config/git/attributes` is used instead.
715 core.hooksPath::
716 By default Git will look for your hooks in the
717 '$GIT_DIR/hooks' directory. Set this to different path,
718 e.g. '/etc/git/hooks', and Git will try to find your hooks in
719 that directory, e.g. '/etc/git/hooks/pre-receive' instead of
720 in '$GIT_DIR/hooks/pre-receive'.
721 +
722 The path can be either absolute or relative. A relative path is
723 taken as relative to the directory where the hooks are run (see
724 the "DESCRIPTION" section of linkgit:githooks[5]).
725 +
726 This configuration variable is useful in cases where you'd like to
727 centrally configure your Git hooks instead of configuring them on a
728 per-repository basis, or as a more flexible and centralized
729 alternative to having an `init.templateDir` where you've changed
730 default hooks.
732 core.editor::
733 Commands such as `commit` and `tag` that lets you edit
734 messages by launching an editor uses the value of this
735 variable when it is set, and the environment variable
736 `GIT_EDITOR` is not set. See linkgit:git-var[1].
738 core.commentChar::
739 Commands such as `commit` and `tag` that lets you edit
740 messages consider a line that begins with this character
741 commented, and removes them after the editor returns
742 (default '#').
743 +
744 If set to "auto", `git-commit` would select a character that is not
745 the beginning character of any line in existing commit messages.
747 core.packedRefsTimeout::
748 The length of time, in milliseconds, to retry when trying to
749 lock the `packed-refs` file. Value 0 means not to retry at
750 all; -1 means to try indefinitely. Default is 1000 (i.e.,
751 retry for 1 second).
753 sequence.editor::
754 Text editor used by `git rebase -i` for editing the rebase instruction file.
755 The value is meant to be interpreted by the shell when it is used.
756 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
757 When not configured the default commit message editor is used instead.
759 core.pager::
760 Text viewer for use by Git commands (e.g., 'less'). The value
761 is meant to be interpreted by the shell. The order of preference
762 is the `$GIT_PAGER` environment variable, then `core.pager`
763 configuration, then `$PAGER`, and then the default chosen at
764 compile time (usually 'less').
765 +
766 When the `LESS` environment variable is unset, Git sets it to `FRX`
767 (if `LESS` environment variable is set, Git does not change it at
768 all). If you want to selectively override Git's default setting
769 for `LESS`, you can set `core.pager` to e.g. `less -S`. This will
770 be passed to the shell by Git, which will translate the final
771 command to `LESS=FRX less -S`. The environment does not set the
772 `S` option but the command line does, instructing less to truncate
773 long lines. Similarly, setting `core.pager` to `less -+F` will
774 deactivate the `F` option specified by the environment from the
775 command-line, deactivating the "quit if one screen" behavior of
776 `less`. One can specifically activate some flags for particular
777 commands: for example, setting `pager.blame` to `less -S` enables
778 line truncation only for `git blame`.
779 +
780 Likewise, when the `LV` environment variable is unset, Git sets it
781 to `-c`. You can override this setting by exporting `LV` with
782 another value or setting `core.pager` to `lv +c`.
784 core.whitespace::
785 A comma separated list of common whitespace problems to
786 notice. 'git diff' will use `color.diff.whitespace` to
787 highlight them, and 'git apply --whitespace=error' will
788 consider them as errors. You can prefix `-` to disable
789 any of them (e.g. `-trailing-space`):
790 +
791 * `blank-at-eol` treats trailing whitespaces at the end of the line
792 as an error (enabled by default).
793 * `space-before-tab` treats a space character that appears immediately
794 before a tab character in the initial indent part of the line as an
795 error (enabled by default).
796 * `indent-with-non-tab` treats a line that is indented with space
797 characters instead of the equivalent tabs as an error (not enabled by
798 default).
799 * `tab-in-indent` treats a tab character in the initial indent part of
800 the line as an error (not enabled by default).
801 * `blank-at-eof` treats blank lines added at the end of file as an error
802 (enabled by default).
803 * `trailing-space` is a short-hand to cover both `blank-at-eol` and
804 `blank-at-eof`.
805 * `cr-at-eol` treats a carriage-return at the end of line as
806 part of the line terminator, i.e. with it, `trailing-space`
807 does not trigger if the character before such a carriage-return
808 is not a whitespace (not enabled by default).
809 * `tabwidth=<n>` tells how many character positions a tab occupies; this
810 is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
811 errors. The default tab width is 8. Allowed values are 1 to 63.
813 core.fsyncObjectFiles::
814 This boolean will enable 'fsync()' when writing object files.
815 +
816 This is a total waste of time and effort on a filesystem that orders
817 data writes properly, but can be useful for filesystems that do not use
818 journalling (traditional UNIX filesystems) or that only journal metadata
819 and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
821 core.preloadIndex::
822 Enable parallel index preload for operations like 'git diff'
823 +
824 This can speed up operations like 'git diff' and 'git status' especially
825 on filesystems like NFS that have weak caching semantics and thus
826 relatively high IO latencies. When enabled, Git will do the
827 index comparison to the filesystem data in parallel, allowing
828 overlapping IO's. Defaults to true.
830 core.createObject::
831 You can set this to 'link', in which case a hardlink followed by
832 a delete of the source are used to make sure that object creation
833 will not overwrite existing objects.
834 +
835 On some file system/operating system combinations, this is unreliable.
836 Set this config setting to 'rename' there; However, This will remove the
837 check that makes sure that existing object files will not get overwritten.
839 core.notesRef::
840 When showing commit messages, also show notes which are stored in
841 the given ref. The ref must be fully qualified. If the given
842 ref does not exist, it is not an error but means that no
843 notes should be printed.
844 +
845 This setting defaults to "refs/notes/commits", and it can be overridden by
846 the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1].
848 core.sparseCheckout::
849 Enable "sparse checkout" feature. See section "Sparse checkout" in
850 linkgit:git-read-tree[1] for more information.
852 core.abbrev::
853 Set the length object names are abbreviated to. If
854 unspecified or set to "auto", an appropriate value is
855 computed based on the approximate number of packed objects
856 in your repository, which hopefully is enough for
857 abbreviated object names to stay unique for some time.
859 add.ignoreErrors::
860 add.ignore-errors (deprecated)::
861 Tells 'git add' to continue adding files when some files cannot be
862 added due to indexing errors. Equivalent to the `--ignore-errors`
863 option of linkgit:git-add[1]. `add.ignore-errors` is deprecated,
864 as it does not follow the usual naming convention for configuration
865 variables.
867 alias.*::
868 Command aliases for the linkgit:git[1] command wrapper - e.g.
869 after defining "alias.last = cat-file commit HEAD", the invocation
870 "git last" is equivalent to "git cat-file commit HEAD". To avoid
871 confusion and troubles with script usage, aliases that
872 hide existing Git commands are ignored. Arguments are split by
873 spaces, the usual shell quoting and escaping is supported.
874 A quote pair or a backslash can be used to quote them.
875 +
876 If the alias expansion is prefixed with an exclamation point,
877 it will be treated as a shell command. For example, defining
878 " = !gitk --all --not ORIG_HEAD", the invocation
879 "git new" is equivalent to running the shell command
880 "gitk --all --not ORIG_HEAD". Note that shell commands will be
881 executed from the top-level directory of a repository, which may
882 not necessarily be the current directory.
883 `GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
884 from the original current directory. See linkgit:git-rev-parse[1].
886 am.keepcr::
887 If true, git-am will call git-mailsplit for patches in mbox format
888 with parameter `--keep-cr`. In this case git-mailsplit will
889 not remove `\r` from lines ending with `\r\n`. Can be overridden
890 by giving `--no-keep-cr` from the command line.
891 See linkgit:git-am[1], linkgit:git-mailsplit[1].
893 am.threeWay::
894 By default, `git am` will fail if the patch does not apply cleanly. When
895 set to true, this setting tells `git am` to fall back on 3-way merge if
896 the patch records the identity of blobs it is supposed to apply to and
897 we have those blobs available locally (equivalent to giving the `--3way`
898 option from the command line). Defaults to `false`.
899 See linkgit:git-am[1].
901 apply.ignoreWhitespace::
902 When set to 'change', tells 'git apply' to ignore changes in
903 whitespace, in the same way as the `--ignore-space-change`
904 option.
905 When set to one of: no, none, never, false tells 'git apply' to
906 respect all whitespace differences.
907 See linkgit:git-apply[1].
909 apply.whitespace::
910 Tells 'git apply' how to handle whitespaces, in the same way
911 as the `--whitespace` option. See linkgit:git-apply[1].
913 branch.autoSetupMerge::
914 Tells 'git branch' and 'git checkout' to set up new branches
915 so that linkgit:git-pull[1] will appropriately merge from the
916 starting point branch. Note that even if this option is not set,
917 this behavior can be chosen per-branch using the `--track`
918 and `--no-track` options. The valid settings are: `false` -- no
919 automatic setup is done; `true` -- automatic setup is done when the
920 starting point is a remote-tracking branch; `always` --
921 automatic setup is done when the starting point is either a
922 local branch or remote-tracking
923 branch. This option defaults to true.
925 branch.autoSetupRebase::
926 When a new branch is created with 'git branch' or 'git checkout'
927 that tracks another branch, this variable tells Git to set
928 up pull to rebase instead of merge (see "branch.<name>.rebase").
929 When `never`, rebase is never automatically set to true.
930 When `local`, rebase is set to true for tracked branches of
931 other local branches.
932 When `remote`, rebase is set to true for tracked branches of
933 remote-tracking branches.
934 When `always`, rebase will be set to true for all tracking
935 branches.
936 See "branch.autoSetupMerge" for details on how to set up a
937 branch to track another branch.
938 This option defaults to never.
940 branch.<name>.remote::
941 When on branch <name>, it tells 'git fetch' and 'git push'
942 which remote to fetch from/push to. The remote to push to
943 may be overridden with `remote.pushDefault` (for all branches).
944 The remote to push to, for the current branch, may be further
945 overridden by `branch.<name>.pushRemote`. If no remote is
946 configured, or if you are not on any branch, it defaults to
947 `origin` for fetching and `remote.pushDefault` for pushing.
948 Additionally, `.` (a period) is the current local repository
949 (a dot-repository), see `branch.<name>.merge`'s final note below.
951 branch.<name>.pushRemote::
952 When on branch <name>, it overrides `branch.<name>.remote` for
953 pushing. It also overrides `remote.pushDefault` for pushing
954 from branch <name>. When you pull from one place (e.g. your
955 upstream) and push to another place (e.g. your own publishing
956 repository), you would want to set `remote.pushDefault` to
957 specify the remote to push to for all branches, and use this
958 option to override it for a specific branch.
960 branch.<name>.merge::
961 Defines, together with branch.<name>.remote, the upstream branch
962 for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
963 branch to merge and can also affect 'git push' (see push.default).
964 When in branch <name>, it tells 'git fetch' the default
965 refspec to be marked for merging in FETCH_HEAD. The value is
966 handled like the remote part of a refspec, and must match a
967 ref which is fetched from the remote given by
968 "branch.<name>.remote".
969 The merge information is used by 'git pull' (which at first calls
970 'git fetch') to lookup the default branch for merging. Without
971 this option, 'git pull' defaults to merge the first refspec fetched.
972 Specify multiple values to get an octopus merge.
973 If you wish to setup 'git pull' so that it merges into <name> from
974 another branch in the local repository, you can point
975 branch.<name>.merge to the desired branch, and use the relative path
976 setting `.` (a period) for branch.<name>.remote.
978 branch.<name>.mergeOptions::
979 Sets default options for merging into branch <name>. The syntax and
980 supported options are the same as those of linkgit:git-merge[1], but
981 option values containing whitespace characters are currently not
982 supported.
984 branch.<name>.rebase::
985 When true, rebase the branch <name> on top of the fetched branch,
986 instead of merging the default branch from the default remote when
987 "git pull" is run. See "pull.rebase" for doing this in a non
988 branch-specific manner.
989 +
990 When preserve, also pass `--preserve-merges` along to 'git rebase'
991 so that locally committed merge commits will not be flattened
992 by running 'git pull'.
993 +
994 When the value is `interactive`, the rebase is run in interactive mode.
995 +
996 *NOTE*: this is a possibly dangerous operation; do *not* use
997 it unless you understand the implications (see linkgit:git-rebase[1]
998 for details).
1000 branch.<name>.description::
1001 Branch description, can be edited with
1002 `git branch --edit-description`. Branch description is
1003 automatically added in the format-patch cover letter or
1004 request-pull summary.
1006 browser.<tool>.cmd::
1007 Specify the command to invoke the specified browser. The
1008 specified command is evaluated in shell with the URLs passed
1009 as arguments. (See linkgit:git-web{litdd}browse[1].)
1011 browser.<tool>.path::
1012 Override the path for the given tool that may be used to
1013 browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1014 working repository in gitweb (see linkgit:git-instaweb[1]).
1016 clean.requireForce::
1017 A boolean to make git-clean do nothing unless given -f,
1018 -i or -n. Defaults to true.
1020 color.branch::
1021 A boolean to enable/disable color in the output of
1022 linkgit:git-branch[1]. May be set to `always`,
1023 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1024 only when the output is to a terminal. If unset, then the
1025 value of `color.ui` is used (`auto` by default).
1027 color.branch.<slot>::
1028 Use customized color for branch coloration. `<slot>` is one of
1029 `current` (the current branch), `local` (a local branch),
1030 `remote` (a remote-tracking branch in refs/remotes/),
1031 `upstream` (upstream tracking branch), `plain` (other
1032 refs).
1034 color.diff::
1035 Whether to use ANSI escape sequences to add color to patches.
1036 If this is set to `always`, linkgit:git-diff[1],
1037 linkgit:git-log[1], and linkgit:git-show[1] will use color
1038 for all patches. If it is set to `true` or `auto`, those
1039 commands will only use color when output is to the terminal.
1040 If unset, then the value of `color.ui` is used (`auto` by
1041 default).
1042 +
1043 This does not affect linkgit:git-format-patch[1] or the
1044 'git-diff-{asterisk}' plumbing commands. Can be overridden on the
1045 command line with the `--color[=<when>]` option.
1047 color.diff.<slot>::
1048 Use customized color for diff colorization. `<slot>` specifies
1049 which part of the patch to use the specified color, and is one
1050 of `context` (context text - `plain` is a historical synonym),
1051 `meta` (metainformation), `frag`
1052 (hunk header), 'func' (function in hunk header), `old` (removed lines),
1053 `new` (added lines), `commit` (commit headers), or `whitespace`
1054 (highlighting whitespace errors).
1056 color.decorate.<slot>::
1057 Use customized color for 'git log --decorate' output. `<slot>` is one
1058 of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1059 branches, remote-tracking branches, tags, stash and HEAD, respectively.
1061 color.grep::
1062 When set to `always`, always highlight matches. When `false` (or
1063 `never`), never. When set to `true` or `auto`, use color only
1064 when the output is written to the terminal. If unset, then the
1065 value of `color.ui` is used (`auto` by default).
1067 color.grep.<slot>::
1068 Use customized color for grep colorization. `<slot>` specifies which
1069 part of the line to use the specified color, and is one of
1070 +
1071 --
1072 `context`;;
1073 non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1074 `filename`;;
1075 filename prefix (when not using `-h`)
1076 `function`;;
1077 function name lines (when using `-p`)
1078 `linenumber`;;
1079 line number prefix (when using `-n`)
1080 `match`;;
1081 matching text (same as setting `matchContext` and `matchSelected`)
1082 `matchContext`;;
1083 matching text in context lines
1084 `matchSelected`;;
1085 matching text in selected lines
1086 `selected`;;
1087 non-matching text in selected lines
1088 `separator`;;
1089 separators between fields on a line (`:`, `-`, and `=`)
1090 and between hunks (`--`)
1091 --
1093 color.interactive::
1094 When set to `always`, always use colors for interactive prompts
1095 and displays (such as those used by "git-add --interactive" and
1096 "git-clean --interactive"). When false (or `never`), never.
1097 When set to `true` or `auto`, use colors only when the output is
1098 to the terminal. If unset, then the value of `color.ui` is
1099 used (`auto` by default).
1101 color.interactive.<slot>::
1102 Use customized color for 'git add --interactive' and 'git clean
1103 --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1104 or `error`, for four distinct types of normal output from
1105 interactive commands.
1107 color.pager::
1108 A boolean to enable/disable colored output when the pager is in
1109 use (default is true).
1111 color.showBranch::
1112 A boolean to enable/disable color in the output of
1113 linkgit:git-show-branch[1]. May be set to `always`,
1114 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1115 only when the output is to a terminal. If unset, then the
1116 value of `color.ui` is used (`auto` by default).
1118 color.status::
1119 A boolean to enable/disable color in the output of
1120 linkgit:git-status[1]. May be set to `always`,
1121 `false` (or `never`) or `auto` (or `true`), in which case colors are used
1122 only when the output is to a terminal. If unset, then the
1123 value of `color.ui` is used (`auto` by default).
1125 color.status.<slot>::
1126 Use customized color for status colorization. `<slot>` is
1127 one of `header` (the header text of the status message),
1128 `added` or `updated` (files which are added but not committed),
1129 `changed` (files which are changed but not added in the index),
1130 `untracked` (files which are not tracked by Git),
1131 `branch` (the current branch),
1132 `nobranch` (the color the 'no branch' warning is shown in, defaulting
1133 to red), or
1134 `unmerged` (files which have unmerged changes).
1136 color.ui::
1137 This variable determines the default value for variables such
1138 as `color.diff` and `color.grep` that control the use of color
1139 per command family. Its scope will expand as more commands learn
1140 configuration to set a default for the `--color` option. Set it
1141 to `false` or `never` if you prefer Git commands not to use
1142 color unless enabled explicitly with some other configuration
1143 or the `--color` option. Set it to `always` if you want all
1144 output not intended for machine consumption to use color, to
1145 `true` or `auto` (this is the default since Git 1.8.4) if you
1146 want such output to use color when written to the terminal.
1148 column.ui::
1149 Specify whether supported commands should output in columns.
1150 This variable consists of a list of tokens separated by spaces
1151 or commas:
1152 +
1153 These options control when the feature should be enabled
1154 (defaults to 'never'):
1155 +
1156 --
1157 `always`;;
1158 always show in columns
1159 `never`;;
1160 never show in columns
1161 `auto`;;
1162 show in columns if the output is to the terminal
1163 --
1164 +
1165 These options control layout (defaults to 'column'). Setting any
1166 of these implies 'always' if none of 'always', 'never', or 'auto' are
1167 specified.
1168 +
1169 --
1170 `column`;;
1171 fill columns before rows
1172 `row`;;
1173 fill rows before columns
1174 `plain`;;
1175 show in one column
1176 --
1177 +
1178 Finally, these options can be combined with a layout option (defaults
1179 to 'nodense'):
1180 +
1181 --
1182 `dense`;;
1183 make unequal size columns to utilize more space
1184 `nodense`;;
1185 make equal size columns
1186 --
1188 column.branch::
1189 Specify whether to output branch listing in `git branch` in columns.
1190 See `column.ui` for details.
1192 column.clean::
1193 Specify the layout when list items in `git clean -i`, which always
1194 shows files and directories in columns. See `column.ui` for details.
1196 column.status::
1197 Specify whether to output untracked files in `git status` in columns.
1198 See `column.ui` for details.
1200 column.tag::
1201 Specify whether to output tag listing in `git tag` in columns.
1202 See `column.ui` for details.
1204 commit.cleanup::
1205 This setting overrides the default of the `--cleanup` option in
1206 `git commit`. See linkgit:git-commit[1] for details. Changing the
1207 default can be useful when you always want to keep lines that begin
1208 with comment character `#` in your log message, in which case you
1209 would do `git config commit.cleanup whitespace` (note that you will
1210 have to remove the help lines that begin with `#` in the commit log
1211 template yourself, if you do this).
1213 commit.gpgSign::
1215 A boolean to specify whether all commits should be GPG signed.
1216 Use of this option when doing operations such as rebase can
1217 result in a large number of commits being signed. It may be
1218 convenient to use an agent to avoid typing your GPG passphrase
1219 several times.
1221 commit.status::
1222 A boolean to enable/disable inclusion of status information in the
1223 commit message template when using an editor to prepare the commit
1224 message. Defaults to true.
1226 commit.template::
1227 Specify the pathname of a file to use as the template for
1228 new commit messages.
1230 commit.verbose::
1231 A boolean or int to specify the level of verbose with `git commit`.
1232 See linkgit:git-commit[1].
1234 credential.helper::
1235 Specify an external helper to be called when a username or
1236 password credential is needed; the helper may consult external
1237 storage to avoid prompting the user for the credentials. Note
1238 that multiple helpers may be defined. See linkgit:gitcredentials[7]
1239 for details.
1241 credential.useHttpPath::
1242 When acquiring credentials, consider the "path" component of an http
1243 or https URL to be important. Defaults to false. See
1244 linkgit:gitcredentials[7] for more information.
1246 credential.username::
1247 If no username is set for a network authentication, use this username
1248 by default. See credential.<context>.* below, and
1249 linkgit:gitcredentials[7].
1251 credential.<url>.*::
1252 Any of the credential.* options above can be applied selectively to
1253 some credentials. For example "credential."
1254 would set the default username only for https connections to
1255 See linkgit:gitcredentials[7] for details on how URLs are
1256 matched.
1258 credentialCache.ignoreSIGHUP::
1259 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1261 include::diff-config.txt[]
1263 difftool.<tool>.path::
1264 Override the path for the given tool. This is useful in case
1265 your tool is not in the PATH.
1267 difftool.<tool>.cmd::
1268 Specify the command to invoke the specified diff tool.
1269 The specified command is evaluated in shell with the following
1270 variables available: 'LOCAL' is set to the name of the temporary
1271 file containing the contents of the diff pre-image and 'REMOTE'
1272 is set to the name of the temporary file containing the contents
1273 of the diff post-image.
1275 difftool.prompt::
1276 Prompt before each invocation of the diff tool.
1278 fastimport.unpackLimit::
1279 If the number of objects imported by linkgit:git-fast-import[1]
1280 is below this limit, then the objects will be unpacked into
1281 loose object files. However if the number of imported objects
1282 equals or exceeds this limit then the pack will be stored as a
1283 pack. Storing the pack from a fast-import can make the import
1284 operation complete faster, especially on slow filesystems. If
1285 not set, the value of `transfer.unpackLimit` is used instead.
1287 fetch.recurseSubmodules::
1288 This option can be either set to a boolean value or to 'on-demand'.
1289 Setting it to a boolean changes the behavior of fetch and pull to
1290 unconditionally recurse into submodules when set to true or to not
1291 recurse at all when set to false. When set to 'on-demand' (the default
1292 value), fetch and pull will only recurse into a populated submodule
1293 when its superproject retrieves a commit that updates the submodule's
1294 reference.
1296 fetch.fsckObjects::
1297 If it is set to true, git-fetch-pack will check all fetched
1298 objects. It will abort in the case of a malformed object or a
1299 broken link. The result of an abort are only dangling objects.
1300 Defaults to false. If not set, the value of `transfer.fsckObjects`
1301 is used instead.
1303 fetch.unpackLimit::
1304 If the number of objects fetched over the Git native
1305 transfer is below this
1306 limit, then the objects will be unpacked into loose object
1307 files. However if the number of received objects equals or
1308 exceeds this limit then the received pack will be stored as
1309 a pack, after adding any missing delta bases. Storing the
1310 pack from a push can make the push operation complete faster,
1311 especially on slow filesystems. If not set, the value of
1312 `transfer.unpackLimit` is used instead.
1314 fetch.prune::
1315 If true, fetch will automatically behave as if the `--prune`
1316 option was given on the command line. See also `remote.<name>.prune`.
1318 fetch.output::
1319 Control how ref update status is printed. Valid values are
1320 `full` and `compact`. Default value is `full`. See section
1321 OUTPUT in linkgit:git-fetch[1] for detail.
1323 format.attach::
1324 Enable multipart/mixed attachments as the default for
1325 'format-patch'. The value can also be a double quoted string
1326 which will enable attachments as the default and set the
1327 value as the boundary. See the --attach option in
1328 linkgit:git-format-patch[1].
1330 format.from::
1331 Provides the default value for the `--from` option to format-patch.
1332 Accepts a boolean value, or a name and email address. If false,
1333 format-patch defaults to `--no-from`, using commit authors directly in
1334 the "From:" field of patch mails. If true, format-patch defaults to
1335 `--from`, using your committer identity in the "From:" field of patch
1336 mails and including a "From:" field in the body of the patch mail if
1337 different. If set to a non-boolean value, format-patch uses that
1338 value instead of your committer identity. Defaults to false.
1340 format.numbered::
1341 A boolean which can enable or disable sequence numbers in patch
1342 subjects. It defaults to "auto" which enables it only if there
1343 is more than one patch. It can be enabled or disabled for all
1344 messages by setting it to "true" or "false". See --numbered
1345 option in linkgit:git-format-patch[1].
1347 format.headers::
1348 Additional email headers to include in a patch to be submitted
1349 by mail. See linkgit:git-format-patch[1].
1353 Additional recipients to include in a patch to be submitted
1354 by mail. See the --to and --cc options in
1355 linkgit:git-format-patch[1].
1357 format.subjectPrefix::
1358 The default for format-patch is to output files with the '[PATCH]'
1359 subject prefix. Use this variable to change that prefix.
1361 format.signature::
1362 The default for format-patch is to output a signature containing
1363 the Git version number. Use this variable to change that default.
1364 Set this variable to the empty string ("") to suppress
1365 signature generation.
1367 format.signatureFile::
1368 Works just like format.signature except the contents of the
1369 file specified by this variable will be used as the signature.
1371 format.suffix::
1372 The default for format-patch is to output files with the suffix
1373 `.patch`. Use this variable to change that suffix (make sure to
1374 include the dot if you want it).
1376 format.pretty::
1377 The default pretty format for log/show/whatchanged command,
1378 See linkgit:git-log[1], linkgit:git-show[1],
1379 linkgit:git-whatchanged[1].
1381 format.thread::
1382 The default threading style for 'git format-patch'. Can be
1383 a boolean value, or `shallow` or `deep`. `shallow` threading
1384 makes every mail a reply to the head of the series,
1385 where the head is chosen from the cover letter, the
1386 `--in-reply-to`, and the first patch mail, in this order.
1387 `deep` threading makes every mail a reply to the previous one.
1388 A true boolean value is the same as `shallow`, and a false
1389 value disables threading.
1391 format.signOff::
1392 A boolean value which lets you enable the `-s/--signoff` option of
1393 format-patch by default. *Note:* Adding the Signed-off-by: line to a
1394 patch should be a conscious act and means that you certify you have
1395 the rights to submit this work under the same open source license.
1396 Please see the 'SubmittingPatches' document for further discussion.
1398 format.coverLetter::
1399 A boolean that controls whether to generate a cover-letter when
1400 format-patch is invoked, but in addition can be set to "auto", to
1401 generate a cover-letter only when there's more than one patch.
1403 format.outputDirectory::
1404 Set a custom directory to store the resulting files instead of the
1405 current working directory.
1407 format.useAutoBase::
1408 A boolean value which lets you enable the `--base=auto` option of
1409 format-patch by default.
1411 filter.<driver>.clean::
1412 The command which is used to convert the content of a worktree
1413 file to a blob upon checkin. See linkgit:gitattributes[5] for
1414 details.
1416 filter.<driver>.smudge::
1417 The command which is used to convert the content of a blob
1418 object to a worktree file upon checkout. See
1419 linkgit:gitattributes[5] for details.
1421 fsck.<msg-id>::
1422 Allows overriding the message type (error, warn or ignore) of a
1423 specific message ID such as `missingEmail`.
1424 +
1425 For convenience, fsck prefixes the error/warning with the message ID,
1426 e.g. "missingEmail: invalid author/committer line - missing email" means
1427 that setting `fsck.missingEmail = ignore` will hide that issue.
1428 +
1429 This feature is intended to support working with legacy repositories
1430 which cannot be repaired without disruptive changes.
1432 fsck.skipList::
1433 The path to a sorted list of object names (i.e. one SHA-1 per
1434 line) that are known to be broken in a non-fatal way and should
1435 be ignored. This feature is useful when an established project
1436 should be accepted despite early commits containing errors that
1437 can be safely ignored such as invalid committer email addresses.
1438 Note: corrupt objects cannot be skipped with this setting.
1440 gc.aggressiveDepth::
1441 The depth parameter used in the delta compression
1442 algorithm used by 'git gc --aggressive'. This defaults
1443 to 50.
1445 gc.aggressiveWindow::
1446 The window size parameter used in the delta compression
1447 algorithm used by 'git gc --aggressive'. This defaults
1448 to 250.
1451 When there are approximately more than this many loose
1452 objects in the repository, `git gc --auto` will pack them.
1453 Some Porcelain commands use this command to perform a
1454 light-weight garbage collection from time to time. The
1455 default value is 6700. Setting this to 0 disables it.
1457 gc.autoPackLimit::
1458 When there are more than this many packs that are not
1459 marked with `*.keep` file in the repository, `git gc
1460 --auto` consolidates them into one larger pack. The
1461 default value is 50. Setting this to 0 disables it.
1463 gc.autoDetach::
1464 Make `git gc --auto` return immediately and run in background
1465 if the system supports it. Default is true.
1467 gc.packRefs::
1468 Running `git pack-refs` in a repository renders it
1469 unclonable by Git versions prior to over dumb
1470 transports such as HTTP. This variable determines whether
1471 'git gc' runs `git pack-refs`. This can be set to `notbare`
1472 to enable it within all non-bare repos or it can be set to a
1473 boolean value. The default is `true`.
1475 gc.pruneExpire::
1476 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1477 Override the grace period with this config variable. The value
1478 "now" may be used to disable this grace period and always prune
1479 unreachable objects immediately, or "never" may be used to
1480 suppress pruning. This feature helps prevent corruption when
1481 'git gc' runs concurrently with another process writing to the
1482 repository; see the "NOTES" section of linkgit:git-gc[1].
1484 gc.worktreePruneExpire::
1485 When 'git gc' is run, it calls
1486 'git worktree prune --expire 3.months.ago'.
1487 This config variable can be used to set a different grace
1488 period. The value "now" may be used to disable the grace
1489 period and prune `$GIT_DIR/worktrees` immediately, or "never"
1490 may be used to suppress pruning.
1492 gc.reflogExpire::
1493 gc.<pattern>.reflogExpire::
1494 'git reflog expire' removes reflog entries older than
1495 this time; defaults to 90 days. The value "now" expires all
1496 entries immediately, and "never" suppresses expiration
1497 altogether. With "<pattern>" (e.g.
1498 "refs/stash") in the middle the setting applies only to
1499 the refs that match the <pattern>.
1501 gc.reflogExpireUnreachable::
1502 gc.<pattern>.reflogExpireUnreachable::
1503 'git reflog expire' removes reflog entries older than
1504 this time and are not reachable from the current tip;
1505 defaults to 30 days. The value "now" expires all entries
1506 immediately, and "never" suppresses expiration altogether.
1507 With "<pattern>" (e.g. "refs/stash")
1508 in the middle, the setting applies only to the refs that
1509 match the <pattern>.
1511 gc.rerereResolved::
1512 Records of conflicted merge you resolved earlier are
1513 kept for this many days when 'git rerere gc' is run.
1514 The default is 60 days. See linkgit:git-rerere[1].
1516 gc.rerereUnresolved::
1517 Records of conflicted merge you have not resolved are
1518 kept for this many days when 'git rerere gc' is run.
1519 The default is 15 days. See linkgit:git-rerere[1].
1521 gitcvs.commitMsgAnnotation::
1522 Append this string to each commit message. Set to empty string
1523 to disable this feature. Defaults to "via git-CVS emulator".
1525 gitcvs.enabled::
1526 Whether the CVS server interface is enabled for this repository.
1527 See linkgit:git-cvsserver[1].
1529 gitcvs.logFile::
1530 Path to a log file where the CVS server interface well... logs
1531 various stuff. See linkgit:git-cvsserver[1].
1533 gitcvs.usecrlfattr::
1534 If true, the server will look up the end-of-line conversion
1535 attributes for files to determine the `-k` modes to use. If
1536 the attributes force Git to treat a file as text,
1537 the `-k` mode will be left blank so CVS clients will
1538 treat it as text. If they suppress text conversion, the file
1539 will be set with '-kb' mode, which suppresses any newline munging
1540 the client might otherwise do. If the attributes do not allow
1541 the file type to be determined, then `gitcvs.allBinary` is
1542 used. See linkgit:gitattributes[5].
1544 gitcvs.allBinary::
1545 This is used if `gitcvs.usecrlfattr` does not resolve
1546 the correct '-kb' mode to use. If true, all
1547 unresolved files are sent to the client in
1548 mode '-kb'. This causes the client to treat them
1549 as binary files, which suppresses any newline munging it
1550 otherwise might do. Alternatively, if it is set to "guess",
1551 then the contents of the file are examined to decide if
1552 it is binary, similar to `core.autocrlf`.
1554 gitcvs.dbName::
1555 Database used by git-cvsserver to cache revision information
1556 derived from the Git repository. The exact meaning depends on the
1557 used database driver, for SQLite (which is the default driver) this
1558 is a filename. Supports variable substitution (see
1559 linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1560 Default: '%Ggitcvs.%m.sqlite'
1562 gitcvs.dbDriver::
1563 Used Perl DBI driver. You can specify any available driver
1564 for this here, but it might not work. git-cvsserver is tested
1565 with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1566 reported *not* to work with 'DBD::mysql'. Experimental feature.
1567 May not contain double colons (`:`). Default: 'SQLite'.
1568 See linkgit:git-cvsserver[1].
1570 gitcvs.dbUser, gitcvs.dbPass::
1571 Database user and password. Only useful if setting `gitcvs.dbDriver`,
1572 since SQLite has no concept of database users and/or passwords.
1573 'gitcvs.dbUser' supports variable substitution (see
1574 linkgit:git-cvsserver[1] for details).
1576 gitcvs.dbTableNamePrefix::
1577 Database table name prefix. Prepended to the names of any
1578 database tables used, allowing a single database to be used
1579 for several repositories. Supports variable substitution (see
1580 linkgit:git-cvsserver[1] for details). Any non-alphabetic
1581 characters will be replaced with underscores.
1583 All gitcvs variables except for `gitcvs.usecrlfattr` and
1584 `gitcvs.allBinary` can also be specified as
1585 'gitcvs.<access_method>.<varname>' (where 'access_method'
1586 is one of "ext" and "pserver") to make them apply only for the given
1587 access method.
1589 gitweb.category::
1590 gitweb.description::
1591 gitweb.owner::
1592 gitweb.url::
1593 See linkgit:gitweb[1] for description.
1595 gitweb.avatar::
1596 gitweb.blame::
1597 gitweb.grep::
1598 gitweb.highlight::
1599 gitweb.patches::
1600 gitweb.pickaxe::
1601 gitweb.remote_heads::
1602 gitweb.showSizes::
1603 gitweb.snapshot::
1604 See linkgit:gitweb.conf[5] for description.
1606 grep.lineNumber::
1607 If set to true, enable `-n` option by default.
1609 grep.patternType::
1610 Set the default matching behavior. Using a value of 'basic', 'extended',
1611 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1612 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1613 value 'default' will return to the default matching behavior.
1615 grep.extendedRegexp::
1616 If set to true, enable `--extended-regexp` option by default. This
1617 option is ignored when the `grep.patternType` option is set to a value
1618 other than 'default'.
1620 grep.threads::
1621 Number of grep worker threads to use.
1622 See `grep.threads` in linkgit:git-grep[1] for more information.
1624 grep.fallbackToNoIndex::
1625 If set to true, fall back to git grep --no-index if git grep
1626 is executed outside of a git repository. Defaults to false.
1628 gpg.program::
1629 Use this custom program instead of "`gpg`" found on `$PATH` when
1630 making or verifying a PGP signature. The program must support the
1631 same command-line interface as GPG, namely, to verify a detached
1632 signature, "`gpg --verify $file - <$signature`" is run, and the
1633 program is expected to signal a good signature by exiting with
1634 code 0, and to generate an ASCII-armored detached signature, the
1635 standard input of "`gpg -bsau $key`" is fed with the contents to be
1636 signed, and the program is expected to send the result to its
1637 standard output.
1639 gui.commitMsgWidth::
1640 Defines how wide the commit message window is in the
1641 linkgit:git-gui[1]. "75" is the default.
1643 gui.diffContext::
1644 Specifies how many context lines should be used in calls to diff
1645 made by the linkgit:git-gui[1]. The default is "5".
1647 gui.displayUntracked::
1648 Determines if linkgit:git-gui[1] shows untracked files
1649 in the file list. The default is "true".
1651 gui.encoding::
1652 Specifies the default encoding to use for displaying of
1653 file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1654 It can be overridden by setting the 'encoding' attribute
1655 for relevant files (see linkgit:gitattributes[5]).
1656 If this option is not set, the tools default to the
1657 locale encoding.
1659 gui.matchTrackingBranch::
1660 Determines if new branches created with linkgit:git-gui[1] should
1661 default to tracking remote branches with matching names or
1662 not. Default: "false".
1664 gui.newBranchTemplate::
1665 Is used as suggested name when creating new branches using the
1666 linkgit:git-gui[1].
1668 gui.pruneDuringFetch::
1669 "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1670 performing a fetch. The default value is "false".
1672 gui.trustmtime::
1673 Determines if linkgit:git-gui[1] should trust the file modification
1674 timestamp or not. By default the timestamps are not trusted.
1676 gui.spellingDictionary::
1677 Specifies the dictionary used for spell checking commit messages in
1678 the linkgit:git-gui[1]. When set to "none" spell checking is turned
1679 off.
1681 gui.fastCopyBlame::
1682 If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1683 location detection. It makes blame significantly faster on huge
1684 repositories at the expense of less thorough copy detection.
1686 gui.copyBlameThreshold::
1687 Specifies the threshold to use in 'git gui blame' original location
1688 detection, measured in alphanumeric characters. See the
1689 linkgit:git-blame[1] manual for more information on copy detection.
1691 gui.blamehistoryctx::
1692 Specifies the radius of history context in days to show in
1693 linkgit:gitk[1] for the selected commit, when the `Show History
1694 Context` menu item is invoked from 'git gui blame'. If this
1695 variable is set to zero, the whole history is shown.
1697 guitool.<name>.cmd::
1698 Specifies the shell command line to execute when the corresponding item
1699 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1700 mandatory for every tool. The command is executed from the root of
1701 the working directory, and in the environment it receives the name of
1702 the tool as `GIT_GUITOOL`, the name of the currently selected file as
1703 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1704 the head is detached, 'CUR_BRANCH' is empty).
1706 guitool.<name>.needsFile::
1707 Run the tool only if a diff is selected in the GUI. It guarantees
1708 that 'FILENAME' is not empty.
1710 guitool.<name>.noConsole::
1711 Run the command silently, without creating a window to display its
1712 output.
1714 guitool.<name>.noRescan::
1715 Don't rescan the working directory for changes after the tool
1716 finishes execution.
1718 guitool.<name>.confirm::
1719 Show a confirmation dialog before actually running the tool.
1721 guitool.<name>.argPrompt::
1722 Request a string argument from the user, and pass it to the tool
1723 through the `ARGS` environment variable. Since requesting an
1724 argument implies confirmation, the 'confirm' option has no effect
1725 if this is enabled. If the option is set to 'true', 'yes', or '1',
1726 the dialog uses a built-in generic prompt; otherwise the exact
1727 value of the variable is used.
1729 guitool.<name>.revPrompt::
1730 Request a single valid revision from the user, and set the
1731 `REVISION` environment variable. In other aspects this option
1732 is similar to 'argPrompt', and can be used together with it.
1734 guitool.<name>.revUnmerged::
1735 Show only unmerged branches in the 'revPrompt' subdialog.
1736 This is useful for tools similar to merge or rebase, but not
1737 for things like checkout or reset.
1739 guitool.<name>.title::
1740 Specifies the title to use for the prompt dialog. The default
1741 is the tool name.
1743 guitool.<name>.prompt::
1744 Specifies the general prompt string to display at the top of
1745 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1746 The default value includes the actual command.
1748 help.browser::
1749 Specify the browser that will be used to display help in the
1750 'web' format. See linkgit:git-help[1].
1752 help.format::
1753 Override the default help format used by linkgit:git-help[1].
1754 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1755 the default. 'web' and 'html' are the same.
1757 help.autoCorrect::
1758 Automatically correct and execute mistyped commands after
1759 waiting for the given number of deciseconds (0.1 sec). If more
1760 than one command can be deduced from the entered text, nothing
1761 will be executed. If the value of this option is negative,
1762 the corrected command will be executed immediately. If the
1763 value is 0 - the command will be just shown but not executed.
1764 This is the default.
1766 help.htmlPath::
1767 Specify the path where the HTML documentation resides. File system paths
1768 and URLs are supported. HTML pages will be prefixed with this path when
1769 help is displayed in the 'web' format. This defaults to the documentation
1770 path of your Git installation.
1772 http.proxy::
1773 Override the HTTP proxy, normally configured using the 'http_proxy',
1774 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1775 addition to the syntax understood by curl, it is possible to specify a
1776 proxy string with a user name but no password, in which case git will
1777 attempt to acquire one in the same way it does for other credentials. See
1778 linkgit:gitcredentials[7] for more information. The syntax thus is
1779 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1780 on a per-remote basis; see remote.<name>.proxy
1782 http.proxyAuthMethod::
1783 Set the method with which to authenticate against the HTTP proxy. This
1784 only takes effect if the configured proxy string contains a user name part
1785 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1786 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1787 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1788 variable. Possible values are:
1789 +
1790 --
1791 * `anyauth` - Automatically pick a suitable authentication method. It is
1792 assumed that the proxy answers an unauthenticated request with a 407
1793 status code and one or more Proxy-authenticate headers with supported
1794 authentication methods. This is the default.
1795 * `basic` - HTTP Basic authentication
1796 * `digest` - HTTP Digest authentication; this prevents the password from being
1797 transmitted to the proxy in clear text
1798 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1799 of `curl(1)`)
1800 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1801 --
1803 http.emptyAuth::
1804 Attempt authentication without seeking a username or password. This
1805 can be used to attempt GSS-Negotiate authentication without specifying
1806 a username in the URL, as libcurl normally requires a username for
1807 authentication.
1809 http.delegation::
1810 Control GSSAPI credential delegation. The delegation is disabled
1811 by default in libcurl since version 7.21.7. Set parameter to tell
1812 the server what it is allowed to delegate when it comes to user
1813 credentials. Used with GSS/kerberos. Possible values are:
1814 +
1815 --
1816 * `none` - Don't allow any delegation.
1817 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1818 Kerberos service ticket, which is a matter of realm policy.
1819 * `always` - Unconditionally allow the server to delegate.
1820 --
1823 http.extraHeader::
1824 Pass an additional HTTP header when communicating with a server. If
1825 more than one such entry exists, all of them are added as extra
1826 headers. To allow overriding the settings inherited from the system
1827 config, an empty value will reset the extra headers to the empty list.
1829 http.cookieFile::
1830 The pathname of a file containing previously stored cookie lines,
1831 which should be used
1832 in the Git http session, if they match the server. The file format
1833 of the file to read cookies from should be plain HTTP headers or
1834 the Netscape/Mozilla cookie file format (see `curl(1)`).
1835 NOTE that the file specified with http.cookieFile is used only as
1836 input unless http.saveCookies is set.
1838 http.saveCookies::
1839 If set, store cookies received during requests to the file specified by
1840 http.cookieFile. Has no effect if http.cookieFile is unset.
1842 http.sslVersion::
1843 The SSL version to use when negotiating an SSL connection, if you
1844 want to force the default. The available and default version
1845 depend on whether libcurl was built against NSS or OpenSSL and the
1846 particular configuration of the crypto library in use. Internally
1847 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1848 documentation for more details on the format of this option and
1849 for the ssl version supported. Actually the possible values of
1850 this option are:
1852 - sslv2
1853 - sslv3
1854 - tlsv1
1855 - tlsv1.0
1856 - tlsv1.1
1857 - tlsv1.2
1859 +
1860 Can be overridden by the `GIT_SSL_VERSION` environment variable.
1861 To force git to use libcurl's default ssl version and ignore any
1862 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1863 empty string.
1865 http.sslCipherList::
1866 A list of SSL ciphers to use when negotiating an SSL connection.
1867 The available ciphers depend on whether libcurl was built against
1868 NSS or OpenSSL and the particular configuration of the crypto
1869 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1870 option; see the libcurl documentation for more details on the format
1871 of this list.
1872 +
1873 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1874 To force git to use libcurl's default cipher list and ignore any
1875 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1876 empty string.
1878 http.sslVerify::
1879 Whether to verify the SSL certificate when fetching or pushing
1880 over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment
1881 variable.
1883 http.sslCert::
1884 File containing the SSL certificate when fetching or pushing
1885 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1886 variable.
1888 http.sslKey::
1889 File containing the SSL private key when fetching or pushing
1890 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1891 variable.
1893 http.sslCertPasswordProtected::
1894 Enable Git's password prompt for the SSL certificate. Otherwise
1895 OpenSSL will prompt the user, possibly many times, if the
1896 certificate or private key is encrypted. Can be overridden by the
1897 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1899 http.sslCAInfo::
1900 File containing the certificates to verify the peer with when
1901 fetching or pushing over HTTPS. Can be overridden by the
1902 `GIT_SSL_CAINFO` environment variable.
1904 http.sslCAPath::
1905 Path containing files with the CA certificates to verify the peer
1906 with when fetching or pushing over HTTPS. Can be overridden
1907 by the `GIT_SSL_CAPATH` environment variable.
1909 http.pinnedpubkey::
1910 Public key of the https service. It may either be the filename of
1911 a PEM or DER encoded public key file or a string starting with
1912 'sha256//' followed by the base64 encoded sha256 hash of the
1913 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1914 exit with an error if this option is set but not supported by
1915 cURL.
1917 http.sslTry::
1918 Attempt to use AUTH SSL/TLS and encrypted data transfers
1919 when connecting via regular FTP protocol. This might be needed
1920 if the FTP server requires it for security reasons or you wish
1921 to connect securely whenever remote FTP server supports it.
1922 Default is false since it might trigger certificate verification
1923 errors on misconfigured servers.
1925 http.maxRequests::
1926 How many HTTP requests to launch in parallel. Can be overridden
1927 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1929 http.minSessions::
1930 The number of curl sessions (counted across slots) to be kept across
1931 requests. They will not be ended with curl_easy_cleanup() until
1932 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1933 value will be capped at 1. Defaults to 1.
1935 http.postBuffer::
1936 Maximum size in bytes of the buffer used by smart HTTP
1937 transports when POSTing data to the remote system.
1938 For requests larger than this buffer size, HTTP/1.1 and
1939 Transfer-Encoding: chunked is used to avoid creating a
1940 massive pack file locally. Default is 1 MiB, which is
1941 sufficient for most requests.
1943 http.lowSpeedLimit, http.lowSpeedTime::
1944 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1945 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1946 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1947 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
1949 http.noEPSV::
1950 A boolean which disables using of EPSV ftp command by curl.
1951 This can helpful with some "poor" ftp servers which don't
1952 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
1953 environment variable. Default is false (curl will use EPSV).
1955 http.userAgent::
1956 The HTTP USER_AGENT string presented to an HTTP server. The default
1957 value represents the version of the client Git such as git/1.7.1.
1958 This option allows you to override this value to a more common value
1959 such as Mozilla/4.0. This may be necessary, for instance, if
1960 connecting through a firewall that restricts HTTP connections to a set
1961 of common USER_AGENT strings (but not including those like git/1.7.1).
1962 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
1964 http.followRedirects::
1965 Whether git should follow HTTP redirects. If set to `true`, git
1966 will transparently follow any redirect issued by a server it
1967 encounters. If set to `false`, git will treat all redirects as
1968 errors. If set to `initial`, git will follow redirects only for
1969 the initial request to a remote, but not for subsequent
1970 follow-up HTTP requests. Since git uses the redirected URL as
1971 the base for the follow-up requests, this is generally
1972 sufficient. The default is `initial`.
1974 http.<url>.*::
1975 Any of the http.* options above can be applied selectively to some URLs.
1976 For a config key to match a URL, each element of the config key is
1977 compared to that of the URL, in the following order:
1978 +
1979 --
1980 . Scheme (e.g., `https` in ``). This field
1981 must match exactly between the config key and the URL.
1983 . Host/domain name (e.g., `` in ``).
1984 This field must match exactly between the config key and the URL.
1986 . Port number (e.g., `8080` in ``).
1987 This field must match exactly between the config key and the URL.
1988 Omitted port numbers are automatically converted to the correct
1989 default for the scheme before matching.
1991 . Path (e.g., `repo.git` in ``). The
1992 path field of the config key must match the path field of the URL
1993 either exactly or as a prefix of slash-delimited path elements. This means
1994 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1995 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1996 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1997 key with just path `foo/`).
1999 . User name (e.g., `user` in ``). If
2000 the config key has a user name it must match the user name in the
2001 URL exactly. If the config key does not have a user name, that
2002 config key will match a URL with any user name (including none),
2003 but at a lower precedence than a config key with a user name.
2004 --
2005 +
2006 The list above is ordered by decreasing precedence; a URL that matches
2007 a config key's path is preferred to one that matches its user name. For example,
2008 if the URL is `` a config key match of
2009 `` will be preferred over a config key match of
2010 ``.
2011 +
2012 All URLs are normalized before attempting any matching (the password part,
2013 if embedded in the URL, is always ignored for matching purposes) so that
2014 equivalent URLs that are simply spelled differently will match properly.
2015 Environment variable settings always override any matches. The URLs that are
2016 matched against are those given directly to Git commands. This means any URLs
2017 visited as a result of a redirection do not participate in matching.
2019 i18n.commitEncoding::
2020 Character encoding the commit messages are stored in; Git itself
2021 does not care per se, but this information is necessary e.g. when
2022 importing commits from emails or in the gitk graphical history
2023 browser (and possibly at other places in the future or in other
2024 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2026 i18n.logOutputEncoding::
2027 Character encoding the commit messages are converted to when
2028 running 'git log' and friends.
2030 imap::
2031 The configuration variables in the 'imap' section are described
2032 in linkgit:git-imap-send[1].
2034 index.version::
2035 Specify the version with which new index files should be
2036 initialized. This does not affect existing repositories.
2038 init.templateDir::
2039 Specify the directory from which templates will be copied.
2040 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2042 instaweb.browser::
2043 Specify the program that will be used to browse your working
2044 repository in gitweb. See linkgit:git-instaweb[1].
2046 instaweb.httpd::
2047 The HTTP daemon command-line to start gitweb on your working
2048 repository. See linkgit:git-instaweb[1].
2050 instaweb.local::
2051 If true the web server started by linkgit:git-instaweb[1] will
2052 be bound to the local IP (
2054 instaweb.modulePath::
2055 The default module path for linkgit:git-instaweb[1] to use
2056 instead of /usr/lib/apache2/modules. Only used if httpd
2057 is Apache.
2059 instaweb.port::
2060 The port number to bind the gitweb httpd to. See
2061 linkgit:git-instaweb[1].
2063 interactive.singleKey::
2064 In interactive commands, allow the user to provide one-letter
2065 input with a single key (i.e., without hitting enter).
2066 Currently this is used by the `--patch` mode of
2067 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2068 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2069 setting is silently ignored if portable keystroke input
2070 is not available; requires the Perl module Term::ReadKey.
2072 interactive.diffFilter::
2073 When an interactive command (such as `git add --patch`) shows
2074 a colorized diff, git will pipe the diff through the shell
2075 command defined by this configuration variable. The command may
2076 mark up the diff further for human consumption, provided that it
2077 retains a one-to-one correspondence with the lines in the
2078 original diff. Defaults to disabled (no filtering).
2080 log.abbrevCommit::
2081 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2082 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2083 override this option with `--no-abbrev-commit`.
2086 Set the default date-time mode for the 'log' command.
2087 Setting a value for is similar to using 'git log''s
2088 `--date` option. See linkgit:git-log[1] for details.
2090 log.decorate::
2091 Print out the ref names of any commits that are shown by the log
2092 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2093 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2094 specified, the full ref name (including prefix) will be printed.
2095 If 'auto' is specified, then if the output is going to a terminal,
2096 the ref names are shown as if 'short' were given, otherwise no ref
2097 names are shown. This is the same as the `--decorate` option
2098 of the `git log`.
2100 log.follow::
2101 If `true`, `git log` will act as if the `--follow` option was used when
2102 a single <path> is given. This has the same limitations as `--follow`,
2103 i.e. it cannot be used to follow multiple files and does not work well
2104 on non-linear history.
2106 log.graphColors::
2107 A list of colors, separated by commas, that can be used to draw
2108 history lines in `git log --graph`.
2110 log.showRoot::
2111 If true, the initial commit will be shown as a big creation event.
2112 This is equivalent to a diff against an empty tree.
2113 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2114 normally hide the root commit will now show it. True by default.
2116 log.mailmap::
2117 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2118 linkgit:git-whatchanged[1] assume `--use-mailmap`.
2120 mailinfo.scissors::
2121 If true, makes linkgit:git-mailinfo[1] (and therefore
2122 linkgit:git-am[1]) act by default as if the --scissors option
2123 was provided on the command-line. When active, this features
2124 removes everything from the message body before a scissors
2125 line (i.e. consisting mainly of ">8", "8<" and "-").
2127 mailmap.file::
2128 The location of an augmenting mailmap file. The default
2129 mailmap, located in the root of the repository, is loaded
2130 first, then the mailmap file pointed to by this variable.
2131 The location of the mailmap file may be in a repository
2132 subdirectory, or somewhere outside of the repository itself.
2133 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2135 mailmap.blob::
2136 Like `mailmap.file`, but consider the value as a reference to a
2137 blob in the repository. If both `mailmap.file` and
2138 `mailmap.blob` are given, both are parsed, with entries from
2139 `mailmap.file` taking precedence. In a bare repository, this
2140 defaults to `HEAD:.mailmap`. In a non-bare repository, it
2141 defaults to empty.
2143 man.viewer::
2144 Specify the programs that may be used to display help in the
2145 'man' format. See linkgit:git-help[1].
2147 man.<tool>.cmd::
2148 Specify the command to invoke the specified man viewer. The
2149 specified command is evaluated in shell with the man page
2150 passed as argument. (See linkgit:git-help[1].)
2152 man.<tool>.path::
2153 Override the path for the given tool that may be used to
2154 display help in the 'man' format. See linkgit:git-help[1].
2156 include::merge-config.txt[]
2158 mergetool.<tool>.path::
2159 Override the path for the given tool. This is useful in case
2160 your tool is not in the PATH.
2162 mergetool.<tool>.cmd::
2163 Specify the command to invoke the specified merge tool. The
2164 specified command is evaluated in shell with the following
2165 variables available: 'BASE' is the name of a temporary file
2166 containing the common base of the files to be merged, if available;
2167 'LOCAL' is the name of a temporary file containing the contents of
2168 the file on the current branch; 'REMOTE' is the name of a temporary
2169 file containing the contents of the file from the branch being
2170 merged; 'MERGED' contains the name of the file to which the merge
2171 tool should write the results of a successful merge.
2173 mergetool.<tool>.trustExitCode::
2174 For a custom merge command, specify whether the exit code of
2175 the merge command can be used to determine whether the merge was
2176 successful. If this is not set to true then the merge target file
2177 timestamp is checked and the merge assumed to have been successful
2178 if the file has been updated, otherwise the user is prompted to
2179 indicate the success of the merge.
2181 mergetool.meld.hasOutput::
2182 Older versions of `meld` do not support the `--output` option.
2183 Git will attempt to detect whether `meld` supports `--output`
2184 by inspecting the output of `meld --help`. Configuring
2185 `mergetool.meld.hasOutput` will make Git skip these checks and
2186 use the configured value instead. Setting `mergetool.meld.hasOutput`
2187 to `true` tells Git to unconditionally use the `--output` option,
2188 and `false` avoids using `--output`.
2190 mergetool.keepBackup::
2191 After performing a merge, the original file with conflict markers
2192 can be saved as a file with a `.orig` extension. If this variable
2193 is set to `false` then this file is not preserved. Defaults to
2194 `true` (i.e. keep the backup files).
2196 mergetool.keepTemporaries::
2197 When invoking a custom merge tool, Git uses a set of temporary
2198 files to pass to the tool. If the tool returns an error and this
2199 variable is set to `true`, then these temporary files will be
2200 preserved, otherwise they will be removed after the tool has
2201 exited. Defaults to `false`.
2203 mergetool.writeToTemp::
2204 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2205 conflicting files in the worktree by default. Git will attempt
2206 to use a temporary directory for these files when set `true`.
2207 Defaults to `false`.
2209 mergetool.prompt::
2210 Prompt before each invocation of the merge resolution program.
2212 notes.mergeStrategy::
2213 Which merge strategy to choose by default when resolving notes
2214 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
2215 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
2216 section of linkgit:git-notes[1] for more information on each strategy.
2218 notes.<name>.mergeStrategy::
2219 Which merge strategy to choose when doing a notes merge into
2220 refs/notes/<name>. This overrides the more general
2221 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
2222 linkgit:git-notes[1] for more information on the available strategies.
2224 notes.displayRef::
2225 The (fully qualified) refname from which to show notes when
2226 showing commit messages. The value of this variable can be set
2227 to a glob, in which case notes from all matching refs will be
2228 shown. You may also specify this configuration variable
2229 several times. A warning will be issued for refs that do not
2230 exist, but a glob that does not match any refs is silently
2231 ignored.
2232 +
2233 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2234 environment variable, which must be a colon separated list of refs or
2235 globs.
2236 +
2237 The effective value of "core.notesRef" (possibly overridden by
2238 GIT_NOTES_REF) is also implicitly added to the list of refs to be
2239 displayed.
2241 notes.rewrite.<command>::
2242 When rewriting commits with <command> (currently `amend` or
2243 `rebase`) and this variable is set to `true`, Git
2244 automatically copies your notes from the original to the
2245 rewritten commit. Defaults to `true`, but see
2246 "notes.rewriteRef" below.
2248 notes.rewriteMode::
2249 When copying notes during a rewrite (see the
2250 "notes.rewrite.<command>" option), determines what to do if
2251 the target commit already has a note. Must be one of
2252 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2253 Defaults to `concatenate`.
2254 +
2255 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2256 environment variable.
2258 notes.rewriteRef::
2259 When copying notes during a rewrite, specifies the (fully
2260 qualified) ref whose notes should be copied. The ref may be a
2261 glob, in which case notes in all matching refs will be copied.
2262 You may also specify this configuration several times.
2263 +
2264 Does not have a default value; you must configure this variable to
2265 enable note rewriting. Set it to `refs/notes/commits` to enable
2266 rewriting for the default commit notes.
2267 +
2268 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2269 environment variable, which must be a colon separated list of refs or
2270 globs.
2272 pack.window::
2273 The size of the window used by linkgit:git-pack-objects[1] when no
2274 window size is given on the command line. Defaults to 10.
2276 pack.depth::
2277 The maximum delta depth used by linkgit:git-pack-objects[1] when no
2278 maximum depth is given on the command line. Defaults to 50.
2280 pack.windowMemory::
2281 The maximum size of memory that is consumed by each thread
2282 in linkgit:git-pack-objects[1] for pack window memory when
2283 no limit is given on the command line. The value can be
2284 suffixed with "k", "m", or "g". When left unconfigured (or
2285 set explicitly to 0), there will be no limit.
2287 pack.compression::
2288 An integer -1..9, indicating the compression level for objects
2289 in a pack file. -1 is the zlib default. 0 means no
2290 compression, and 1..9 are various speed/size tradeoffs, 9 being
2291 slowest. If not set, defaults to core.compression. If that is
2292 not set, defaults to -1, the zlib default, which is "a default
2293 compromise between speed and compression (currently equivalent
2294 to level 6)."
2295 +
2296 Note that changing the compression level will not automatically recompress
2297 all existing objects. You can force recompression by passing the -F option
2298 to linkgit:git-repack[1].
2300 pack.deltaCacheSize::
2301 The maximum memory in bytes used for caching deltas in
2302 linkgit:git-pack-objects[1] before writing them out to a pack.
2303 This cache is used to speed up the writing object phase by not
2304 having to recompute the final delta result once the best match
2305 for all objects is found. Repacking large repositories on machines
2306 which are tight with memory might be badly impacted by this though,
2307 especially if this cache pushes the system into swapping.
2308 A value of 0 means no limit. The smallest size of 1 byte may be
2309 used to virtually disable this cache. Defaults to 256 MiB.
2311 pack.deltaCacheLimit::
2312 The maximum size of a delta, that is cached in
2313 linkgit:git-pack-objects[1]. This cache is used to speed up the
2314 writing object phase by not having to recompute the final delta
2315 result once the best match for all objects is found. Defaults to 1000.
2317 pack.threads::
2318 Specifies the number of threads to spawn when searching for best
2319 delta matches. This requires that linkgit:git-pack-objects[1]
2320 be compiled with pthreads otherwise this option is ignored with a
2321 warning. This is meant to reduce packing time on multiprocessor
2322 machines. The required amount of memory for the delta search window
2323 is however multiplied by the number of threads.
2324 Specifying 0 will cause Git to auto-detect the number of CPU's
2325 and set the number of threads accordingly.
2327 pack.indexVersion::
2328 Specify the default pack index version. Valid values are 1 for
2329 legacy pack index used by Git versions prior to 1.5.2, and 2 for
2330 the new pack index with capabilities for packs larger than 4 GB
2331 as well as proper protection against the repacking of corrupted
2332 packs. Version 2 is the default. Note that version 2 is enforced
2333 and this config option ignored whenever the corresponding pack is
2334 larger than 2 GB.
2335 +
2336 If you have an old Git that does not understand the version 2 `*.idx` file,
2337 cloning or fetching over a non native protocol (e.g. "http")
2338 that will copy both `*.pack` file and corresponding `*.idx` file from the
2339 other side may give you a repository that cannot be accessed with your
2340 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2341 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2342 the `*.idx` file.
2344 pack.packSizeLimit::
2345 The maximum size of a pack. This setting only affects
2346 packing to a file when repacking, i.e. the git:// protocol
2347 is unaffected. It can be overridden by the `--max-pack-size`
2348 option of linkgit:git-repack[1]. Reaching this limit results
2349 in the creation of multiple packfiles; which in turn prevents
2350 bitmaps from being created.
2351 The minimum size allowed is limited to 1 MiB.
2352 The default is unlimited.
2353 Common unit suffixes of 'k', 'm', or 'g' are
2354 supported.
2356 pack.useBitmaps::
2357 When true, git will use pack bitmaps (if available) when packing
2358 to stdout (e.g., during the server side of a fetch). Defaults to
2359 true. You should not generally need to turn this off unless
2360 you are debugging pack bitmaps.
2362 pack.writeBitmaps (deprecated)::
2363 This is a deprecated synonym for `repack.writeBitmaps`.
2365 pack.writeBitmapHashCache::
2366 When true, git will include a "hash cache" section in the bitmap
2367 index (if one is written). This cache can be used to feed git's
2368 delta heuristics, potentially leading to better deltas between
2369 bitmapped and non-bitmapped objects (e.g., when serving a fetch
2370 between an older, bitmapped pack and objects that have been
2371 pushed since the last gc). The downside is that it consumes 4
2372 bytes per object of disk space, and that JGit's bitmap
2373 implementation does not understand it, causing it to complain if
2374 Git and JGit are used on the same repository. Defaults to false.
2376 pager.<cmd>::
2377 If the value is boolean, turns on or off pagination of the
2378 output of a particular Git subcommand when writing to a tty.
2379 Otherwise, turns on pagination for the subcommand using the
2380 pager specified by the value of `pager.<cmd>`. If `--paginate`
2381 or `--no-pager` is specified on the command line, it takes
2382 precedence over this option. To disable pagination for all
2383 commands, set `core.pager` or `GIT_PAGER` to `cat`.
2385 pretty.<name>::
2386 Alias for a --pretty= format string, as specified in
2387 linkgit:git-log[1]. Any aliases defined here can be used just
2388 as the built-in pretty formats could. For example,
2389 running `git config pretty.changelog "format:* %H %s"`
2390 would cause the invocation `git log --pretty=changelog`
2391 to be equivalent to running `git log "--pretty=format:* %H %s"`.
2392 Note that an alias with the same name as a built-in format
2393 will be silently ignored.
2395 protocol.allow::
2396 If set, provide a user defined default policy for all protocols which
2397 don't explicitly have a policy (`protocol.<name>.allow`). By default,
2398 if unset, known-safe protocols (http, https, git, ssh, file) have a
2399 default policy of `always`, known-dangerous protocols (ext) have a
2400 default policy of `never`, and all other protocols have a default
2401 policy of `user`. Supported policies:
2402 +
2403 --
2405 * `always` - protocol is always able to be used.
2407 * `never` - protocol is never able to be used.
2409 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2410 either unset or has a value of 1. This policy should be used when you want a
2411 protocol to be directly usable by the user but don't want it used by commands which
2412 execute clone/fetch/push commands without user input, e.g. recursive
2413 submodule initialization.
2415 --
2417 protocol.<name>.allow::
2418 Set a policy to be used by protocol `<name>` with clone/fetch/push
2419 commands. See `protocol.allow` above for the available policies.
2420 +
2421 The protocol names currently used by git are:
2422 +
2423 --
2424 - `file`: any local file-based path (including `file://` URLs,
2425 or local paths)
2427 - `git`: the anonymous git protocol over a direct TCP
2428 connection (or proxy, if configured)
2430 - `ssh`: git over ssh (including `host:path` syntax,
2431 `ssh://`, etc).
2433 - `http`: git over http, both "smart http" and "dumb http".
2434 Note that this does _not_ include `https`; if you want to configure
2435 both, you must do so individually.
2437 - any external helpers are named by their protocol (e.g., use
2438 `hg` to allow the `git-remote-hg` helper)
2439 --
2441 pull.ff::
2442 By default, Git does not create an extra merge commit when merging
2443 a commit that is a descendant of the current commit. Instead, the
2444 tip of the current branch is fast-forwarded. When set to `false`,
2445 this variable tells Git to create an extra merge commit in such
2446 a case (equivalent to giving the `--no-ff` option from the command
2447 line). When set to `only`, only such fast-forward merges are
2448 allowed (equivalent to giving the `--ff-only` option from the
2449 command line). This setting overrides `merge.ff` when pulling.
2451 pull.rebase::
2452 When true, rebase branches on top of the fetched branch, instead
2453 of merging the default branch from the default remote when "git
2454 pull" is run. See "branch.<name>.rebase" for setting this on a
2455 per-branch basis.
2456 +
2457 When preserve, also pass `--preserve-merges` along to 'git rebase'
2458 so that locally committed merge commits will not be flattened
2459 by running 'git pull'.
2460 +
2461 When the value is `interactive`, the rebase is run in interactive mode.
2462 +
2463 *NOTE*: this is a possibly dangerous operation; do *not* use
2464 it unless you understand the implications (see linkgit:git-rebase[1]
2465 for details).
2467 pull.octopus::
2468 The default merge strategy to use when pulling multiple branches
2469 at once.
2471 pull.twohead::
2472 The default merge strategy to use when pulling a single branch.
2474 push.default::
2475 Defines the action `git push` should take if no refspec is
2476 explicitly given. Different values are well-suited for
2477 specific workflows; for instance, in a purely central workflow
2478 (i.e. the fetch source is equal to the push destination),
2479 `upstream` is probably what you want. Possible values are:
2480 +
2481 --
2483 * `nothing` - do not push anything (error out) unless a refspec is
2484 explicitly given. This is primarily meant for people who want to
2485 avoid mistakes by always being explicit.
2487 * `current` - push the current branch to update a branch with the same
2488 name on the receiving end. Works in both central and non-central
2489 workflows.
2491 * `upstream` - push the current branch back to the branch whose
2492 changes are usually integrated into the current branch (which is
2493 called `@{upstream}`). This mode only makes sense if you are
2494 pushing to the same repository you would normally pull from
2495 (i.e. central workflow).
2497 * `simple` - in centralized workflow, work like `upstream` with an
2498 added safety to refuse to push if the upstream branch's name is
2499 different from the local one.
2500 +
2501 When pushing to a remote that is different from the remote you normally
2502 pull from, work as `current`. This is the safest option and is suited
2503 for beginners.
2504 +
2505 This mode has become the default in Git 2.0.
2507 * `matching` - push all branches having the same name on both ends.
2508 This makes the repository you are pushing to remember the set of
2509 branches that will be pushed out (e.g. if you always push 'maint'
2510 and 'master' there and no other branches, the repository you push
2511 to will have these two branches, and your local 'maint' and
2512 'master' will be pushed there).
2513 +
2514 To use this mode effectively, you have to make sure _all_ the
2515 branches you would push out are ready to be pushed out before
2516 running 'git push', as the whole point of this mode is to allow you
2517 to push all of the branches in one go. If you usually finish work
2518 on only one branch and push out the result, while other branches are
2519 unfinished, this mode is not for you. Also this mode is not
2520 suitable for pushing into a shared central repository, as other
2521 people may add new branches there, or update the tip of existing
2522 branches outside your control.
2523 +
2524 This used to be the default, but not since Git 2.0 (`simple` is the
2525 new default).
2527 --
2529 push.followTags::
2530 If set to true enable `--follow-tags` option by default. You
2531 may override this configuration at time of push by specifying
2532 `--no-follow-tags`.
2534 push.gpgSign::
2535 May be set to a boolean value, or the string 'if-asked'. A true
2536 value causes all pushes to be GPG signed, as if `--signed` is
2537 passed to linkgit:git-push[1]. The string 'if-asked' causes
2538 pushes to be signed if the server supports it, as if
2539 `--signed=if-asked` is passed to 'git push'. A false value may
2540 override a value from a lower-priority config file. An explicit
2541 command-line flag always overrides this config option.
2543 push.recurseSubmodules::
2544 Make sure all submodule commits used by the revisions to be pushed
2545 are available on a remote-tracking branch. If the value is 'check'
2546 then Git will verify that all submodule commits that changed in the
2547 revisions to be pushed are available on at least one remote of the
2548 submodule. If any commits are missing, the push will be aborted and
2549 exit with non-zero status. If the value is 'on-demand' then all
2550 submodules that changed in the revisions to be pushed will be
2551 pushed. If on-demand was not able to push all necessary revisions
2552 it will also be aborted and exit with non-zero status. If the value
2553 is 'no' then default behavior of ignoring submodules when pushing
2554 is retained. You may override this configuration at time of push by
2555 specifying '--recurse-submodules=check|on-demand|no'.
2557 rebase.stat::
2558 Whether to show a diffstat of what changed upstream since the last
2559 rebase. False by default.
2561 rebase.autoSquash::
2562 If set to true enable `--autosquash` option by default.
2564 rebase.autoStash::
2565 When set to true, automatically create a temporary stash
2566 before the operation begins, and apply it after the operation
2567 ends. This means that you can run rebase on a dirty worktree.
2568 However, use with care: the final stash application after a
2569 successful rebase might result in non-trivial conflicts.
2570 Defaults to false.
2572 rebase.missingCommitsCheck::
2573 If set to "warn", git rebase -i will print a warning if some
2574 commits are removed (e.g. a line was deleted), however the
2575 rebase will still proceed. If set to "error", it will print
2576 the previous warning and stop the rebase, 'git rebase
2577 --edit-todo' can then be used to correct the error. If set to
2578 "ignore", no checking is done.
2579 To drop a commit without warning or error, use the `drop`
2580 command in the todo-list.
2581 Defaults to "ignore".
2583 rebase.instructionFormat::
2584 A format string, as specified in linkgit:git-log[1], to be used for
2585 the instruction list during an interactive rebase. The format will automatically
2586 have the long commit hash prepended to the format.
2588 receive.advertiseAtomic::
2589 By default, git-receive-pack will advertise the atomic push
2590 capability to its clients. If you don't want to advertise this
2591 capability, set this variable to false.
2593 receive.advertisePushOptions::
2594 By default, git-receive-pack will advertise the push options
2595 capability to its clients. If you don't want to advertise this
2596 capability, set this variable to false.
2598 receive.autogc::
2599 By default, git-receive-pack will run "git-gc --auto" after
2600 receiving data from git-push and updating refs. You can stop
2601 it by setting this variable to false.
2603 receive.certNonceSeed::
2604 By setting this variable to a string, `git receive-pack`
2605 will accept a `git push --signed` and verifies it by using
2606 a "nonce" protected by HMAC using this string as a secret
2607 key.
2609 receive.certNonceSlop::
2610 When a `git push --signed` sent a push certificate with a
2611 "nonce" that was issued by a receive-pack serving the same
2612 repository within this many seconds, export the "nonce"
2613 found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2614 hooks (instead of what the receive-pack asked the sending
2615 side to include). This may allow writing checks in
2616 `pre-receive` and `post-receive` a bit easier. Instead of
2617 checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2618 that records by how many seconds the nonce is stale to
2619 decide if they want to accept the certificate, they only
2620 can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2622 receive.fsckObjects::
2623 If it is set to true, git-receive-pack will check all received
2624 objects. It will abort in the case of a malformed object or a
2625 broken link. The result of an abort are only dangling objects.
2626 Defaults to false. If not set, the value of `transfer.fsckObjects`
2627 is used instead.
2629 receive.fsck.<msg-id>::
2630 When `receive.fsckObjects` is set to true, errors can be switched
2631 to warnings and vice versa by configuring the `receive.fsck.<msg-id>`
2632 setting where the `<msg-id>` is the fsck message ID and the value
2633 is one of `error`, `warn` or `ignore`. For convenience, fsck prefixes
2634 the error/warning with the message ID, e.g. "missingEmail: invalid
2635 author/committer line - missing email" means that setting
2636 `receive.fsck.missingEmail = ignore` will hide that issue.
2637 +
2638 This feature is intended to support working with legacy repositories
2639 which would not pass pushing when `receive.fsckObjects = true`, allowing
2640 the host to accept repositories with certain known issues but still catch
2641 other issues.
2643 receive.fsck.skipList::
2644 The path to a sorted list of object names (i.e. one SHA-1 per
2645 line) that are known to be broken in a non-fatal way and should
2646 be ignored. This feature is useful when an established project
2647 should be accepted despite early commits containing errors that
2648 can be safely ignored such as invalid committer email addresses.
2649 Note: corrupt objects cannot be skipped with this setting.
2651 receive.keepAlive::
2652 After receiving the pack from the client, `receive-pack` may
2653 produce no output (if `--quiet` was specified) while processing
2654 the pack, causing some networks to drop the TCP connection.
2655 With this option set, if `receive-pack` does not transmit
2656 any data in this phase for `receive.keepAlive` seconds, it will
2657 send a short keepalive packet. The default is 5 seconds; set
2658 to 0 to disable keepalives entirely.
2660 receive.unpackLimit::
2661 If the number of objects received in a push is below this
2662 limit then the objects will be unpacked into loose object
2663 files. However if the number of received objects equals or
2664 exceeds this limit then the received pack will be stored as
2665 a pack, after adding any missing delta bases. Storing the
2666 pack from a push can make the push operation complete faster,
2667 especially on slow filesystems. If not set, the value of
2668 `transfer.unpackLimit` is used instead.
2670 receive.maxInputSize::
2671 If the size of the incoming pack stream is larger than this
2672 limit, then git-receive-pack will error out, instead of
2673 accepting the pack file. If not set or set to 0, then the size
2674 is unlimited.
2676 receive.denyDeletes::
2677 If set to true, git-receive-pack will deny a ref update that deletes
2678 the ref. Use this to prevent such a ref deletion via a push.
2680 receive.denyDeleteCurrent::
2681 If set to true, git-receive-pack will deny a ref update that
2682 deletes the currently checked out branch of a non-bare repository.
2684 receive.denyCurrentBranch::
2685 If set to true or "refuse", git-receive-pack will deny a ref update
2686 to the currently checked out branch of a non-bare repository.
2687 Such a push is potentially dangerous because it brings the HEAD
2688 out of sync with the index and working tree. If set to "warn",
2689 print a warning of such a push to stderr, but allow the push to
2690 proceed. If set to false or "ignore", allow such pushes with no
2691 message. Defaults to "refuse".
2692 +
2693 Another option is "updateInstead" which will update the working
2694 tree if pushing into the current branch. This option is
2695 intended for synchronizing working directories when one side is not easily
2696 accessible via interactive ssh (e.g. a live web site, hence the requirement
2697 that the working directory be clean). This mode also comes in handy when
2698 developing inside a VM to test and fix code on different Operating Systems.
2699 +
2700 By default, "updateInstead" will refuse the push if the working tree or
2701 the index have any difference from the HEAD, but the `push-to-checkout`
2702 hook can be used to customize this. See linkgit:githooks[5].
2704 receive.denyNonFastForwards::
2705 If set to true, git-receive-pack will deny a ref update which is
2706 not a fast-forward. Use this to prevent such an update via a push,
2707 even if that push is forced. This configuration variable is
2708 set when initializing a shared repository.
2710 receive.hideRefs::
2711 This variable is the same as `transfer.hideRefs`, but applies
2712 only to `receive-pack` (and so affects pushes, but not fetches).
2713 An attempt to update or delete a hidden ref by `git push` is
2714 rejected.
2716 receive.updateServerInfo::
2717 If set to true, git-receive-pack will run git-update-server-info
2718 after receiving data from git-push and updating refs.
2720 receive.shallowUpdate::
2721 If set to true, .git/shallow can be updated when new refs
2722 require new shallow roots. Otherwise those refs are rejected.
2724 remote.pushDefault::
2725 The remote to push to by default. Overrides
2726 `branch.<name>.remote` for all branches, and is overridden by
2727 `branch.<name>.pushRemote` for specific branches.
2729 remote.<name>.url::
2730 The URL of a remote repository. See linkgit:git-fetch[1] or
2731 linkgit:git-push[1].
2733 remote.<name>.pushurl::
2734 The push URL of a remote repository. See linkgit:git-push[1].
2736 remote.<name>.proxy::
2737 For remotes that require curl (http, https and ftp), the URL to
2738 the proxy to use for that remote. Set to the empty string to
2739 disable proxying for that remote.
2741 remote.<name>.proxyAuthMethod::
2742 For remotes that require curl (http, https and ftp), the method to use for
2743 authenticating against the proxy in use (probably set in
2744 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2746 remote.<name>.fetch::
2747 The default set of "refspec" for linkgit:git-fetch[1]. See
2748 linkgit:git-fetch[1].
2750 remote.<name>.push::
2751 The default set of "refspec" for linkgit:git-push[1]. See
2752 linkgit:git-push[1].
2754 remote.<name>.mirror::
2755 If true, pushing to this remote will automatically behave
2756 as if the `--mirror` option was given on the command line.
2758 remote.<name>.skipDefaultUpdate::
2759 If true, this remote will be skipped by default when updating
2760 using linkgit:git-fetch[1] or the `update` subcommand of
2761 linkgit:git-remote[1].
2763 remote.<name>.skipFetchAll::
2764 If true, this remote will be skipped by default when updating
2765 using linkgit:git-fetch[1] or the `update` subcommand of
2766 linkgit:git-remote[1].
2768 remote.<name>.receivepack::
2769 The default program to execute on the remote side when pushing. See
2770 option --receive-pack of linkgit:git-push[1].
2772 remote.<name>.uploadpack::
2773 The default program to execute on the remote side when fetching. See
2774 option --upload-pack of linkgit:git-fetch-pack[1].
2776 remote.<name>.tagOpt::
2777 Setting this value to --no-tags disables automatic tag following when
2778 fetching from remote <name>. Setting it to --tags will fetch every
2779 tag from remote <name>, even if they are not reachable from remote
2780 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2781 override this setting. See options --tags and --no-tags of
2782 linkgit:git-fetch[1].
2784 remote.<name>.vcs::
2785 Setting this to a value <vcs> will cause Git to interact with
2786 the remote with the git-remote-<vcs> helper.
2788 remote.<name>.prune::
2789 When set to true, fetching from this remote by default will also
2790 remove any remote-tracking references that no longer exist on the
2791 remote (as if the `--prune` option was given on the command line).
2792 Overrides `fetch.prune` settings, if any.
2794 remotes.<group>::
2795 The list of remotes which are fetched by "git remote update
2796 <group>". See linkgit:git-remote[1].
2798 repack.useDeltaBaseOffset::
2799 By default, linkgit:git-repack[1] creates packs that use
2800 delta-base offset. If you need to share your repository with
2801 Git older than version 1.4.4, either directly or via a dumb
2802 protocol such as http, then you need to set this option to
2803 "false" and repack. Access from old Git versions over the
2804 native protocol are unaffected by this option.
2806 repack.packKeptObjects::
2807 If set to true, makes `git repack` act as if
2808 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2809 details. Defaults to `false` normally, but `true` if a bitmap
2810 index is being written (either via `--write-bitmap-index` or
2811 `repack.writeBitmaps`).
2813 repack.writeBitmaps::
2814 When true, git will write a bitmap index when packing all
2815 objects to disk (e.g., when `git repack -a` is run). This
2816 index can speed up the "counting objects" phase of subsequent
2817 packs created for clones and fetches, at the cost of some disk
2818 space and extra time spent on the initial repack. This has
2819 no effect if multiple packfiles are created.
2820 Defaults to false.
2822 rerere.autoUpdate::
2823 When set to true, `git-rerere` updates the index with the
2824 resulting contents after it cleanly resolves conflicts using
2825 previously recorded resolution. Defaults to false.
2827 rerere.enabled::
2828 Activate recording of resolved conflicts, so that identical
2829 conflict hunks can be resolved automatically, should they be
2830 encountered again. By default, linkgit:git-rerere[1] is
2831 enabled if there is an `rr-cache` directory under the
2832 `$GIT_DIR`, e.g. if "rerere" was previously used in the
2833 repository.
2835 sendemail.identity::
2836 A configuration identity. When given, causes values in the
2837 'sendemail.<identity>' subsection to take precedence over
2838 values in the 'sendemail' section. The default identity is
2839 the value of `sendemail.identity`.
2841 sendemail.smtpEncryption::
2842 See linkgit:git-send-email[1] for description. Note that this
2843 setting is not subject to the 'identity' mechanism.
2845 sendemail.smtpssl (deprecated)::
2846 Deprecated alias for 'sendemail.smtpEncryption = ssl'.
2848 sendemail.smtpsslcertpath::
2849 Path to ca-certificates (either a directory or a single file).
2850 Set it to an empty string to disable certificate verification.
2852 sendemail.<identity>.*::
2853 Identity-specific versions of the 'sendemail.*' parameters
2854 found below, taking precedence over those when the this
2855 identity is selected, through command-line or
2856 `sendemail.identity`.
2858 sendemail.aliasesFile::
2859 sendemail.aliasFileType::
2860 sendemail.annotate::
2861 sendemail.bcc::
2863 sendemail.ccCmd::
2864 sendemail.chainReplyTo::
2865 sendemail.confirm::
2866 sendemail.envelopeSender::
2867 sendemail.from::
2868 sendemail.multiEdit::
2869 sendemail.signedoffbycc::
2870 sendemail.smtpPass::
2871 sendemail.suppresscc::
2872 sendemail.suppressFrom::
2874 sendemail.smtpDomain::
2875 sendemail.smtpServer::
2876 sendemail.smtpServerPort::
2877 sendemail.smtpServerOption::
2878 sendemail.smtpUser::
2879 sendemail.thread::
2880 sendemail.transferEncoding::
2881 sendemail.validate::
2882 sendemail.xmailer::
2883 See linkgit:git-send-email[1] for description.
2885 sendemail.signedoffcc (deprecated)::
2886 Deprecated alias for `sendemail.signedoffbycc`.
2888 showbranch.default::
2889 The default set of branches for linkgit:git-show-branch[1].
2890 See linkgit:git-show-branch[1].
2892 status.relativePaths::
2893 By default, linkgit:git-status[1] shows paths relative to the
2894 current directory. Setting this variable to `false` shows paths
2895 relative to the repository root (this was the default for Git
2896 prior to v1.5.4).
2898 status.short::
2899 Set to true to enable --short by default in linkgit:git-status[1].
2900 The option --no-short takes precedence over this variable.
2902 status.branch::
2903 Set to true to enable --branch by default in linkgit:git-status[1].
2904 The option --no-branch takes precedence over this variable.
2906 status.displayCommentPrefix::
2907 If set to true, linkgit:git-status[1] will insert a comment
2908 prefix before each output line (starting with
2909 `core.commentChar`, i.e. `#` by default). This was the
2910 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2911 Defaults to false.
2913 status.showUntrackedFiles::
2914 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2915 files which are not currently tracked by Git. Directories which
2916 contain only untracked files, are shown with the directory name
2917 only. Showing untracked files means that Git needs to lstat() all
2918 the files in the whole repository, which might be slow on some
2919 systems. So, this variable controls how the commands displays
2920 the untracked files. Possible values are:
2921 +
2922 --
2923 * `no` - Show no untracked files.
2924 * `normal` - Show untracked files and directories.
2925 * `all` - Show also individual files in untracked directories.
2926 --
2927 +
2928 If this variable is not specified, it defaults to 'normal'.
2929 This variable can be overridden with the -u|--untracked-files option
2930 of linkgit:git-status[1] and linkgit:git-commit[1].
2932 status.submoduleSummary::
2933 Defaults to false.
2934 If this is set to a non zero number or true (identical to -1 or an
2935 unlimited number), the submodule summary will be enabled and a
2936 summary of commits for modified submodules will be shown (see
2937 --summary-limit option of linkgit:git-submodule[1]). Please note
2938 that the summary output command will be suppressed for all
2939 submodules when `diff.ignoreSubmodules` is set to 'all' or only
2940 for those submodules where `submodule.<name>.ignore=all`. The only
2941 exception to that rule is that status and commit will show staged
2942 submodule changes. To
2943 also view the summary for ignored submodules you can either use
2944 the --ignore-submodules=dirty command-line option or the 'git
2945 submodule summary' command, which shows a similar output but does
2946 not honor these settings.
2948 stash.showPatch::
2949 If this is set to true, the `git stash show` command without an
2950 option will show the stash in patch form. Defaults to false.
2951 See description of 'show' command in linkgit:git-stash[1].
2953 stash.showStat::
2954 If this is set to true, the `git stash show` command without an
2955 option will show diffstat of the stash. Defaults to true.
2956 See description of 'show' command in linkgit:git-stash[1].
2958 submodule.<name>.url::
2959 The URL for a submodule. This variable is copied from the .gitmodules
2960 file to the git config via 'git submodule init'. The user can change
2961 the configured URL before obtaining the submodule via 'git submodule
2962 update'. After obtaining the submodule, the presence of this variable
2963 is used as a sign whether the submodule is of interest to git commands.
2964 See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2966 submodule.<name>.update::
2967 The default update procedure for a submodule. This variable
2968 is populated by `git submodule init` from the
2969 linkgit:gitmodules[5] file. See description of 'update'
2970 command in linkgit:git-submodule[1].
2972 submodule.<name>.branch::
2973 The remote branch name for a submodule, used by `git submodule
2974 update --remote`. Set this option to override the value found in
2975 the `.gitmodules` file. See linkgit:git-submodule[1] and
2976 linkgit:gitmodules[5] for details.
2978 submodule.<name>.fetchRecurseSubmodules::
2979 This option can be used to control recursive fetching of this
2980 submodule. It can be overridden by using the --[no-]recurse-submodules
2981 command-line option to "git fetch" and "git pull".
2982 This setting will override that from in the linkgit:gitmodules[5]
2983 file.
2985 submodule.<name>.ignore::
2986 Defines under what circumstances "git status" and the diff family show
2987 a submodule as modified. When set to "all", it will never be considered
2988 modified (but it will nonetheless show up in the output of status and
2989 commit when it has been staged), "dirty" will ignore all changes
2990 to the submodules work tree and
2991 takes only differences between the HEAD of the submodule and the commit
2992 recorded in the superproject into account. "untracked" will additionally
2993 let submodules with modified tracked files in their work tree show up.
2994 Using "none" (the default when this option is not set) also shows
2995 submodules that have untracked files in their work tree as changed.
2996 This setting overrides any setting made in .gitmodules for this submodule,
2997 both settings can be overridden on the command line by using the
2998 "--ignore-submodules" option. The 'git submodule' commands are not
2999 affected by this setting.
3001 submodule.fetchJobs::
3002 Specifies how many submodules are fetched/cloned at the same time.
3003 A positive integer allows up to that number of submodules fetched
3004 in parallel. A value of 0 will give some reasonable default.
3005 If unset, it defaults to 1.
3007 submodule.alternateLocation::
3008 Specifies how the submodules obtain alternates when submodules are
3009 cloned. Possible values are `no`, `superproject`.
3010 By default `no` is assumed, which doesn't add references. When the
3011 value is set to `superproject` the submodule to be cloned computes
3012 its alternates location relative to the superprojects alternate.
3014 submodule.alternateErrorStrategy::
3015 Specifies how to treat errors with the alternates for a submodule
3016 as computed via `submodule.alternateLocation`. Possible values are
3017 `ignore`, `info`, `die`. Default is `die`.
3019 tag.forceSignAnnotated::
3020 A boolean to specify whether annotated tags created should be GPG signed.
3021 If `--annotate` is specified on the command line, it takes
3022 precedence over this option.
3024 tag.sort::
3025 This variable controls the sort ordering of tags when displayed by
3026 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3027 value of this variable will be used as the default.
3029 tar.umask::
3030 This variable can be used to restrict the permission bits of
3031 tar archive entries. The default is 0002, which turns off the
3032 world write bit. The special value "user" indicates that the
3033 archiving user's umask will be used instead. See umask(2) and
3034 linkgit:git-archive[1].
3036 transfer.fsckObjects::
3037 When `fetch.fsckObjects` or `receive.fsckObjects` are
3038 not set, the value of this variable is used instead.
3039 Defaults to false.
3041 transfer.hideRefs::
3042 String(s) `receive-pack` and `upload-pack` use to decide which
3043 refs to omit from their initial advertisements. Use more than
3044 one definition to specify multiple prefix strings. A ref that is
3045 under the hierarchies listed in the value of this variable is
3046 excluded, and is hidden when responding to `git push` or `git
3047 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
3048 program-specific versions of this config.
3049 +
3050 You may also include a `!` in front of the ref name to negate the entry,
3051 explicitly exposing it, even if an earlier entry marked it as hidden.
3052 If you have multiple hideRefs values, later entries override earlier ones
3053 (and entries in more-specific config files override less-specific ones).
3054 +
3055 If a namespace is in use, the namespace prefix is stripped from each
3056 reference before it is matched against `transfer.hiderefs` patterns.
3057 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3058 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3059 is omitted from the advertisements but `refs/heads/master` and
3060 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3061 "have" lines. In order to match refs before stripping, add a `^` in front of
3062 the ref name. If you combine `!` and `^`, `!` must be specified first.
3063 +
3064 Even if you hide refs, a client may still be able to steal the target
3065 objects via the techniques described in the "SECURITY" section of the
3066 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3067 separate repository.
3069 transfer.unpackLimit::
3070 When `fetch.unpackLimit` or `receive.unpackLimit` are
3071 not set, the value of this variable is used instead.
3072 The default value is 100.
3074 uploadarchive.allowUnreachable::
3075 If true, allow clients to use `git archive --remote` to request
3076 any tree, whether reachable from the ref tips or not. See the
3077 discussion in the "SECURITY" section of
3078 linkgit:git-upload-archive[1] for more details. Defaults to
3079 `false`.
3081 uploadpack.hideRefs::
3082 This variable is the same as `transfer.hideRefs`, but applies
3083 only to `upload-pack` (and so affects only fetches, not pushes).
3084 An attempt to fetch a hidden ref by `git fetch` will fail. See
3085 also `uploadpack.allowTipSHA1InWant`.
3087 uploadpack.allowTipSHA1InWant::
3088 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3089 to accept a fetch request that asks for an object at the tip
3090 of a hidden ref (by default, such a request is rejected).
3091 See also `uploadpack.hideRefs`. Even if this is false, a client
3092 may be able to steal objects via the techniques described in the
3093 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3094 best to keep private data in a separate repository.
3096 uploadpack.allowReachableSHA1InWant::
3097 Allow `upload-pack` to accept a fetch request that asks for an
3098 object that is reachable from any ref tip. However, note that
3099 calculating object reachability is computationally expensive.
3100 Defaults to `false`. Even if this is false, a client may be able
3101 to steal objects via the techniques described in the "SECURITY"
3102 section of the linkgit:gitnamespaces[7] man page; it's best to
3103 keep private data in a separate repository.
3105 uploadpack.allowAnySHA1InWant::
3106 Allow `upload-pack` to accept a fetch request that asks for any
3107 object at all.
3108 Defaults to `false`.
3110 uploadpack.keepAlive::
3111 When `upload-pack` has started `pack-objects`, there may be a
3112 quiet period while `pack-objects` prepares the pack. Normally
3113 it would output progress information, but if `--quiet` was used
3114 for the fetch, `pack-objects` will output nothing at all until
3115 the pack data begins. Some clients and networks may consider
3116 the server to be hung and give up. Setting this option instructs
3117 `upload-pack` to send an empty keepalive packet every
3118 `uploadpack.keepAlive` seconds. Setting this option to 0
3119 disables keepalive packets entirely. The default is 5 seconds.
3121 uploadpack.packObjectsHook::
3122 If this option is set, when `upload-pack` would run
3123 `git pack-objects` to create a packfile for a client, it will
3124 run this shell command instead. The `pack-objects` command and
3125 arguments it _would_ have run (including the `git pack-objects`
3126 at the beginning) are appended to the shell command. The stdin
3127 and stdout of the hook are treated as if `pack-objects` itself
3128 was run. I.e., `upload-pack` will feed input intended for
3129 `pack-objects` to the hook, and expects a completed packfile on
3130 stdout.
3131 +
3132 Note that this configuration variable is ignored if it is seen in the
3133 repository-level config (this is a safety measure against fetching from
3134 untrusted repositories).
3136 url.<base>.insteadOf::
3137 Any URL that starts with this value will be rewritten to
3138 start, instead, with <base>. In cases where some site serves a
3139 large number of repositories, and serves them with multiple
3140 access methods, and some users need to use different access
3141 methods, this feature allows people to specify any of the
3142 equivalent URLs and have Git automatically rewrite the URL to
3143 the best alternative for the particular user, even for a
3144 never-before-seen repository on the site. When more than one
3145 insteadOf strings match a given URL, the longest match is used.
3147 url.<base>.pushInsteadOf::
3148 Any URL that starts with this value will not be pushed to;
3149 instead, it will be rewritten to start with <base>, and the
3150 resulting URL will be pushed to. In cases where some site serves
3151 a large number of repositories, and serves them with multiple
3152 access methods, some of which do not allow push, this feature
3153 allows people to specify a pull-only URL and have Git
3154 automatically use an appropriate URL to push, even for a
3155 never-before-seen repository on the site. When more than one
3156 pushInsteadOf strings match a given URL, the longest match is
3157 used. If a remote has an explicit pushurl, Git will ignore this
3158 setting for that remote.
3161 Your email address to be recorded in any newly created commits.
3162 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3163 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
3166 Your full name to be recorded in any newly created commits.
3167 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3168 environment variables. See linkgit:git-commit-tree[1].
3170 user.useConfigOnly::
3171 Instruct Git to avoid trying to guess defaults for ``
3172 and ``, and instead retrieve the values only from the
3173 configuration. For example, if you have multiple email addresses
3174 and would like to use a different one for each repository, then
3175 with this configuration option set to `true` in the global config
3176 along with a name, Git will prompt you to set up an email before
3177 making new commits in a newly cloned repository.
3178 Defaults to `false`.
3180 user.signingKey::
3181 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3182 key you want it to automatically when creating a signed tag or
3183 commit, you can override the default selection with this variable.
3184 This option is passed unchanged to gpg's --local-user parameter,
3185 so you may specify a key using any method that gpg supports.
3187 versionsort.prereleaseSuffix (deprecated)::
3188 Deprecated alias for `versionsort.suffix`. Ignored if
3189 `versionsort.suffix` is set.
3191 versionsort.suffix::
3192 Even when version sort is used in linkgit:git-tag[1], tagnames
3193 with the same base version but different suffixes are still sorted
3194 lexicographically, resulting e.g. in prerelease tags appearing
3195 after the main release (e.g. "1.0-rc1" after "1.0"). This
3196 variable can be specified to determine the sorting order of tags
3197 with different suffixes.
3198 +
3199 By specifying a single suffix in this variable, any tagname containing
3200 that suffix will appear before the corresponding main release. E.g. if
3201 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3202 "1.0". If specified multiple times, once per suffix, then the order of
3203 suffixes in the configuration will determine the sorting order of tagnames
3204 with those suffixes. E.g. if "-pre" appears before "-rc" in the
3205 configuration, then all "1.0-preX" tags will be listed before any
3206 "1.0-rcX" tags. The placement of the main release tag relative to tags
3207 with various suffixes can be determined by specifying the empty suffix
3208 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
3209 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3210 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3211 "v4.8-bfsX".
3212 +
3213 If more than one suffixes match the same tagname, then that tagname will
3214 be sorted according to the suffix which starts at the earliest position in
3215 the tagname. If more than one different matching suffixes start at
3216 that earliest position, then that tagname will be sorted according to the
3217 longest of those suffixes.
3218 The sorting order between different suffixes is undefined if they are
3219 in multiple config files.
3221 web.browser::
3222 Specify a web browser that may be used by some commands.
3223 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3224 may use it.