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
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:
39 [section "subsection"]
43 Subsection names are case sensitive and can contain any characters except
44 newline and the null byte. Doublequote `"` and backslash can be included
45 by escaping them as `\"` and `\\`, respectively. Backslashes preceding
46 other characters are dropped when reading; for example, `\t` is read as
47 `t` and `\0` is read as `0` Section headers cannot span multiple lines.
48 Variables may belong directly to a section or to a given subsection. You
49 can have `[section]` if you have `[section "subsection"]`, but you don't
52 There is also a deprecated `[section.subsection]` syntax. With this
53 syntax, the subsection name is converted to lower-case and is also
54 compared case sensitively. These subsection names follow the same
55 restrictions as section names.
57 All the other lines (and the remainder of the line after the section
58 header) are recognized as setting variables, in the form
59 'name = value' (or just 'name', which is a short-hand to say that
60 the variable is the boolean "true").
61 The variable names are case-insensitive, allow only alphanumeric characters
62 and `-`, and must start with an alphabetic character.
64 A line that defines a value can be continued to the next line by
65 ending it with a `\`; the backquote and the end-of-line are
66 stripped. Leading whitespaces after 'name =', the remainder of the
67 line after the first comment character '#' or ';', and trailing
68 whitespaces of the line are discarded unless they are enclosed in
69 double quotes. Internal whitespaces within the value are retained
72 Inside double quotes, double quote `"` and backslash `\` characters
73 must be escaped: use `\"` for `"` and `\\` for `\`.
75 The following escape sequences (beside `\"` and `\\`) are recognized:
76 `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
77 and `\b` for backspace (BS). Other char escape sequences (including octal
78 escape sequences) are invalid.
84 The `include` and `includeIf` sections allow you to include config
85 directives from another source. These sections behave identically to
86 each other with the exception that `includeIf` sections may be ignored
87 if their condition does not evaluate to true; see "Conditional includes"
90 You can include a config file from another by setting the special
91 `include.path` (or `includeIf.*.path`) variable to the name of the file
92 to be included. The variable takes a pathname as its value, and is
93 subject to tilde expansion. These variables can be given multiple times.
95 The contents of the included file are inserted immediately, as if they
96 had been found at the location of the include directive. If the value of the
97 variable is a relative path, the path is considered to
98 be relative to the configuration file in which the include directive
99 was found. See below for examples.
104 You can include a config file from another conditionally by setting a
105 `includeIf.<condition>.path` variable to the name of the file to be
108 The condition starts with a keyword followed by a colon and some data
109 whose format and meaning depends on the keyword. Supported keywords
114 The data that follows the keyword `gitdir:` is used as a glob
115 pattern. If the location of the .git directory matches the
116 pattern, the include condition is met.
118 The .git location may be auto-discovered, or come from `$GIT_DIR`
119 environment variable. If the repository is auto discovered via a .git
120 file (e.g. from submodules, or a linked worktree), the .git location
121 would be the final location where the .git directory is, not where the
124 The pattern can contain standard globbing wildcards and two additional
125 ones, `**/` and `/**`, that can match multiple path components. Please
126 refer to linkgit:gitignore[5] for details. For convenience:
128 * If the pattern starts with `~/`, `~` will be substituted with the
129 content of the environment variable `HOME`.
131 * If the pattern starts with `./`, it is replaced with the directory
132 containing the current config file.
134 * If the pattern does not start with either `~/`, `./` or `/`, `**/`
135 will be automatically prepended. For example, the pattern `foo/bar`
136 becomes `**/foo/bar` and would match `/any/path/to/foo/bar`.
138 * If the pattern ends with `/`, `**` will be automatically added. For
139 example, the pattern `foo/` becomes `foo/**`. In other words, it
140 matches "foo" and everything inside, recursively.
143 This is the same as `gitdir` except that matching is done
144 case-insensitively (e.g. on case-insensitive file sytems)
146 A few more notes on matching via `gitdir` and `gitdir/i`:
148 * Symlinks in `$GIT_DIR` are not resolved before matching.
150 * Both the symlink & realpath versions of paths will be matched
151 outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
152 /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
155 This was not the case in the initial release of this feature in
156 v2.13.0, which only matched the realpath version. Configuration that
157 wants to be compatible with the initial release of this feature needs
158 to either specify only the realpath version, or both versions.
160 * Note that "../" is not special and will match literally, which is
161 unlikely what you want.
168 ; Don't trust file modes
173 external = /usr/local/bin/diff-wrapper
178 merge = refs/heads/devel
182 gitProxy="ssh" for "kernel.org"
183 gitProxy=default-proxy ; for the rest
186 path = /path/to/foo.inc ; include by absolute path
187 path = foo.inc ; find "foo.inc" relative to the current file
188 path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
190 ; include if $GIT_DIR is /path/to/foo/.git
191 [includeIf "gitdir:/path/to/foo/.git"]
192 path = /path/to/foo.inc
194 ; include for all repositories inside /path/to/group
195 [includeIf "gitdir:/path/to/group/"]
196 path = /path/to/foo.inc
198 ; include for all repositories inside $HOME/to/group
199 [includeIf "gitdir:~/to/group/"]
200 path = /path/to/foo.inc
202 ; relative paths are always relative to the including
203 ; file (if the condition is true); their location is not
204 ; affected by the condition
205 [includeIf "gitdir:/path/to/group/"]
211 Values of many variables are treated as a simple string, but there
212 are variables that take values of specific types and there are rules
213 as to how to spell them.
217 When a variable is said to take a boolean value, many
218 synonyms are accepted for 'true' and 'false'; these are all
221 true;; Boolean true literals are `yes`, `on`, `true`,
222 and `1`. Also, a variable defined without `= <value>`
225 false;; Boolean false literals are `no`, `off`, `false`,
226 `0` and the empty string.
228 When converting a value to its canonical form using the `--type=bool` type
229 specifier, 'git config' will ensure that the output is "true" or
230 "false" (spelled in lowercase).
233 The value for many variables that specify various sizes can
234 be suffixed with `k`, `M`,... to mean "scale the number by
235 1024", "by 1024x1024", etc.
238 The value for a variable that takes a color is a list of
239 colors (at most two, one for foreground and one for background)
240 and attributes (as many as you want), separated by spaces.
242 The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
243 `blue`, `magenta`, `cyan` and `white`. The first color given is the
244 foreground; the second is the background.
246 Colors may also be given as numbers between 0 and 255; these use ANSI
247 256-color mode (but note that not all terminals may support this). If
248 your terminal supports it, you may also specify 24-bit RGB values as
251 The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
252 `italic`, and `strike` (for crossed-out or "strikethrough" letters).
253 The position of any attributes with respect to the colors
254 (before, after, or in between), doesn't matter. Specific attributes may
255 be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
258 An empty color string produces no color effect at all. This can be used
259 to avoid coloring specific elements without disabling color entirely.
261 For git's pre-defined color slots, the attributes are meant to be reset
262 at the beginning of each item in the colored output. So setting
263 `color.decorate.branch` to `black` will paint that branch name in a
264 plain `black`, even if the previous thing on the same output line (e.g.
265 opening parenthesis before the list of branch names in `log --decorate`
266 output) is set to be painted with `bold` or some other attribute.
267 However, custom log formats may do more complicated and layered
268 coloring, and the negated forms may be useful there.
271 A variable that takes a pathname value can be given a
272 string that begins with "`~/`" or "`~user/`", and the usual
273 tilde expansion happens to such a string: `~/`
274 is expanded to the value of `$HOME`, and `~user/` to the
275 specified user's home directory.
281 Note that this list is non-comprehensive and not necessarily complete.
282 For command-specific variables, you will find a more detailed description
283 in the appropriate manual page.
285 Other git-related tools may and do use their own variables. When
286 inventing new variables for use in your own tool, make sure their
287 names do not conflict with those that are used by Git itself and
288 other popular tools, and describe them in your documentation.
290 include::config/advice.txt[]
292 include::config/core.txt[]
294 include::config/add.txt[]
296 include::config/alias.txt[]
298 include::config/am.txt[]
300 include::config/apply.txt[]
302 include::config/blame.txt[]
304 include::config/branch.txt[]
306 include::config/browser.txt[]
308 include::config/checkout.txt[]
310 include::config/clean.txt[]
312 include::config/color.txt[]
315 Specify whether supported commands should output in columns.
316 This variable consists of a list of tokens separated by spaces
319 These options control when the feature should be enabled
320 (defaults to 'never'):
324 always show in columns
326 never show in columns
328 show in columns if the output is to the terminal
331 These options control layout (defaults to 'column'). Setting any
332 of these implies 'always' if none of 'always', 'never', or 'auto' are
337 fill columns before rows
339 fill rows before columns
344 Finally, these options can be combined with a layout option (defaults
349 make unequal size columns to utilize more space
351 make equal size columns
355 Specify whether to output branch listing in `git branch` in columns.
356 See `column.ui` for details.
359 Specify the layout when list items in `git clean -i`, which always
360 shows files and directories in columns. See `column.ui` for details.
363 Specify whether to output untracked files in `git status` in columns.
364 See `column.ui` for details.
367 Specify whether to output tag listing in `git tag` in columns.
368 See `column.ui` for details.
371 This setting overrides the default of the `--cleanup` option in
372 `git commit`. See linkgit:git-commit[1] for details. Changing the
373 default can be useful when you always want to keep lines that begin
374 with comment character `#` in your log message, in which case you
375 would do `git config commit.cleanup whitespace` (note that you will
376 have to remove the help lines that begin with `#` in the commit log
377 template yourself, if you do this).
381 A boolean to specify whether all commits should be GPG signed.
382 Use of this option when doing operations such as rebase can
383 result in a large number of commits being signed. It may be
384 convenient to use an agent to avoid typing your GPG passphrase
388 A boolean to enable/disable inclusion of status information in the
389 commit message template when using an editor to prepare the commit
390 message. Defaults to true.
393 Specify the pathname of a file to use as the template for
397 A boolean or int to specify the level of verbose with `git commit`.
398 See linkgit:git-commit[1].
401 Specify an external helper to be called when a username or
402 password credential is needed; the helper may consult external
403 storage to avoid prompting the user for the credentials. Note
404 that multiple helpers may be defined. See linkgit:gitcredentials[7]
407 credential.useHttpPath::
408 When acquiring credentials, consider the "path" component of an http
409 or https URL to be important. Defaults to false. See
410 linkgit:gitcredentials[7] for more information.
412 credential.username::
413 If no username is set for a network authentication, use this username
414 by default. See credential.<context>.* below, and
415 linkgit:gitcredentials[7].
418 Any of the credential.* options above can be applied selectively to
419 some credentials. For example "credential.https://example.com.username"
420 would set the default username only for https connections to
421 example.com. See linkgit:gitcredentials[7] for details on how URLs are
424 credentialCache.ignoreSIGHUP::
425 Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
427 completion.commands::
428 This is only used by git-completion.bash to add or remove
429 commands from the list of completed commands. Normally only
430 porcelain commands and a few select others are completed. You
431 can add more commands, separated by space, in this
432 variable. Prefixing the command with '-' will remove it from
435 include::diff-config.txt[]
437 difftool.<tool>.path::
438 Override the path for the given tool. This is useful in case
439 your tool is not in the PATH.
441 difftool.<tool>.cmd::
442 Specify the command to invoke the specified diff tool.
443 The specified command is evaluated in shell with the following
444 variables available: 'LOCAL' is set to the name of the temporary
445 file containing the contents of the diff pre-image and 'REMOTE'
446 is set to the name of the temporary file containing the contents
447 of the diff post-image.
450 Prompt before each invocation of the diff tool.
452 fastimport.unpackLimit::
453 If the number of objects imported by linkgit:git-fast-import[1]
454 is below this limit, then the objects will be unpacked into
455 loose object files. However if the number of imported objects
456 equals or exceeds this limit then the pack will be stored as a
457 pack. Storing the pack from a fast-import can make the import
458 operation complete faster, especially on slow filesystems. If
459 not set, the value of `transfer.unpackLimit` is used instead.
461 include::fetch-config.txt[]
463 include::format-config.txt[]
465 filter.<driver>.clean::
466 The command which is used to convert the content of a worktree
467 file to a blob upon checkin. See linkgit:gitattributes[5] for
470 filter.<driver>.smudge::
471 The command which is used to convert the content of a blob
472 object to a worktree file upon checkout. See
473 linkgit:gitattributes[5] for details.
476 During fsck git may find issues with legacy data which
477 wouldn't be generated by current versions of git, and which
478 wouldn't be sent over the wire if `transfer.fsckObjects` was
479 set. This feature is intended to support working with legacy
480 repositories containing such data.
482 Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
483 to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
484 to clone or fetch it set `fetch.fsck.<msg-id>`.
486 The rest of the documentation discusses `fsck.*` for brevity, but the
487 same applies for the corresponding `receive.fsck.*` and
488 `fetch.<msg-id>.*`. variables.
490 Unlike variables like `color.ui` and `core.editor` the
491 `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
492 fall back on the `fsck.<msg-id>` configuration if they aren't set. To
493 uniformly configure the same fsck settings in different circumstances
494 all three of them they must all set to the same values.
496 When `fsck.<msg-id>` is set, errors can be switched to warnings and
497 vice versa by configuring the `fsck.<msg-id>` setting where the
498 `<msg-id>` is the fsck message ID and the value is one of `error`,
499 `warn` or `ignore`. For convenience, fsck prefixes the error/warning
500 with the message ID, e.g. "missingEmail: invalid author/committer line
501 - missing email" means that setting `fsck.missingEmail = ignore` will
504 In general, it is better to enumerate existing objects with problems
505 with `fsck.skipList`, instead of listing the kind of breakages these
506 problematic objects share to be ignored, as doing the latter will
507 allow new instances of the same breakages go unnoticed.
509 Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
510 doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
511 will only cause git to warn.
514 The path to a list of object names (i.e. one unabbreviated SHA-1 per
515 line) that are known to be broken in a non-fatal way and should
516 be ignored. On versions of Git 2.20 and later comments ('#'), empty
517 lines, and any leading and trailing whitespace is ignored. Everything
518 but a SHA-1 per line will error out on older versions.
520 This feature is useful when an established project should be accepted
521 despite early commits containing errors that can be safely ignored
522 such as invalid committer email addresses. Note: corrupt objects
523 cannot be skipped with this setting.
525 Like `fsck.<msg-id>` this variable has corresponding
526 `receive.fsck.skipList` and `fetch.fsck.skipList` variants.
528 Unlike variables like `color.ui` and `core.editor` the
529 `receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
530 fall back on the `fsck.skipList` configuration if they aren't set. To
531 uniformly configure the same fsck settings in different circumstances
532 all three of them they must all set to the same values.
534 Older versions of Git (before 2.20) documented that the object names
535 list should be sorted. This was never a requirement, the object names
536 could appear in any order, but when reading the list we tracked whether
537 the list was sorted for the purposes of an internal binary search
538 implementation, which could save itself some work with an already sorted
539 list. Unless you had a humongous list there was no reason to go out of
540 your way to pre-sort the list. After Git version 2.20 a hash implementation
541 is used instead, so there's now no reason to pre-sort the list.
544 The depth parameter used in the delta compression
545 algorithm used by 'git gc --aggressive'. This defaults
548 gc.aggressiveWindow::
549 The window size parameter used in the delta compression
550 algorithm used by 'git gc --aggressive'. This defaults
554 When there are approximately more than this many loose
555 objects in the repository, `git gc --auto` will pack them.
556 Some Porcelain commands use this command to perform a
557 light-weight garbage collection from time to time. The
558 default value is 6700. Setting this to 0 disables it.
561 When there are more than this many packs that are not
562 marked with `*.keep` file in the repository, `git gc
563 --auto` consolidates them into one larger pack. The
564 default value is 50. Setting this to 0 disables it.
567 Make `git gc --auto` return immediately and run in background
568 if the system supports it. Default is true.
570 gc.bigPackThreshold::
571 If non-zero, all packs larger than this limit are kept when
572 `git gc` is run. This is very similar to `--keep-base-pack`
573 except that all packs that meet the threshold are kept, not
574 just the base pack. Defaults to zero. Common unit suffixes of
575 'k', 'm', or 'g' are supported.
577 Note that if the number of kept packs is more than gc.autoPackLimit,
578 this configuration variable is ignored, all packs except the base pack
579 will be repacked. After this the number of packs should go below
580 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
582 gc.writeCommitGraph::
583 If true, then gc will rewrite the commit-graph file when
584 linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
585 '--auto' the commit-graph will be updated if housekeeping is
586 required. Default is false. See linkgit:git-commit-graph[1]
590 If the file gc.log exists, then `git gc --auto` will print
591 its content and exit with status zero instead of running
592 unless that file is more than 'gc.logExpiry' old. Default is
593 "1.day". See `gc.pruneExpire` for more ways to specify its
597 Running `git pack-refs` in a repository renders it
598 unclonable by Git versions prior to 1.5.1.2 over dumb
599 transports such as HTTP. This variable determines whether
600 'git gc' runs `git pack-refs`. This can be set to `notbare`
601 to enable it within all non-bare repos or it can be set to a
602 boolean value. The default is `true`.
605 When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
606 Override the grace period with this config variable. The value
607 "now" may be used to disable this grace period and always prune
608 unreachable objects immediately, or "never" may be used to
609 suppress pruning. This feature helps prevent corruption when
610 'git gc' runs concurrently with another process writing to the
611 repository; see the "NOTES" section of linkgit:git-gc[1].
613 gc.worktreePruneExpire::
614 When 'git gc' is run, it calls
615 'git worktree prune --expire 3.months.ago'.
616 This config variable can be used to set a different grace
617 period. The value "now" may be used to disable the grace
618 period and prune `$GIT_DIR/worktrees` immediately, or "never"
619 may be used to suppress pruning.
622 gc.<pattern>.reflogExpire::
623 'git reflog expire' removes reflog entries older than
624 this time; defaults to 90 days. The value "now" expires all
625 entries immediately, and "never" suppresses expiration
626 altogether. With "<pattern>" (e.g.
627 "refs/stash") in the middle the setting applies only to
628 the refs that match the <pattern>.
630 gc.reflogExpireUnreachable::
631 gc.<pattern>.reflogExpireUnreachable::
632 'git reflog expire' removes reflog entries older than
633 this time and are not reachable from the current tip;
634 defaults to 30 days. The value "now" expires all entries
635 immediately, and "never" suppresses expiration altogether.
636 With "<pattern>" (e.g. "refs/stash")
637 in the middle, the setting applies only to the refs that
641 Records of conflicted merge you resolved earlier are
642 kept for this many days when 'git rerere gc' is run.
643 You can also use more human-readable "1.month.ago", etc.
644 The default is 60 days. See linkgit:git-rerere[1].
646 gc.rerereUnresolved::
647 Records of conflicted merge you have not resolved are
648 kept for this many days when 'git rerere gc' is run.
649 You can also use more human-readable "1.month.ago", etc.
650 The default is 15 days. See linkgit:git-rerere[1].
652 include::gitcvs-config.txt[]
658 See linkgit:gitweb[1] for description.
666 gitweb.remote_heads::
669 See linkgit:gitweb.conf[5] for description.
672 If set to true, enable `-n` option by default.
675 If set to true, enable the `--column` option by default.
678 Set the default matching behavior. Using a value of 'basic', 'extended',
679 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
680 `--fixed-strings`, or `--perl-regexp` option accordingly, while the
681 value 'default' will return to the default matching behavior.
683 grep.extendedRegexp::
684 If set to true, enable `--extended-regexp` option by default. This
685 option is ignored when the `grep.patternType` option is set to a value
686 other than 'default'.
689 Number of grep worker threads to use.
690 See `grep.threads` in linkgit:git-grep[1] for more information.
692 grep.fallbackToNoIndex::
693 If set to true, fall back to git grep --no-index if git grep
694 is executed outside of a git repository. Defaults to false.
697 Use this custom program instead of "`gpg`" found on `$PATH` when
698 making or verifying a PGP signature. The program must support the
699 same command-line interface as GPG, namely, to verify a detached
700 signature, "`gpg --verify $file - <$signature`" is run, and the
701 program is expected to signal a good signature by exiting with
702 code 0, and to generate an ASCII-armored detached signature, the
703 standard input of "`gpg -bsau $key`" is fed with the contents to be
704 signed, and the program is expected to send the result to its
708 Specifies which key format to use when signing with `--gpg-sign`.
709 Default is "openpgp" and another possible value is "x509".
711 gpg.<format>.program::
712 Use this to customize the program used for the signing format you
713 chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
714 be used as a legacy synonym for `gpg.openpgp.program`. The default
715 value for `gpg.x509.program` is "gpgsm".
717 include::gui-config.txt[]
720 Specifies the shell command line to execute when the corresponding item
721 of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
722 mandatory for every tool. The command is executed from the root of
723 the working directory, and in the environment it receives the name of
724 the tool as `GIT_GUITOOL`, the name of the currently selected file as
725 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
726 the head is detached, 'CUR_BRANCH' is empty).
728 guitool.<name>.needsFile::
729 Run the tool only if a diff is selected in the GUI. It guarantees
730 that 'FILENAME' is not empty.
732 guitool.<name>.noConsole::
733 Run the command silently, without creating a window to display its
736 guitool.<name>.noRescan::
737 Don't rescan the working directory for changes after the tool
740 guitool.<name>.confirm::
741 Show a confirmation dialog before actually running the tool.
743 guitool.<name>.argPrompt::
744 Request a string argument from the user, and pass it to the tool
745 through the `ARGS` environment variable. Since requesting an
746 argument implies confirmation, the 'confirm' option has no effect
747 if this is enabled. If the option is set to 'true', 'yes', or '1',
748 the dialog uses a built-in generic prompt; otherwise the exact
749 value of the variable is used.
751 guitool.<name>.revPrompt::
752 Request a single valid revision from the user, and set the
753 `REVISION` environment variable. In other aspects this option
754 is similar to 'argPrompt', and can be used together with it.
756 guitool.<name>.revUnmerged::
757 Show only unmerged branches in the 'revPrompt' subdialog.
758 This is useful for tools similar to merge or rebase, but not
759 for things like checkout or reset.
761 guitool.<name>.title::
762 Specifies the title to use for the prompt dialog. The default
765 guitool.<name>.prompt::
766 Specifies the general prompt string to display at the top of
767 the dialog, before subsections for 'argPrompt' and 'revPrompt'.
768 The default value includes the actual command.
771 Specify the browser that will be used to display help in the
772 'web' format. See linkgit:git-help[1].
775 Override the default help format used by linkgit:git-help[1].
776 Values 'man', 'info', 'web' and 'html' are supported. 'man' is
777 the default. 'web' and 'html' are the same.
780 Automatically correct and execute mistyped commands after
781 waiting for the given number of deciseconds (0.1 sec). If more
782 than one command can be deduced from the entered text, nothing
783 will be executed. If the value of this option is negative,
784 the corrected command will be executed immediately. If the
785 value is 0 - the command will be just shown but not executed.
789 Specify the path where the HTML documentation resides. File system paths
790 and URLs are supported. HTML pages will be prefixed with this path when
791 help is displayed in the 'web' format. This defaults to the documentation
792 path of your Git installation.
795 Override the HTTP proxy, normally configured using the 'http_proxy',
796 'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
797 addition to the syntax understood by curl, it is possible to specify a
798 proxy string with a user name but no password, in which case git will
799 attempt to acquire one in the same way it does for other credentials. See
800 linkgit:gitcredentials[7] for more information. The syntax thus is
801 '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
802 on a per-remote basis; see remote.<name>.proxy
804 http.proxyAuthMethod::
805 Set the method with which to authenticate against the HTTP proxy. This
806 only takes effect if the configured proxy string contains a user name part
807 (i.e. is of the form 'user@host' or 'user@host:port'). This can be
808 overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
809 Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
810 variable. Possible values are:
813 * `anyauth` - Automatically pick a suitable authentication method. It is
814 assumed that the proxy answers an unauthenticated request with a 407
815 status code and one or more Proxy-authenticate headers with supported
816 authentication methods. This is the default.
817 * `basic` - HTTP Basic authentication
818 * `digest` - HTTP Digest authentication; this prevents the password from being
819 transmitted to the proxy in clear text
820 * `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
822 * `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
826 Attempt authentication without seeking a username or password. This
827 can be used to attempt GSS-Negotiate authentication without specifying
828 a username in the URL, as libcurl normally requires a username for
832 Control GSSAPI credential delegation. The delegation is disabled
833 by default in libcurl since version 7.21.7. Set parameter to tell
834 the server what it is allowed to delegate when it comes to user
835 credentials. Used with GSS/kerberos. Possible values are:
838 * `none` - Don't allow any delegation.
839 * `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
840 Kerberos service ticket, which is a matter of realm policy.
841 * `always` - Unconditionally allow the server to delegate.
846 Pass an additional HTTP header when communicating with a server. If
847 more than one such entry exists, all of them are added as extra
848 headers. To allow overriding the settings inherited from the system
849 config, an empty value will reset the extra headers to the empty list.
852 The pathname of a file containing previously stored cookie lines,
854 in the Git http session, if they match the server. The file format
855 of the file to read cookies from should be plain HTTP headers or
856 the Netscape/Mozilla cookie file format (see `curl(1)`).
857 NOTE that the file specified with http.cookieFile is used only as
858 input unless http.saveCookies is set.
861 If set, store cookies received during requests to the file specified by
862 http.cookieFile. Has no effect if http.cookieFile is unset.
865 The SSL version to use when negotiating an SSL connection, if you
866 want to force the default. The available and default version
867 depend on whether libcurl was built against NSS or OpenSSL and the
868 particular configuration of the crypto library in use. Internally
869 this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
870 documentation for more details on the format of this option and
871 for the ssl version supported. Actually the possible values of
883 Can be overridden by the `GIT_SSL_VERSION` environment variable.
884 To force git to use libcurl's default ssl version and ignore any
885 explicit http.sslversion option, set `GIT_SSL_VERSION` to the
889 A list of SSL ciphers to use when negotiating an SSL connection.
890 The available ciphers depend on whether libcurl was built against
891 NSS or OpenSSL and the particular configuration of the crypto
892 library in use. Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
893 option; see the libcurl documentation for more details on the format
896 Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
897 To force git to use libcurl's default cipher list and ignore any
898 explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
902 Whether to verify the SSL certificate when fetching or pushing
903 over HTTPS. Defaults to true. Can be overridden by the
904 `GIT_SSL_NO_VERIFY` environment variable.
907 File containing the SSL certificate when fetching or pushing
908 over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
912 File containing the SSL private key when fetching or pushing
913 over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
916 http.sslCertPasswordProtected::
917 Enable Git's password prompt for the SSL certificate. Otherwise
918 OpenSSL will prompt the user, possibly many times, if the
919 certificate or private key is encrypted. Can be overridden by the
920 `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
923 File containing the certificates to verify the peer with when
924 fetching or pushing over HTTPS. Can be overridden by the
925 `GIT_SSL_CAINFO` environment variable.
928 Path containing files with the CA certificates to verify the peer
929 with when fetching or pushing over HTTPS. Can be overridden
930 by the `GIT_SSL_CAPATH` environment variable.
933 Name of the SSL backend to use (e.g. "openssl" or "schannel").
934 This option is ignored if cURL lacks support for choosing the SSL
937 http.schannelCheckRevoke::
938 Used to enforce or disable certificate revocation checks in cURL
939 when http.sslBackend is set to "schannel". Defaults to `true` if
940 unset. Only necessary to disable this if Git consistently errors
941 and the message is about checking the revocation status of a
942 certificate. This option is ignored if cURL lacks support for
943 setting the relevant SSL option at runtime.
945 http.schannelUseSSLCAInfo::
946 As of cURL v7.60.0, the Secure Channel backend can use the
947 certificate bundle provided via `http.sslCAInfo`, but that would
948 override the Windows Certificate Store. Since this is not desirable
949 by default, Git will tell cURL not to use that bundle by default
950 when the `schannel` backend was configured via `http.sslBackend`,
951 unless `http.schannelUseSSLCAInfo` overrides this behavior.
954 Public key of the https service. It may either be the filename of
955 a PEM or DER encoded public key file or a string starting with
956 'sha256//' followed by the base64 encoded sha256 hash of the
957 public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
958 exit with an error if this option is set but not supported by
962 Attempt to use AUTH SSL/TLS and encrypted data transfers
963 when connecting via regular FTP protocol. This might be needed
964 if the FTP server requires it for security reasons or you wish
965 to connect securely whenever remote FTP server supports it.
966 Default is false since it might trigger certificate verification
967 errors on misconfigured servers.
970 How many HTTP requests to launch in parallel. Can be overridden
971 by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
974 The number of curl sessions (counted across slots) to be kept across
975 requests. They will not be ended with curl_easy_cleanup() until
976 http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
977 value will be capped at 1. Defaults to 1.
980 Maximum size in bytes of the buffer used by smart HTTP
981 transports when POSTing data to the remote system.
982 For requests larger than this buffer size, HTTP/1.1 and
983 Transfer-Encoding: chunked is used to avoid creating a
984 massive pack file locally. Default is 1 MiB, which is
985 sufficient for most requests.
987 http.lowSpeedLimit, http.lowSpeedTime::
988 If the HTTP transfer speed is less than 'http.lowSpeedLimit'
989 for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
990 Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
991 `GIT_HTTP_LOW_SPEED_TIME` environment variables.
994 A boolean which disables using of EPSV ftp command by curl.
995 This can helpful with some "poor" ftp servers which don't
996 support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
997 environment variable. Default is false (curl will use EPSV).
1000 The HTTP USER_AGENT string presented to an HTTP server. The default
1001 value represents the version of the client Git such as git/1.7.1.
1002 This option allows you to override this value to a more common value
1003 such as Mozilla/4.0. This may be necessary, for instance, if
1004 connecting through a firewall that restricts HTTP connections to a set
1005 of common USER_AGENT strings (but not including those like git/1.7.1).
1006 Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
1008 http.followRedirects::
1009 Whether git should follow HTTP redirects. If set to `true`, git
1010 will transparently follow any redirect issued by a server it
1011 encounters. If set to `false`, git will treat all redirects as
1012 errors. If set to `initial`, git will follow redirects only for
1013 the initial request to a remote, but not for subsequent
1014 follow-up HTTP requests. Since git uses the redirected URL as
1015 the base for the follow-up requests, this is generally
1016 sufficient. The default is `initial`.
1019 Any of the http.* options above can be applied selectively to some URLs.
1020 For a config key to match a URL, each element of the config key is
1021 compared to that of the URL, in the following order:
1024 . Scheme (e.g., `https` in `https://example.com/`). This field
1025 must match exactly between the config key and the URL.
1027 . Host/domain name (e.g., `example.com` in `https://example.com/`).
1028 This field must match between the config key and the URL. It is
1029 possible to specify a `*` as part of the host name to match all subdomains
1030 at this level. `https://*.example.com/` for example would match
1031 `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
1033 . Port number (e.g., `8080` in `http://example.com:8080/`).
1034 This field must match exactly between the config key and the URL.
1035 Omitted port numbers are automatically converted to the correct
1036 default for the scheme before matching.
1038 . Path (e.g., `repo.git` in `https://example.com/repo.git`). The
1039 path field of the config key must match the path field of the URL
1040 either exactly or as a prefix of slash-delimited path elements. This means
1041 a config key with path `foo/` matches URL path `foo/bar`. A prefix can only
1042 match on a slash (`/`) boundary. Longer matches take precedence (so a config
1043 key with path `foo/bar` is a better match to URL path `foo/bar` than a config
1044 key with just path `foo/`).
1046 . User name (e.g., `user` in `https://user@example.com/repo.git`). If
1047 the config key has a user name it must match the user name in the
1048 URL exactly. If the config key does not have a user name, that
1049 config key will match a URL with any user name (including none),
1050 but at a lower precedence than a config key with a user name.
1053 The list above is ordered by decreasing precedence; a URL that matches
1054 a config key's path is preferred to one that matches its user name. For example,
1055 if the URL is `https://user@example.com/foo/bar` a config key match of
1056 `https://example.com/foo` will be preferred over a config key match of
1057 `https://user@example.com`.
1059 All URLs are normalized before attempting any matching (the password part,
1060 if embedded in the URL, is always ignored for matching purposes) so that
1061 equivalent URLs that are simply spelled differently will match properly.
1062 Environment variable settings always override any matches. The URLs that are
1063 matched against are those given directly to Git commands. This means any URLs
1064 visited as a result of a redirection do not participate in matching.
1067 By default, Git determines the command line arguments to use
1068 based on the basename of the configured SSH command (configured
1069 using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
1070 the config setting `core.sshCommand`). If the basename is
1071 unrecognized, Git will attempt to detect support of OpenSSH
1072 options by first invoking the configured SSH command with the
1073 `-G` (print configuration) option and will subsequently use
1074 OpenSSH options (if that is successful) or no options besides
1075 the host and remote command (if it fails).
1077 The config variable `ssh.variant` can be set to override this detection.
1078 Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
1079 `tortoiseplink`, `simple` (no options except the host and remote command).
1080 The default auto-detection can be explicitly requested using the value
1081 `auto`. Any other value is treated as `ssh`. This setting can also be
1082 overridden via the environment variable `GIT_SSH_VARIANT`.
1084 The current command-line parameters used for each variant are as
1089 * `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
1091 * `simple` - [username@]host command
1093 * `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
1095 * `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
1099 Except for the `simple` variant, command-line parameters are likely to
1100 change as git gains new features.
1102 i18n.commitEncoding::
1103 Character encoding the commit messages are stored in; Git itself
1104 does not care per se, but this information is necessary e.g. when
1105 importing commits from emails or in the gitk graphical history
1106 browser (and possibly at other places in the future or in other
1107 porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
1109 i18n.logOutputEncoding::
1110 Character encoding the commit messages are converted to when
1111 running 'git log' and friends.
1114 The configuration variables in the 'imap' section are described
1115 in linkgit:git-imap-send[1].
1118 Specifies the number of threads to spawn when loading the index.
1119 This is meant to reduce index load time on multiprocessor machines.
1120 Specifying 0 or 'true' will cause Git to auto-detect the number of
1121 CPU's and set the number of threads accordingly. Specifying 1 or
1122 'false' will disable multithreading. Defaults to 'true'.
1125 Specify the version with which new index files should be
1126 initialized. This does not affect existing repositories.
1129 Specify the directory from which templates will be copied.
1130 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
1133 Specify the program that will be used to browse your working
1134 repository in gitweb. See linkgit:git-instaweb[1].
1137 The HTTP daemon command-line to start gitweb on your working
1138 repository. See linkgit:git-instaweb[1].
1141 If true the web server started by linkgit:git-instaweb[1] will
1142 be bound to the local IP (127.0.0.1).
1144 instaweb.modulePath::
1145 The default module path for linkgit:git-instaweb[1] to use
1146 instead of /usr/lib/apache2/modules. Only used if httpd
1150 The port number to bind the gitweb httpd to. See
1151 linkgit:git-instaweb[1].
1153 interactive.singleKey::
1154 In interactive commands, allow the user to provide one-letter
1155 input with a single key (i.e., without hitting enter).
1156 Currently this is used by the `--patch` mode of
1157 linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
1158 linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
1159 setting is silently ignored if portable keystroke input
1160 is not available; requires the Perl module Term::ReadKey.
1162 interactive.diffFilter::
1163 When an interactive command (such as `git add --patch`) shows
1164 a colorized diff, git will pipe the diff through the shell
1165 command defined by this configuration variable. The command may
1166 mark up the diff further for human consumption, provided that it
1167 retains a one-to-one correspondence with the lines in the
1168 original diff. Defaults to disabled (no filtering).
1171 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1172 linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
1173 override this option with `--no-abbrev-commit`.
1176 Set the default date-time mode for the 'log' command.
1177 Setting a value for log.date is similar to using 'git log''s
1178 `--date` option. See linkgit:git-log[1] for details.
1181 Print out the ref names of any commits that are shown by the log
1182 command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1183 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1184 specified, the full ref name (including prefix) will be printed.
1185 If 'auto' is specified, then if the output is going to a terminal,
1186 the ref names are shown as if 'short' were given, otherwise no ref
1187 names are shown. This is the same as the `--decorate` option
1191 If `true`, `git log` will act as if the `--follow` option was used when
1192 a single <path> is given. This has the same limitations as `--follow`,
1193 i.e. it cannot be used to follow multiple files and does not work well
1194 on non-linear history.
1197 A list of colors, separated by commas, that can be used to draw
1198 history lines in `git log --graph`.
1201 If true, the initial commit will be shown as a big creation event.
1202 This is equivalent to a diff against an empty tree.
1203 Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
1204 normally hide the root commit will now show it. True by default.
1207 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1208 linkgit:git-whatchanged[1] assume `--show-signature`.
1211 If true, makes linkgit:git-log[1], linkgit:git-show[1], and
1212 linkgit:git-whatchanged[1] assume `--use-mailmap`.
1215 If true, makes linkgit:git-mailinfo[1] (and therefore
1216 linkgit:git-am[1]) act by default as if the --scissors option
1217 was provided on the command-line. When active, this features
1218 removes everything from the message body before a scissors
1219 line (i.e. consisting mainly of ">8", "8<" and "-").
1222 The location of an augmenting mailmap file. The default
1223 mailmap, located in the root of the repository, is loaded
1224 first, then the mailmap file pointed to by this variable.
1225 The location of the mailmap file may be in a repository
1226 subdirectory, or somewhere outside of the repository itself.
1227 See linkgit:git-shortlog[1] and linkgit:git-blame[1].
1230 Like `mailmap.file`, but consider the value as a reference to a
1231 blob in the repository. If both `mailmap.file` and
1232 `mailmap.blob` are given, both are parsed, with entries from
1233 `mailmap.file` taking precedence. In a bare repository, this
1234 defaults to `HEAD:.mailmap`. In a non-bare repository, it
1238 Specify the programs that may be used to display help in the
1239 'man' format. See linkgit:git-help[1].
1242 Specify the command to invoke the specified man viewer. The
1243 specified command is evaluated in shell with the man page
1244 passed as argument. (See linkgit:git-help[1].)
1247 Override the path for the given tool that may be used to
1248 display help in the 'man' format. See linkgit:git-help[1].
1250 include::merge-config.txt[]
1252 mergetool.<tool>.path::
1253 Override the path for the given tool. This is useful in case
1254 your tool is not in the PATH.
1256 mergetool.<tool>.cmd::
1257 Specify the command to invoke the specified merge tool. The
1258 specified command is evaluated in shell with the following
1259 variables available: 'BASE' is the name of a temporary file
1260 containing the common base of the files to be merged, if available;
1261 'LOCAL' is the name of a temporary file containing the contents of
1262 the file on the current branch; 'REMOTE' is the name of a temporary
1263 file containing the contents of the file from the branch being
1264 merged; 'MERGED' contains the name of the file to which the merge
1265 tool should write the results of a successful merge.
1267 mergetool.<tool>.trustExitCode::
1268 For a custom merge command, specify whether the exit code of
1269 the merge command can be used to determine whether the merge was
1270 successful. If this is not set to true then the merge target file
1271 timestamp is checked and the merge assumed to have been successful
1272 if the file has been updated, otherwise the user is prompted to
1273 indicate the success of the merge.
1275 mergetool.meld.hasOutput::
1276 Older versions of `meld` do not support the `--output` option.
1277 Git will attempt to detect whether `meld` supports `--output`
1278 by inspecting the output of `meld --help`. Configuring
1279 `mergetool.meld.hasOutput` will make Git skip these checks and
1280 use the configured value instead. Setting `mergetool.meld.hasOutput`
1281 to `true` tells Git to unconditionally use the `--output` option,
1282 and `false` avoids using `--output`.
1284 mergetool.keepBackup::
1285 After performing a merge, the original file with conflict markers
1286 can be saved as a file with a `.orig` extension. If this variable
1287 is set to `false` then this file is not preserved. Defaults to
1288 `true` (i.e. keep the backup files).
1290 mergetool.keepTemporaries::
1291 When invoking a custom merge tool, Git uses a set of temporary
1292 files to pass to the tool. If the tool returns an error and this
1293 variable is set to `true`, then these temporary files will be
1294 preserved, otherwise they will be removed after the tool has
1295 exited. Defaults to `false`.
1297 mergetool.writeToTemp::
1298 Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
1299 conflicting files in the worktree by default. Git will attempt
1300 to use a temporary directory for these files when set `true`.
1301 Defaults to `false`.
1304 Prompt before each invocation of the merge resolution program.
1306 notes.mergeStrategy::
1307 Which merge strategy to choose by default when resolving notes
1308 conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
1309 `cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
1310 section of linkgit:git-notes[1] for more information on each strategy.
1312 notes.<name>.mergeStrategy::
1313 Which merge strategy to choose when doing a notes merge into
1314 refs/notes/<name>. This overrides the more general
1315 "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section in
1316 linkgit:git-notes[1] for more information on the available strategies.
1319 The (fully qualified) refname from which to show notes when
1320 showing commit messages. The value of this variable can be set
1321 to a glob, in which case notes from all matching refs will be
1322 shown. You may also specify this configuration variable
1323 several times. A warning will be issued for refs that do not
1324 exist, but a glob that does not match any refs is silently
1327 This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
1328 environment variable, which must be a colon separated list of refs or
1331 The effective value of "core.notesRef" (possibly overridden by
1332 GIT_NOTES_REF) is also implicitly added to the list of refs to be
1335 notes.rewrite.<command>::
1336 When rewriting commits with <command> (currently `amend` or
1337 `rebase`) and this variable is set to `true`, Git
1338 automatically copies your notes from the original to the
1339 rewritten commit. Defaults to `true`, but see
1340 "notes.rewriteRef" below.
1343 When copying notes during a rewrite (see the
1344 "notes.rewrite.<command>" option), determines what to do if
1345 the target commit already has a note. Must be one of
1346 `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
1347 Defaults to `concatenate`.
1349 This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
1350 environment variable.
1353 When copying notes during a rewrite, specifies the (fully
1354 qualified) ref whose notes should be copied. The ref may be a
1355 glob, in which case notes in all matching refs will be copied.
1356 You may also specify this configuration several times.
1358 Does not have a default value; you must configure this variable to
1359 enable note rewriting. Set it to `refs/notes/commits` to enable
1360 rewriting for the default commit notes.
1362 This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
1363 environment variable, which must be a colon separated list of refs or
1367 The size of the window used by linkgit:git-pack-objects[1] when no
1368 window size is given on the command line. Defaults to 10.
1371 The maximum delta depth used by linkgit:git-pack-objects[1] when no
1372 maximum depth is given on the command line. Defaults to 50.
1373 Maximum value is 4095.
1376 The maximum size of memory that is consumed by each thread
1377 in linkgit:git-pack-objects[1] for pack window memory when
1378 no limit is given on the command line. The value can be
1379 suffixed with "k", "m", or "g". When left unconfigured (or
1380 set explicitly to 0), there will be no limit.
1383 An integer -1..9, indicating the compression level for objects
1384 in a pack file. -1 is the zlib default. 0 means no
1385 compression, and 1..9 are various speed/size tradeoffs, 9 being
1386 slowest. If not set, defaults to core.compression. If that is
1387 not set, defaults to -1, the zlib default, which is "a default
1388 compromise between speed and compression (currently equivalent
1391 Note that changing the compression level will not automatically recompress
1392 all existing objects. You can force recompression by passing the -F option
1393 to linkgit:git-repack[1].
1396 An extended regular expression configuring a set of delta
1397 islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]
1401 Specify an island name which gets to have its objects be
1402 packed first. This creates a kind of pseudo-pack at the front
1403 of one pack, so that the objects from the specified island are
1404 hopefully faster to copy into any pack that should be served
1405 to a user requesting these objects. In practice this means
1406 that the island specified should likely correspond to what is
1407 the most commonly cloned in the repo. See also "DELTA ISLANDS"
1408 in linkgit:git-pack-objects[1].
1410 pack.deltaCacheSize::
1411 The maximum memory in bytes used for caching deltas in
1412 linkgit:git-pack-objects[1] before writing them out to a pack.
1413 This cache is used to speed up the writing object phase by not
1414 having to recompute the final delta result once the best match
1415 for all objects is found. Repacking large repositories on machines
1416 which are tight with memory might be badly impacted by this though,
1417 especially if this cache pushes the system into swapping.
1418 A value of 0 means no limit. The smallest size of 1 byte may be
1419 used to virtually disable this cache. Defaults to 256 MiB.
1421 pack.deltaCacheLimit::
1422 The maximum size of a delta, that is cached in
1423 linkgit:git-pack-objects[1]. This cache is used to speed up the
1424 writing object phase by not having to recompute the final delta
1425 result once the best match for all objects is found.
1426 Defaults to 1000. Maximum value is 65535.
1429 Specifies the number of threads to spawn when searching for best
1430 delta matches. This requires that linkgit:git-pack-objects[1]
1431 be compiled with pthreads otherwise this option is ignored with a
1432 warning. This is meant to reduce packing time on multiprocessor
1433 machines. The required amount of memory for the delta search window
1434 is however multiplied by the number of threads.
1435 Specifying 0 will cause Git to auto-detect the number of CPU's
1436 and set the number of threads accordingly.
1439 Specify the default pack index version. Valid values are 1 for
1440 legacy pack index used by Git versions prior to 1.5.2, and 2 for
1441 the new pack index with capabilities for packs larger than 4 GB
1442 as well as proper protection against the repacking of corrupted
1443 packs. Version 2 is the default. Note that version 2 is enforced
1444 and this config option ignored whenever the corresponding pack is
1447 If you have an old Git that does not understand the version 2 `*.idx` file,
1448 cloning or fetching over a non native protocol (e.g. "http")
1449 that will copy both `*.pack` file and corresponding `*.idx` file from the
1450 other side may give you a repository that cannot be accessed with your
1451 older version of Git. If the `*.pack` file is smaller than 2 GB, however,
1452 you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
1455 pack.packSizeLimit::
1456 The maximum size of a pack. This setting only affects
1457 packing to a file when repacking, i.e. the git:// protocol
1458 is unaffected. It can be overridden by the `--max-pack-size`
1459 option of linkgit:git-repack[1]. Reaching this limit results
1460 in the creation of multiple packfiles; which in turn prevents
1461 bitmaps from being created.
1462 The minimum size allowed is limited to 1 MiB.
1463 The default is unlimited.
1464 Common unit suffixes of 'k', 'm', or 'g' are
1468 When true, git will use pack bitmaps (if available) when packing
1469 to stdout (e.g., during the server side of a fetch). Defaults to
1470 true. You should not generally need to turn this off unless
1471 you are debugging pack bitmaps.
1473 pack.writeBitmaps (deprecated)::
1474 This is a deprecated synonym for `repack.writeBitmaps`.
1476 pack.writeBitmapHashCache::
1477 When true, git will include a "hash cache" section in the bitmap
1478 index (if one is written). This cache can be used to feed git's
1479 delta heuristics, potentially leading to better deltas between
1480 bitmapped and non-bitmapped objects (e.g., when serving a fetch
1481 between an older, bitmapped pack and objects that have been
1482 pushed since the last gc). The downside is that it consumes 4
1483 bytes per object of disk space, and that JGit's bitmap
1484 implementation does not understand it, causing it to complain if
1485 Git and JGit are used on the same repository. Defaults to false.
1488 If the value is boolean, turns on or off pagination of the
1489 output of a particular Git subcommand when writing to a tty.
1490 Otherwise, turns on pagination for the subcommand using the
1491 pager specified by the value of `pager.<cmd>`. If `--paginate`
1492 or `--no-pager` is specified on the command line, it takes
1493 precedence over this option. To disable pagination for all
1494 commands, set `core.pager` or `GIT_PAGER` to `cat`.
1497 Alias for a --pretty= format string, as specified in
1498 linkgit:git-log[1]. Any aliases defined here can be used just
1499 as the built-in pretty formats could. For example,
1500 running `git config pretty.changelog "format:* %H %s"`
1501 would cause the invocation `git log --pretty=changelog`
1502 to be equivalent to running `git log "--pretty=format:* %H %s"`.
1503 Note that an alias with the same name as a built-in format
1504 will be silently ignored.
1507 If set, provide a user defined default policy for all protocols which
1508 don't explicitly have a policy (`protocol.<name>.allow`). By default,
1509 if unset, known-safe protocols (http, https, git, ssh, file) have a
1510 default policy of `always`, known-dangerous protocols (ext) have a
1511 default policy of `never`, and all other protocols have a default
1512 policy of `user`. Supported policies:
1516 * `always` - protocol is always able to be used.
1518 * `never` - protocol is never able to be used.
1520 * `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
1521 either unset or has a value of 1. This policy should be used when you want a
1522 protocol to be directly usable by the user but don't want it used by commands which
1523 execute clone/fetch/push commands without user input, e.g. recursive
1524 submodule initialization.
1528 protocol.<name>.allow::
1529 Set a policy to be used by protocol `<name>` with clone/fetch/push
1530 commands. See `protocol.allow` above for the available policies.
1532 The protocol names currently used by git are:
1535 - `file`: any local file-based path (including `file://` URLs,
1538 - `git`: the anonymous git protocol over a direct TCP
1539 connection (or proxy, if configured)
1541 - `ssh`: git over ssh (including `host:path` syntax,
1544 - `http`: git over http, both "smart http" and "dumb http".
1545 Note that this does _not_ include `https`; if you want to configure
1546 both, you must do so individually.
1548 - any external helpers are named by their protocol (e.g., use
1549 `hg` to allow the `git-remote-hg` helper)
1553 Experimental. If set, clients will attempt to communicate with a
1554 server using the specified protocol version. If unset, no
1555 attempt will be made by the client to communicate using a
1556 particular protocol version, this results in protocol version 0
1562 * `0` - the original wire protocol.
1564 * `1` - the original wire protocol with the addition of a version string
1565 in the initial response from the server.
1567 * `2` - link:technical/protocol-v2.html[wire protocol version 2].
1571 include::pull-config.txt[]
1573 include::push-config.txt[]
1575 include::rebase-config.txt[]
1577 include::receive-config.txt[]
1579 remote.pushDefault::
1580 The remote to push to by default. Overrides
1581 `branch.<name>.remote` for all branches, and is overridden by
1582 `branch.<name>.pushRemote` for specific branches.
1585 The URL of a remote repository. See linkgit:git-fetch[1] or
1586 linkgit:git-push[1].
1588 remote.<name>.pushurl::
1589 The push URL of a remote repository. See linkgit:git-push[1].
1591 remote.<name>.proxy::
1592 For remotes that require curl (http, https and ftp), the URL to
1593 the proxy to use for that remote. Set to the empty string to
1594 disable proxying for that remote.
1596 remote.<name>.proxyAuthMethod::
1597 For remotes that require curl (http, https and ftp), the method to use for
1598 authenticating against the proxy in use (probably set in
1599 `remote.<name>.proxy`). See `http.proxyAuthMethod`.
1601 remote.<name>.fetch::
1602 The default set of "refspec" for linkgit:git-fetch[1]. See
1603 linkgit:git-fetch[1].
1605 remote.<name>.push::
1606 The default set of "refspec" for linkgit:git-push[1]. See
1607 linkgit:git-push[1].
1609 remote.<name>.mirror::
1610 If true, pushing to this remote will automatically behave
1611 as if the `--mirror` option was given on the command line.
1613 remote.<name>.skipDefaultUpdate::
1614 If true, this remote will be skipped by default when updating
1615 using linkgit:git-fetch[1] or the `update` subcommand of
1616 linkgit:git-remote[1].
1618 remote.<name>.skipFetchAll::
1619 If true, this remote will be skipped by default when updating
1620 using linkgit:git-fetch[1] or the `update` subcommand of
1621 linkgit:git-remote[1].
1623 remote.<name>.receivepack::
1624 The default program to execute on the remote side when pushing. See
1625 option --receive-pack of linkgit:git-push[1].
1627 remote.<name>.uploadpack::
1628 The default program to execute on the remote side when fetching. See
1629 option --upload-pack of linkgit:git-fetch-pack[1].
1631 remote.<name>.tagOpt::
1632 Setting this value to --no-tags disables automatic tag following when
1633 fetching from remote <name>. Setting it to --tags will fetch every
1634 tag from remote <name>, even if they are not reachable from remote
1635 branch heads. Passing these flags directly to linkgit:git-fetch[1] can
1636 override this setting. See options --tags and --no-tags of
1637 linkgit:git-fetch[1].
1640 Setting this to a value <vcs> will cause Git to interact with
1641 the remote with the git-remote-<vcs> helper.
1643 remote.<name>.prune::
1644 When set to true, fetching from this remote by default will also
1645 remove any remote-tracking references that no longer exist on the
1646 remote (as if the `--prune` option was given on the command line).
1647 Overrides `fetch.prune` settings, if any.
1649 remote.<name>.pruneTags::
1650 When set to true, fetching from this remote by default will also
1651 remove any local tags that no longer exist on the remote if pruning
1652 is activated in general via `remote.<name>.prune`, `fetch.prune` or
1653 `--prune`. Overrides `fetch.pruneTags` settings, if any.
1655 See also `remote.<name>.prune` and the PRUNING section of
1656 linkgit:git-fetch[1].
1659 The list of remotes which are fetched by "git remote update
1660 <group>". See linkgit:git-remote[1].
1662 repack.useDeltaBaseOffset::
1663 By default, linkgit:git-repack[1] creates packs that use
1664 delta-base offset. If you need to share your repository with
1665 Git older than version 1.4.4, either directly or via a dumb
1666 protocol such as http, then you need to set this option to
1667 "false" and repack. Access from old Git versions over the
1668 native protocol are unaffected by this option.
1670 repack.packKeptObjects::
1671 If set to true, makes `git repack` act as if
1672 `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
1673 details. Defaults to `false` normally, but `true` if a bitmap
1674 index is being written (either via `--write-bitmap-index` or
1675 `repack.writeBitmaps`).
1677 repack.useDeltaIslands::
1678 If set to true, makes `git repack` act as if `--delta-islands`
1679 was passed. Defaults to `false`.
1681 repack.writeBitmaps::
1682 When true, git will write a bitmap index when packing all
1683 objects to disk (e.g., when `git repack -a` is run). This
1684 index can speed up the "counting objects" phase of subsequent
1685 packs created for clones and fetches, at the cost of some disk
1686 space and extra time spent on the initial repack. This has
1687 no effect if multiple packfiles are created.
1691 When set to true, `git-rerere` updates the index with the
1692 resulting contents after it cleanly resolves conflicts using
1693 previously recorded resolution. Defaults to false.
1696 Activate recording of resolved conflicts, so that identical
1697 conflict hunks can be resolved automatically, should they be
1698 encountered again. By default, linkgit:git-rerere[1] is
1699 enabled if there is an `rr-cache` directory under the
1700 `$GIT_DIR`, e.g. if "rerere" was previously used in the
1704 When set to true, 'git reset' will default to the '--quiet' option.
1706 include::sendemail-config.txt[]
1709 Text editor used by `git rebase -i` for editing the rebase instruction file.
1710 The value is meant to be interpreted by the shell when it is used.
1711 It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
1712 When not configured the default commit message editor is used instead.
1714 showBranch.default::
1715 The default set of branches for linkgit:git-show-branch[1].
1716 See linkgit:git-show-branch[1].
1718 splitIndex.maxPercentChange::
1719 When the split index feature is used, this specifies the
1720 percent of entries the split index can contain compared to the
1721 total number of entries in both the split index and the shared
1722 index before a new shared index is written.
1723 The value should be between 0 and 100. If the value is 0 then
1724 a new shared index is always written, if it is 100 a new
1725 shared index is never written.
1726 By default the value is 20, so a new shared index is written
1727 if the number of entries in the split index would be greater
1728 than 20 percent of the total number of entries.
1729 See linkgit:git-update-index[1].
1731 splitIndex.sharedIndexExpire::
1732 When the split index feature is used, shared index files that
1733 were not modified since the time this variable specifies will
1734 be removed when a new shared index file is created. The value
1735 "now" expires all entries immediately, and "never" suppresses
1736 expiration altogether.
1737 The default value is "2.weeks.ago".
1738 Note that a shared index file is considered modified (for the
1739 purpose of expiration) each time a new split-index file is
1740 either created based on it or read from it.
1741 See linkgit:git-update-index[1].
1743 status.relativePaths::
1744 By default, linkgit:git-status[1] shows paths relative to the
1745 current directory. Setting this variable to `false` shows paths
1746 relative to the repository root (this was the default for Git
1750 Set to true to enable --short by default in linkgit:git-status[1].
1751 The option --no-short takes precedence over this variable.
1754 Set to true to enable --branch by default in linkgit:git-status[1].
1755 The option --no-branch takes precedence over this variable.
1757 status.displayCommentPrefix::
1758 If set to true, linkgit:git-status[1] will insert a comment
1759 prefix before each output line (starting with
1760 `core.commentChar`, i.e. `#` by default). This was the
1761 behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
1764 status.renameLimit::
1765 The number of files to consider when performing rename detection
1766 in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
1767 the value of diff.renameLimit.
1770 Whether and how Git detects renames in linkgit:git-status[1] and
1771 linkgit:git-commit[1] . If set to "false", rename detection is
1772 disabled. If set to "true", basic rename detection is enabled.
1773 If set to "copies" or "copy", Git will detect copies, as well.
1774 Defaults to the value of diff.renames.
1777 If set to true, linkgit:git-status[1] will display the number of
1778 entries currently stashed away.
1781 status.showUntrackedFiles::
1782 By default, linkgit:git-status[1] and linkgit:git-commit[1] show
1783 files which are not currently tracked by Git. Directories which
1784 contain only untracked files, are shown with the directory name
1785 only. Showing untracked files means that Git needs to lstat() all
1786 the files in the whole repository, which might be slow on some
1787 systems. So, this variable controls how the commands displays
1788 the untracked files. Possible values are:
1791 * `no` - Show no untracked files.
1792 * `normal` - Show untracked files and directories.
1793 * `all` - Show also individual files in untracked directories.
1796 If this variable is not specified, it defaults to 'normal'.
1797 This variable can be overridden with the -u|--untracked-files option
1798 of linkgit:git-status[1] and linkgit:git-commit[1].
1800 status.submoduleSummary::
1802 If this is set to a non zero number or true (identical to -1 or an
1803 unlimited number), the submodule summary will be enabled and a
1804 summary of commits for modified submodules will be shown (see
1805 --summary-limit option of linkgit:git-submodule[1]). Please note
1806 that the summary output command will be suppressed for all
1807 submodules when `diff.ignoreSubmodules` is set to 'all' or only
1808 for those submodules where `submodule.<name>.ignore=all`. The only
1809 exception to that rule is that status and commit will show staged
1810 submodule changes. To
1811 also view the summary for ignored submodules you can either use
1812 the --ignore-submodules=dirty command-line option or the 'git
1813 submodule summary' command, which shows a similar output but does
1814 not honor these settings.
1817 If this is set to true, the `git stash show` command without an
1818 option will show the stash entry in patch form. Defaults to false.
1819 See description of 'show' command in linkgit:git-stash[1].
1822 If this is set to true, the `git stash show` command without an
1823 option will show diffstat of the stash entry. Defaults to true.
1824 See description of 'show' command in linkgit:git-stash[1].
1826 include::submodule-config.txt[]
1828 tag.forceSignAnnotated::
1829 A boolean to specify whether annotated tags created should be GPG signed.
1830 If `--annotate` is specified on the command line, it takes
1831 precedence over this option.
1834 This variable controls the sort ordering of tags when displayed by
1835 linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
1836 value of this variable will be used as the default.
1839 This variable can be used to restrict the permission bits of
1840 tar archive entries. The default is 0002, which turns off the
1841 world write bit. The special value "user" indicates that the
1842 archiving user's umask will be used instead. See umask(2) and
1843 linkgit:git-archive[1].
1845 transfer.fsckObjects::
1846 When `fetch.fsckObjects` or `receive.fsckObjects` are
1847 not set, the value of this variable is used instead.
1850 When set, the fetch or receive will abort in the case of a malformed
1851 object or a link to a nonexistent object. In addition, various other
1852 issues are checked for, including legacy issues (see `fsck.<msg-id>`),
1853 and potential security issues like the existence of a `.GIT` directory
1854 or a malicious `.gitmodules` file (see the release notes for v2.2.1
1855 and v2.17.1 for details). Other sanity and security checks may be
1856 added in future releases.
1858 On the receiving side, failing fsckObjects will make those objects
1859 unreachable, see "QUARANTINE ENVIRONMENT" in
1860 linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
1861 instead be left unreferenced in the repository.
1863 Due to the non-quarantine nature of the `fetch.fsckObjects`
1864 implementation it can not be relied upon to leave the object store
1865 clean like `receive.fsckObjects` can.
1867 As objects are unpacked they're written to the object store, so there
1868 can be cases where malicious objects get introduced even though the
1869 "fetch" failed, only to have a subsequent "fetch" succeed because only
1870 new incoming objects are checked, not those that have already been
1871 written to the object store. That difference in behavior should not be
1872 relied upon. In the future, such objects may be quarantined for
1875 For now, the paranoid need to find some way to emulate the quarantine
1876 environment if they'd like the same protection as "push". E.g. in the
1877 case of an internal mirror do the mirroring in two steps, one to fetch
1878 the untrusted objects, and then do a second "push" (which will use the
1879 quarantine) to another internal repo, and have internal clients
1880 consume this pushed-to repository, or embargo internal fetches and
1881 only allow them once a full "fsck" has run (and no new fetches have
1882 happened in the meantime).
1885 String(s) `receive-pack` and `upload-pack` use to decide which
1886 refs to omit from their initial advertisements. Use more than
1887 one definition to specify multiple prefix strings. A ref that is
1888 under the hierarchies listed in the value of this variable is
1889 excluded, and is hidden when responding to `git push` or `git
1890 fetch`. See `receive.hideRefs` and `uploadpack.hideRefs` for
1891 program-specific versions of this config.
1893 You may also include a `!` in front of the ref name to negate the entry,
1894 explicitly exposing it, even if an earlier entry marked it as hidden.
1895 If you have multiple hideRefs values, later entries override earlier ones
1896 (and entries in more-specific config files override less-specific ones).
1898 If a namespace is in use, the namespace prefix is stripped from each
1899 reference before it is matched against `transfer.hiderefs` patterns.
1900 For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
1901 the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
1902 is omitted from the advertisements but `refs/heads/master` and
1903 `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
1904 "have" lines. In order to match refs before stripping, add a `^` in front of
1905 the ref name. If you combine `!` and `^`, `!` must be specified first.
1907 Even if you hide refs, a client may still be able to steal the target
1908 objects via the techniques described in the "SECURITY" section of the
1909 linkgit:gitnamespaces[7] man page; it's best to keep private data in a
1910 separate repository.
1912 transfer.unpackLimit::
1913 When `fetch.unpackLimit` or `receive.unpackLimit` are
1914 not set, the value of this variable is used instead.
1915 The default value is 100.
1917 uploadarchive.allowUnreachable::
1918 If true, allow clients to use `git archive --remote` to request
1919 any tree, whether reachable from the ref tips or not. See the
1920 discussion in the "SECURITY" section of
1921 linkgit:git-upload-archive[1] for more details. Defaults to
1924 uploadpack.hideRefs::
1925 This variable is the same as `transfer.hideRefs`, but applies
1926 only to `upload-pack` (and so affects only fetches, not pushes).
1927 An attempt to fetch a hidden ref by `git fetch` will fail. See
1928 also `uploadpack.allowTipSHA1InWant`.
1930 uploadpack.allowTipSHA1InWant::
1931 When `uploadpack.hideRefs` is in effect, allow `upload-pack`
1932 to accept a fetch request that asks for an object at the tip
1933 of a hidden ref (by default, such a request is rejected).
1934 See also `uploadpack.hideRefs`. Even if this is false, a client
1935 may be able to steal objects via the techniques described in the
1936 "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
1937 best to keep private data in a separate repository.
1939 uploadpack.allowReachableSHA1InWant::
1940 Allow `upload-pack` to accept a fetch request that asks for an
1941 object that is reachable from any ref tip. However, note that
1942 calculating object reachability is computationally expensive.
1943 Defaults to `false`. Even if this is false, a client may be able
1944 to steal objects via the techniques described in the "SECURITY"
1945 section of the linkgit:gitnamespaces[7] man page; it's best to
1946 keep private data in a separate repository.
1948 uploadpack.allowAnySHA1InWant::
1949 Allow `upload-pack` to accept a fetch request that asks for any
1951 Defaults to `false`.
1953 uploadpack.keepAlive::
1954 When `upload-pack` has started `pack-objects`, there may be a
1955 quiet period while `pack-objects` prepares the pack. Normally
1956 it would output progress information, but if `--quiet` was used
1957 for the fetch, `pack-objects` will output nothing at all until
1958 the pack data begins. Some clients and networks may consider
1959 the server to be hung and give up. Setting this option instructs
1960 `upload-pack` to send an empty keepalive packet every
1961 `uploadpack.keepAlive` seconds. Setting this option to 0
1962 disables keepalive packets entirely. The default is 5 seconds.
1964 uploadpack.packObjectsHook::
1965 If this option is set, when `upload-pack` would run
1966 `git pack-objects` to create a packfile for a client, it will
1967 run this shell command instead. The `pack-objects` command and
1968 arguments it _would_ have run (including the `git pack-objects`
1969 at the beginning) are appended to the shell command. The stdin
1970 and stdout of the hook are treated as if `pack-objects` itself
1971 was run. I.e., `upload-pack` will feed input intended for
1972 `pack-objects` to the hook, and expects a completed packfile on
1975 Note that this configuration variable is ignored if it is seen in the
1976 repository-level config (this is a safety measure against fetching from
1977 untrusted repositories).
1979 uploadpack.allowFilter::
1980 If this option is set, `upload-pack` will support partial
1981 clone and partial fetch object filtering.
1983 uploadpack.allowRefInWant::
1984 If this option is set, `upload-pack` will support the `ref-in-want`
1985 feature of the protocol version 2 `fetch` command. This feature
1986 is intended for the benefit of load-balanced servers which may
1987 not have the same view of what OIDs their refs point to due to
1990 url.<base>.insteadOf::
1991 Any URL that starts with this value will be rewritten to
1992 start, instead, with <base>. In cases where some site serves a
1993 large number of repositories, and serves them with multiple
1994 access methods, and some users need to use different access
1995 methods, this feature allows people to specify any of the
1996 equivalent URLs and have Git automatically rewrite the URL to
1997 the best alternative for the particular user, even for a
1998 never-before-seen repository on the site. When more than one
1999 insteadOf strings match a given URL, the longest match is used.
2001 Note that any protocol restrictions will be applied to the rewritten
2002 URL. If the rewrite changes the URL to use a custom protocol or remote
2003 helper, you may need to adjust the `protocol.*.allow` config to permit
2004 the request. In particular, protocols you expect to use for submodules
2005 must be set to `always` rather than the default of `user`. See the
2006 description of `protocol.allow` above.
2008 url.<base>.pushInsteadOf::
2009 Any URL that starts with this value will not be pushed to;
2010 instead, it will be rewritten to start with <base>, and the
2011 resulting URL will be pushed to. In cases where some site serves
2012 a large number of repositories, and serves them with multiple
2013 access methods, some of which do not allow push, this feature
2014 allows people to specify a pull-only URL and have Git
2015 automatically use an appropriate URL to push, even for a
2016 never-before-seen repository on the site. When more than one
2017 pushInsteadOf strings match a given URL, the longest match is
2018 used. If a remote has an explicit pushurl, Git will ignore this
2019 setting for that remote.
2022 Your email address to be recorded in any newly created commits.
2023 Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
2024 `EMAIL` environment variables. See linkgit:git-commit-tree[1].
2027 Your full name to be recorded in any newly created commits.
2028 Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
2029 environment variables. See linkgit:git-commit-tree[1].
2031 user.useConfigOnly::
2032 Instruct Git to avoid trying to guess defaults for `user.email`
2033 and `user.name`, and instead retrieve the values only from the
2034 configuration. For example, if you have multiple email addresses
2035 and would like to use a different one for each repository, then
2036 with this configuration option set to `true` in the global config
2037 along with a name, Git will prompt you to set up an email before
2038 making new commits in a newly cloned repository.
2039 Defaults to `false`.
2042 If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
2043 key you want it to automatically when creating a signed tag or
2044 commit, you can override the default selection with this variable.
2045 This option is passed unchanged to gpg's --local-user parameter,
2046 so you may specify a key using any method that gpg supports.
2048 versionsort.prereleaseSuffix (deprecated)::
2049 Deprecated alias for `versionsort.suffix`. Ignored if
2050 `versionsort.suffix` is set.
2052 versionsort.suffix::
2053 Even when version sort is used in linkgit:git-tag[1], tagnames
2054 with the same base version but different suffixes are still sorted
2055 lexicographically, resulting e.g. in prerelease tags appearing
2056 after the main release (e.g. "1.0-rc1" after "1.0"). This
2057 variable can be specified to determine the sorting order of tags
2058 with different suffixes.
2060 By specifying a single suffix in this variable, any tagname containing
2061 that suffix will appear before the corresponding main release. E.g. if
2062 the variable is set to "-rc", then all "1.0-rcX" tags will appear before
2063 "1.0". If specified multiple times, once per suffix, then the order of
2064 suffixes in the configuration will determine the sorting order of tagnames
2065 with those suffixes. E.g. if "-pre" appears before "-rc" in the
2066 configuration, then all "1.0-preX" tags will be listed before any
2067 "1.0-rcX" tags. The placement of the main release tag relative to tags
2068 with various suffixes can be determined by specifying the empty suffix
2069 among those other suffixes. E.g. if the suffixes "-rc", "", "-ck" and
2070 "-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
2071 are listed first, followed by "v4.8", then "v4.8-ckX" and finally
2074 If more than one suffixes match the same tagname, then that tagname will
2075 be sorted according to the suffix which starts at the earliest position in
2076 the tagname. If more than one different matching suffixes start at
2077 that earliest position, then that tagname will be sorted according to the
2078 longest of those suffixes.
2079 The sorting order between different suffixes is undefined if they are
2080 in multiple config files.
2083 Specify a web browser that may be used by some commands.
2084 Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
2087 worktree.guessRemote::
2088 With `add`, if no branch argument, and neither of `-b` nor
2089 `-B` nor `--detach` are given, the command defaults to
2090 creating a new branch from HEAD. If `worktree.guessRemote` is
2091 set to true, `worktree add` tries to find a remote-tracking
2092 branch whose name uniquely matches the new branch name. If
2093 such a branch exists, it is checked out and set as "upstream"
2094 for the new branch. If no such match can be found, it falls
2095 back to creating a new branch from the current HEAD.