Documentation / config.txton commit Merge branch 'hn/config-in-code-comment' (f382c24)
   1CONFIGURATION FILE
   2------------------
   3
   4The Git configuration file contains a number of variables that affect
   5the Git commands' behavior. The `.git/config` file in each repository
   6is used to store the configuration for that repository, and
   7`$HOME/.gitconfig` is used to store a per-user configuration as
   8fallback values for the `.git/config` file. The file `/etc/gitconfig`
   9can be used to store a system-wide default configuration.
  10
  11The configuration variables are used by both the Git plumbing
  12and the porcelains. The variables are divided into sections, wherein
  13the fully qualified variable name of the variable itself is the last
  14dot-separated segment and the section name is everything before the last
  15dot. The variable names are case-insensitive, allow only alphanumeric
  16characters and `-`, and must start with an alphabetic character.  Some
  17variables may appear multiple times; we say then that the variable is
  18multivalued.
  19
  20Syntax
  21~~~~~~
  22
  23The syntax is fairly flexible and permissive; whitespaces are mostly
  24ignored.  The '#' and ';' characters begin comments to the end of line,
  25blank lines are ignored.
  26
  27The file consists of sections and variables.  A section begins with
  28the name of the section in square brackets and continues until the next
  29section begins.  Section names are case-insensitive.  Only alphanumeric
  30characters, `-` and `.` are allowed in section names.  Each variable
  31must belong to some section, which means that there must be a section
  32header before the first setting of a variable.
  33
  34Sections can be further divided into subsections.  To begin a subsection
  35put its name in double quotes, separated by space from the section name,
  36in the section header, like in the example below:
  37
  38--------
  39        [section "subsection"]
  40
  41--------
  42
  43Subsection names are case sensitive and can contain any characters except
  44newline and the null byte. Doublequote `"` and backslash can be included
  45by escaping them as `\"` and `\\`, respectively. Backslashes preceding
  46other 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.
  48Variables may belong directly to a section or to a given subsection. You
  49can have `[section]` if you have `[section "subsection"]`, but you don't
  50need to.
  51
  52There is also a deprecated `[section.subsection]` syntax. With this
  53syntax, the subsection name is converted to lower-case and is also
  54compared case sensitively. These subsection names follow the same
  55restrictions as section names.
  56
  57All the other lines (and the remainder of the line after the section
  58header) are recognized as setting variables, in the form
  59'name = value' (or just 'name', which is a short-hand to say that
  60the variable is the boolean "true").
  61The variable names are case-insensitive, allow only alphanumeric characters
  62and `-`, and must start with an alphabetic character.
  63
  64A line that defines a value can be continued to the next line by
  65ending it with a `\`; the backquote and the end-of-line are
  66stripped.  Leading whitespaces after 'name =', the remainder of the
  67line after the first comment character '#' or ';', and trailing
  68whitespaces of the line are discarded unless they are enclosed in
  69double quotes.  Internal whitespaces within the value are retained
  70verbatim.
  71
  72Inside double quotes, double quote `"` and backslash `\` characters
  73must be escaped: use `\"` for `"` and `\\` for `\`.
  74
  75The following escape sequences (beside `\"` and `\\`) are recognized:
  76`\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
  77and `\b` for backspace (BS).  Other char escape sequences (including octal
  78escape sequences) are invalid.
  79
  80
  81Includes
  82~~~~~~~~
  83
  84The `include` and `includeIf` sections allow you to include config
  85directives from another source. These sections behave identically to
  86each other with the exception that `includeIf` sections may be ignored
  87if their condition does not evaluate to true; see "Conditional includes"
  88below.
  89
  90You can include a config file from another by setting the special
  91`include.path` (or `includeIf.*.path`) variable to the name of the file
  92to be included. The variable takes a pathname as its value, and is
  93subject to tilde expansion. These variables can be given multiple times.
  94
  95The contents of the included file are inserted immediately, as if they
  96had been found at the location of the include directive. If the value of the
  97variable is a relative path, the path is considered to
  98be relative to the configuration file in which the include directive
  99was found.  See below for examples.
 100
 101Conditional includes
 102~~~~~~~~~~~~~~~~~~~~
 103
 104You can include a config file from another conditionally by setting a
 105`includeIf.<condition>.path` variable to the name of the file to be
 106included.
 107
 108The condition starts with a keyword followed by a colon and some data
 109whose format and meaning depends on the keyword. Supported keywords
 110are:
 111
 112`gitdir`::
 113
 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.
 117+
 118The .git location may be auto-discovered, or come from `$GIT_DIR`
 119environment variable. If the repository is auto discovered via a .git
 120file (e.g. from submodules, or a linked worktree), the .git location
 121would be the final location where the .git directory is, not where the
 122.git file is.
 123+
 124The pattern can contain standard globbing wildcards and two additional
 125ones, `**/` and `/**`, that can match multiple path components. Please
 126refer to linkgit:gitignore[5] for details. For convenience:
 127
 128 * If the pattern starts with `~/`, `~` will be substituted with the
 129   content of the environment variable `HOME`.
 130
 131 * If the pattern starts with `./`, it is replaced with the directory
 132   containing the current config file.
 133
 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`.
 137
 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.
 141
 142`gitdir/i`::
 143        This is the same as `gitdir` except that matching is done
 144        case-insensitively (e.g. on case-insensitive file sytems)
 145
 146A few more notes on matching via `gitdir` and `gitdir/i`:
 147
 148 * Symlinks in `$GIT_DIR` are not resolved before matching.
 149
 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`
 153   will match.
 154+
 155This was not the case in the initial release of this feature in
 156v2.13.0, which only matched the realpath version. Configuration that
 157wants to be compatible with the initial release of this feature needs
 158to either specify only the realpath version, or both versions.
 159
 160 * Note that "../" is not special and will match literally, which is
 161   unlikely what you want.
 162
 163Example
 164~~~~~~~
 165
 166        # Core variables
 167        [core]
 168                ; Don't trust file modes
 169                filemode = false
 170
 171        # Our diff algorithm
 172        [diff]
 173                external = /usr/local/bin/diff-wrapper
 174                renames = true
 175
 176        [branch "devel"]
 177                remote = origin
 178                merge = refs/heads/devel
 179
 180        # Proxy settings
 181        [core]
 182                gitProxy="ssh" for "kernel.org"
 183                gitProxy=default-proxy ; for the rest
 184
 185        [include]
 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
 189
 190        ; include if $GIT_DIR is /path/to/foo/.git
 191        [includeIf "gitdir:/path/to/foo/.git"]
 192                path = /path/to/foo.inc
 193
 194        ; include for all repositories inside /path/to/group
 195        [includeIf "gitdir:/path/to/group/"]
 196                path = /path/to/foo.inc
 197
 198        ; include for all repositories inside $HOME/to/group
 199        [includeIf "gitdir:~/to/group/"]
 200                path = /path/to/foo.inc
 201
 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/"]
 206                path = foo.inc
 207
 208Values
 209~~~~~~
 210
 211Values of many variables are treated as a simple string, but there
 212are variables that take values of specific types and there are rules
 213as to how to spell them.
 214
 215boolean::
 216
 217       When a variable is said to take a boolean value, many
 218       synonyms are accepted for 'true' and 'false'; these are all
 219       case-insensitive.
 220
 221        true;; Boolean true literals are `yes`, `on`, `true`,
 222                and `1`.  Also, a variable defined without `= <value>`
 223                is taken as true.
 224
 225        false;; Boolean false literals are `no`, `off`, `false`,
 226                `0` and the empty string.
 227+
 228When converting value to the canonical form using `--bool` type
 229specifier, 'git config' will ensure that the output is "true" or
 230"false" (spelled in lowercase).
 231
 232integer::
 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.
 236
 237color::
 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.
 241+
 242The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
 243`blue`, `magenta`, `cyan` and `white`.  The first color given is the
 244foreground; the second is the background.
 245+
 246Colors may also be given as numbers between 0 and 255; these use ANSI
 247256-color mode (but note that not all terminals may support this).  If
 248your terminal supports it, you may also specify 24-bit RGB values as
 249hex, like `#ff0ab3`.
 250+
 251The accepted attributes are `bold`, `dim`, `ul`, `blink`, `reverse`,
 252`italic`, and `strike` (for crossed-out or "strikethrough" letters).
 253The position of any attributes with respect to the colors
 254(before, after, or in between), doesn't matter. Specific attributes may
 255be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
 256`no-ul`, etc).
 257+
 258An empty color string produces no color effect at all. This can be used
 259to avoid coloring specific elements without disabling color entirely.
 260+
 261For git's pre-defined color slots, the attributes are meant to be reset
 262at the beginning of each item in the colored output. So setting
 263`color.decorate.branch` to `black` will paint that branch name in a
 264plain `black`, even if the previous thing on the same output line (e.g.
 265opening parenthesis before the list of branch names in `log --decorate`
 266output) is set to be painted with `bold` or some other attribute.
 267However, custom log formats may do more complicated and layered
 268coloring, and the negated forms may be useful there.
 269
 270pathname::
 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.
 276
 277
 278Variables
 279~~~~~~~~~
 280
 281Note that this list is non-comprehensive and not necessarily complete.
 282For command-specific variables, you will find a more detailed description
 283in the appropriate manual page.
 284
 285Other git-related tools may and do use their own variables.  When
 286inventing new variables for use in your own tool, make sure their
 287names do not conflict with those that are used by Git itself and
 288other popular tools, and describe them in your documentation.
 289
 290
 291advice.*::
 292        These variables control various optional help messages designed to
 293        aid new users. All 'advice.*' variables default to 'true', and you
 294        can tell Git that you do not need help by setting these to 'false':
 295+
 296--
 297        pushUpdateRejected::
 298                Set this variable to 'false' if you want to disable
 299                'pushNonFFCurrent',
 300                'pushNonFFMatching', 'pushAlreadyExists',
 301                'pushFetchFirst', and 'pushNeedsForce'
 302                simultaneously.
 303        pushNonFFCurrent::
 304                Advice shown when linkgit:git-push[1] fails due to a
 305                non-fast-forward update to the current branch.
 306        pushNonFFMatching::
 307                Advice shown when you ran linkgit:git-push[1] and pushed
 308                'matching refs' explicitly (i.e. you used ':', or
 309                specified a refspec that isn't your current branch) and
 310                it resulted in a non-fast-forward error.
 311        pushAlreadyExists::
 312                Shown when linkgit:git-push[1] rejects an update that
 313                does not qualify for fast-forwarding (e.g., a tag.)
 314        pushFetchFirst::
 315                Shown when linkgit:git-push[1] rejects an update that
 316                tries to overwrite a remote ref that points at an
 317                object we do not have.
 318        pushNeedsForce::
 319                Shown when linkgit:git-push[1] rejects an update that
 320                tries to overwrite a remote ref that points at an
 321                object that is not a commit-ish, or make the remote
 322                ref point at an object that is not a commit-ish.
 323        statusHints::
 324                Show directions on how to proceed from the current
 325                state in the output of linkgit:git-status[1], in
 326                the template shown when writing commit messages in
 327                linkgit:git-commit[1], and in the help message shown
 328                by linkgit:git-checkout[1] when switching branch.
 329        statusUoption::
 330                Advise to consider using the `-u` option to linkgit:git-status[1]
 331                when the command takes more than 2 seconds to enumerate untracked
 332                files.
 333        commitBeforeMerge::
 334                Advice shown when linkgit:git-merge[1] refuses to
 335                merge to avoid overwriting local changes.
 336        resolveConflict::
 337                Advice shown by various commands when conflicts
 338                prevent the operation from being performed.
 339        implicitIdentity::
 340                Advice on how to set your identity configuration when
 341                your information is guessed from the system username and
 342                domain name.
 343        detachedHead::
 344                Advice shown when you used linkgit:git-checkout[1] to
 345                move to the detach HEAD state, to instruct how to create
 346                a local branch after the fact.
 347        checkoutAmbiguousRemoteBranchName::
 348                Advice shown when the argument to
 349                linkgit:git-checkout[1] ambiguously resolves to a
 350                remote tracking branch on more than one remote in
 351                situations where an unambiguous argument would have
 352                otherwise caused a remote-tracking branch to be
 353                checked out. See the `checkout.defaultRemote`
 354                configuration variable for how to set a given remote
 355                to used by default in some situations where this
 356                advice would be printed.
 357        amWorkDir::
 358                Advice that shows the location of the patch file when
 359                linkgit:git-am[1] fails to apply it.
 360        rmHints::
 361                In case of failure in the output of linkgit:git-rm[1],
 362                show directions on how to proceed from the current state.
 363        addEmbeddedRepo::
 364                Advice on what to do when you've accidentally added one
 365                git repo inside of another.
 366        ignoredHook::
 367                Advice shown if a hook is ignored because the hook is not
 368                set as executable.
 369        waitingForEditor::
 370                Print a message to the terminal whenever Git is waiting for
 371                editor input from the user.
 372--
 373
 374core.fileMode::
 375        Tells Git if the executable bit of files in the working tree
 376        is to be honored.
 377+
 378Some filesystems lose the executable bit when a file that is
 379marked as executable is checked out, or checks out a
 380non-executable file with executable bit on.
 381linkgit:git-clone[1] or linkgit:git-init[1] probe the filesystem
 382to see if it handles the executable bit correctly
 383and this variable is automatically set as necessary.
 384+
 385A repository, however, may be on a filesystem that handles
 386the filemode correctly, and this variable is set to 'true'
 387when created, but later may be made accessible from another
 388environment that loses the filemode (e.g. exporting ext4 via
 389CIFS mount, visiting a Cygwin created repository with
 390Git for Windows or Eclipse).
 391In such a case it may be necessary to set this variable to 'false'.
 392See linkgit:git-update-index[1].
 393+
 394The default is true (when core.filemode is not specified in the config file).
 395
 396core.hideDotFiles::
 397        (Windows-only) If true, mark newly-created directories and files whose
 398        name starts with a dot as hidden.  If 'dotGitOnly', only the `.git/`
 399        directory is hidden, but no other files starting with a dot.  The
 400        default mode is 'dotGitOnly'.
 401
 402core.ignoreCase::
 403        Internal variable which enables various workarounds to enable
 404        Git to work better on filesystems that are not case sensitive,
 405        like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
 406        finds "makefile" when Git expects "Makefile", Git will assume
 407        it is really the same file, and continue to remember it as
 408        "Makefile".
 409+
 410The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
 411will probe and set core.ignoreCase true if appropriate when the repository
 412is created.
 413+
 414Git relies on the proper configuration of this variable for your operating
 415and file system. Modifying this value may result in unexpected behavior.
 416
 417core.precomposeUnicode::
 418        This option is only used by Mac OS implementation of Git.
 419        When core.precomposeUnicode=true, Git reverts the unicode decomposition
 420        of filenames done by Mac OS. This is useful when sharing a repository
 421        between Mac OS and Linux or Windows.
 422        (Git for Windows 1.7.10 or higher is needed, or Git under cygwin 1.7).
 423        When false, file names are handled fully transparent by Git,
 424        which is backward compatible with older versions of Git.
 425
 426core.protectHFS::
 427        If set to true, do not allow checkout of paths that would
 428        be considered equivalent to `.git` on an HFS+ filesystem.
 429        Defaults to `true` on Mac OS, and `false` elsewhere.
 430
 431core.protectNTFS::
 432        If set to true, do not allow checkout of paths that would
 433        cause problems with the NTFS filesystem, e.g. conflict with
 434        8.3 "short" names.
 435        Defaults to `true` on Windows, and `false` elsewhere.
 436
 437core.fsmonitor::
 438        If set, the value of this variable is used as a command which
 439        will identify all files that may have changed since the
 440        requested date/time. This information is used to speed up git by
 441        avoiding unnecessary processing of files that have not changed.
 442        See the "fsmonitor-watchman" section of linkgit:githooks[5].
 443
 444core.trustctime::
 445        If false, the ctime differences between the index and the
 446        working tree are ignored; useful when the inode change time
 447        is regularly modified by something outside Git (file system
 448        crawlers and some backup systems).
 449        See linkgit:git-update-index[1]. True by default.
 450
 451core.splitIndex::
 452        If true, the split-index feature of the index will be used.
 453        See linkgit:git-update-index[1]. False by default.
 454
 455core.untrackedCache::
 456        Determines what to do about the untracked cache feature of the
 457        index. It will be kept, if this variable is unset or set to
 458        `keep`. It will automatically be added if set to `true`. And
 459        it will automatically be removed, if set to `false`. Before
 460        setting it to `true`, you should check that mtime is working
 461        properly on your system.
 462        See linkgit:git-update-index[1]. `keep` by default.
 463
 464core.checkStat::
 465        Determines which stat fields to match between the index
 466        and work tree. The user can set this to 'default' or
 467        'minimal'. Default (or explicitly 'default'), is to check
 468        all fields, including the sub-second part of mtime and ctime.
 469
 470core.quotePath::
 471        Commands that output paths (e.g. 'ls-files', 'diff'), will
 472        quote "unusual" characters in the pathname by enclosing the
 473        pathname in double-quotes and escaping those characters with
 474        backslashes in the same way C escapes control characters (e.g.
 475        `\t` for TAB, `\n` for LF, `\\` for backslash) or bytes with
 476        values larger than 0x80 (e.g. octal `\302\265` for "micro" in
 477        UTF-8).  If this variable is set to false, bytes higher than
 478        0x80 are not considered "unusual" any more. Double-quotes,
 479        backslash and control characters are always escaped regardless
 480        of the setting of this variable.  A simple space character is
 481        not considered "unusual".  Many commands can output pathnames
 482        completely verbatim using the `-z` option. The default value
 483        is true.
 484
 485core.eol::
 486        Sets the line ending type to use in the working directory for
 487        files that have the `text` property set when core.autocrlf is false.
 488        Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
 489        native line ending.  The default value is `native`.  See
 490        linkgit:gitattributes[5] for more information on end-of-line
 491        conversion.
 492
 493core.safecrlf::
 494        If true, makes Git check if converting `CRLF` is reversible when
 495        end-of-line conversion is active.  Git will verify if a command
 496        modifies a file in the work tree either directly or indirectly.
 497        For example, committing a file followed by checking out the
 498        same file should yield the original file in the work tree.  If
 499        this is not the case for the current setting of
 500        `core.autocrlf`, Git will reject the file.  The variable can
 501        be set to "warn", in which case Git will only warn about an
 502        irreversible conversion but continue the operation.
 503+
 504CRLF conversion bears a slight chance of corrupting data.
 505When it is enabled, Git will convert CRLF to LF during commit and LF to
 506CRLF during checkout.  A file that contains a mixture of LF and
 507CRLF before the commit cannot be recreated by Git.  For text
 508files this is the right thing to do: it corrects line endings
 509such that we have only LF line endings in the repository.
 510But for binary files that are accidentally classified as text the
 511conversion can corrupt data.
 512+
 513If you recognize such corruption early you can easily fix it by
 514setting the conversion type explicitly in .gitattributes.  Right
 515after committing you still have the original file in your work
 516tree and this file is not yet corrupted.  You can explicitly tell
 517Git that this file is binary and Git will handle the file
 518appropriately.
 519+
 520Unfortunately, the desired effect of cleaning up text files with
 521mixed line endings and the undesired effect of corrupting binary
 522files cannot be distinguished.  In both cases CRLFs are removed
 523in an irreversible way.  For text files this is the right thing
 524to do because CRLFs are line endings, while for binary files
 525converting CRLFs corrupts data.
 526+
 527Note, this safety check does not mean that a checkout will generate a
 528file identical to the original file for a different setting of
 529`core.eol` and `core.autocrlf`, but only for the current one.  For
 530example, a text file with `LF` would be accepted with `core.eol=lf`
 531and could later be checked out with `core.eol=crlf`, in which case the
 532resulting file would contain `CRLF`, although the original file
 533contained `LF`.  However, in both work trees the line endings would be
 534consistent, that is either all `LF` or all `CRLF`, but never mixed.  A
 535file with mixed line endings would be reported by the `core.safecrlf`
 536mechanism.
 537
 538core.autocrlf::
 539        Setting this variable to "true" is the same as setting
 540        the `text` attribute to "auto" on all files and core.eol to "crlf".
 541        Set to true if you want to have `CRLF` line endings in your
 542        working directory and the repository has LF line endings.
 543        This variable can be set to 'input',
 544        in which case no output conversion is performed.
 545
 546core.checkRoundtripEncoding::
 547        A comma and/or whitespace separated list of encodings that Git
 548        performs UTF-8 round trip checks on if they are used in an
 549        `working-tree-encoding` attribute (see linkgit:gitattributes[5]).
 550        The default value is `SHIFT-JIS`.
 551
 552core.symlinks::
 553        If false, symbolic links are checked out as small plain files that
 554        contain the link text. linkgit:git-update-index[1] and
 555        linkgit:git-add[1] will not change the recorded type to regular
 556        file. Useful on filesystems like FAT that do not support
 557        symbolic links.
 558+
 559The default is true, except linkgit:git-clone[1] or linkgit:git-init[1]
 560will probe and set core.symlinks false if appropriate when the repository
 561is created.
 562
 563core.gitProxy::
 564        A "proxy command" to execute (as 'command host port') instead
 565        of establishing direct connection to the remote server when
 566        using the Git protocol for fetching. If the variable value is
 567        in the "COMMAND for DOMAIN" format, the command is applied only
 568        on hostnames ending with the specified domain string. This variable
 569        may be set multiple times and is matched in the given order;
 570        the first match wins.
 571+
 572Can be overridden by the `GIT_PROXY_COMMAND` environment variable
 573(which always applies universally, without the special "for"
 574handling).
 575+
 576The special string `none` can be used as the proxy command to
 577specify that no proxy be used for a given domain pattern.
 578This is useful for excluding servers inside a firewall from
 579proxy use, while defaulting to a common proxy for external domains.
 580
 581core.sshCommand::
 582        If this variable is set, `git fetch` and `git push` will
 583        use the specified command instead of `ssh` when they need to
 584        connect to a remote system. The command is in the same form as
 585        the `GIT_SSH_COMMAND` environment variable and is overridden
 586        when the environment variable is set.
 587
 588core.ignoreStat::
 589        If true, Git will avoid using lstat() calls to detect if files have
 590        changed by setting the "assume-unchanged" bit for those tracked files
 591        which it has updated identically in both the index and working tree.
 592+
 593When files are modified outside of Git, the user will need to stage
 594the modified files explicitly (e.g. see 'Examples' section in
 595linkgit:git-update-index[1]).
 596Git will not normally detect changes to those files.
 597+
 598This is useful on systems where lstat() calls are very slow, such as
 599CIFS/Microsoft Windows.
 600+
 601False by default.
 602
 603core.preferSymlinkRefs::
 604        Instead of the default "symref" format for HEAD
 605        and other symbolic reference files, use symbolic links.
 606        This is sometimes needed to work with old scripts that
 607        expect HEAD to be a symbolic link.
 608
 609core.bare::
 610        If true this repository is assumed to be 'bare' and has no
 611        working directory associated with it.  If this is the case a
 612        number of commands that require a working directory will be
 613        disabled, such as linkgit:git-add[1] or linkgit:git-merge[1].
 614+
 615This setting is automatically guessed by linkgit:git-clone[1] or
 616linkgit:git-init[1] when the repository was created.  By default a
 617repository that ends in "/.git" is assumed to be not bare (bare =
 618false), while all other repositories are assumed to be bare (bare
 619= true).
 620
 621core.worktree::
 622        Set the path to the root of the working tree.
 623        If `GIT_COMMON_DIR` environment variable is set, core.worktree
 624        is ignored and not used for determining the root of working tree.
 625        This can be overridden by the `GIT_WORK_TREE` environment
 626        variable and the `--work-tree` command-line option.
 627        The value can be an absolute path or relative to the path to
 628        the .git directory, which is either specified by --git-dir
 629        or GIT_DIR, or automatically discovered.
 630        If --git-dir or GIT_DIR is specified but none of
 631        --work-tree, GIT_WORK_TREE and core.worktree is specified,
 632        the current working directory is regarded as the top level
 633        of your working tree.
 634+
 635Note that this variable is honored even when set in a configuration
 636file in a ".git" subdirectory of a directory and its value differs
 637from the latter directory (e.g. "/path/to/.git/config" has
 638core.worktree set to "/different/path"), which is most likely a
 639misconfiguration.  Running Git commands in the "/path/to" directory will
 640still use "/different/path" as the root of the work tree and can cause
 641confusion unless you know what you are doing (e.g. you are creating a
 642read-only snapshot of the same index to a location different from the
 643repository's usual working tree).
 644
 645core.logAllRefUpdates::
 646        Enable the reflog. Updates to a ref <ref> is logged to the file
 647        "`$GIT_DIR/logs/<ref>`", by appending the new and old
 648        SHA-1, the date/time and the reason of the update, but
 649        only when the file exists.  If this configuration
 650        variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
 651        file is automatically created for branch heads (i.e. under
 652        `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
 653        note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
 654        If it is set to `always`, then a missing reflog is automatically
 655        created for any ref under `refs/`.
 656+
 657This information can be used to determine what commit
 658was the tip of a branch "2 days ago".
 659+
 660This value is true by default in a repository that has
 661a working directory associated with it, and false by
 662default in a bare repository.
 663
 664core.repositoryFormatVersion::
 665        Internal variable identifying the repository format and layout
 666        version.
 667
 668core.sharedRepository::
 669        When 'group' (or 'true'), the repository is made shareable between
 670        several users in a group (making sure all the files and objects are
 671        group-writable). When 'all' (or 'world' or 'everybody'), the
 672        repository will be readable by all users, additionally to being
 673        group-shareable. When 'umask' (or 'false'), Git will use permissions
 674        reported by umask(2). When '0xxx', where '0xxx' is an octal number,
 675        files in the repository will have this mode value. '0xxx' will override
 676        user's umask value (whereas the other options will only override
 677        requested parts of the user's umask value). Examples: '0660' will make
 678        the repo read/write-able for the owner and group, but inaccessible to
 679        others (equivalent to 'group' unless umask is e.g. '0022'). '0640' is a
 680        repository that is group-readable but not group-writable.
 681        See linkgit:git-init[1]. False by default.
 682
 683core.warnAmbiguousRefs::
 684        If true, Git will warn you if the ref name you passed it is ambiguous
 685        and might match multiple refs in the repository. True by default.
 686
 687core.compression::
 688        An integer -1..9, indicating a default compression level.
 689        -1 is the zlib default. 0 means no compression,
 690        and 1..9 are various speed/size tradeoffs, 9 being slowest.
 691        If set, this provides a default to other compression variables,
 692        such as `core.looseCompression` and `pack.compression`.
 693
 694core.looseCompression::
 695        An integer -1..9, indicating the compression level for objects that
 696        are not in a pack file. -1 is the zlib default. 0 means no
 697        compression, and 1..9 are various speed/size tradeoffs, 9 being
 698        slowest.  If not set,  defaults to core.compression.  If that is
 699        not set,  defaults to 1 (best speed).
 700
 701core.packedGitWindowSize::
 702        Number of bytes of a pack file to map into memory in a
 703        single mapping operation.  Larger window sizes may allow
 704        your system to process a smaller number of large pack files
 705        more quickly.  Smaller window sizes will negatively affect
 706        performance due to increased calls to the operating system's
 707        memory manager, but may improve performance when accessing
 708        a large number of large pack files.
 709+
 710Default is 1 MiB if NO_MMAP was set at compile time, otherwise 32
 711MiB on 32 bit platforms and 1 GiB on 64 bit platforms.  This should
 712be reasonable for all users/operating systems.  You probably do
 713not need to adjust this value.
 714+
 715Common unit suffixes of 'k', 'm', or 'g' are supported.
 716
 717core.packedGitLimit::
 718        Maximum number of bytes to map simultaneously into memory
 719        from pack files.  If Git needs to access more than this many
 720        bytes at once to complete an operation it will unmap existing
 721        regions to reclaim virtual address space within the process.
 722+
 723Default is 256 MiB on 32 bit platforms and 32 TiB (effectively
 724unlimited) on 64 bit platforms.
 725This should be reasonable for all users/operating systems, except on
 726the largest projects.  You probably do not need to adjust this value.
 727+
 728Common unit suffixes of 'k', 'm', or 'g' are supported.
 729
 730core.deltaBaseCacheLimit::
 731        Maximum number of bytes to reserve for caching base objects
 732        that may be referenced by multiple deltified objects.  By storing the
 733        entire decompressed base objects in a cache Git is able
 734        to avoid unpacking and decompressing frequently used base
 735        objects multiple times.
 736+
 737Default is 96 MiB on all platforms.  This should be reasonable
 738for all users/operating systems, except on the largest projects.
 739You probably do not need to adjust this value.
 740+
 741Common unit suffixes of 'k', 'm', or 'g' are supported.
 742
 743core.bigFileThreshold::
 744        Files larger than this size are stored deflated, without
 745        attempting delta compression.  Storing large files without
 746        delta compression avoids excessive memory usage, at the
 747        slight expense of increased disk usage. Additionally files
 748        larger than this size are always treated as binary.
 749+
 750Default is 512 MiB on all platforms.  This should be reasonable
 751for most projects as source code and other text files can still
 752be delta compressed, but larger binary media files won't be.
 753+
 754Common unit suffixes of 'k', 'm', or 'g' are supported.
 755
 756core.excludesFile::
 757        Specifies the pathname to the file that contains patterns to
 758        describe paths that are not meant to be tracked, in addition
 759        to '.gitignore' (per-directory) and '.git/info/exclude'.
 760        Defaults to `$XDG_CONFIG_HOME/git/ignore`.
 761        If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
 762        is used instead. See linkgit:gitignore[5].
 763
 764core.askPass::
 765        Some commands (e.g. svn and http interfaces) that interactively
 766        ask for a password can be told to use an external program given
 767        via the value of this variable. Can be overridden by the `GIT_ASKPASS`
 768        environment variable. If not set, fall back to the value of the
 769        `SSH_ASKPASS` environment variable or, failing that, a simple password
 770        prompt. The external program shall be given a suitable prompt as
 771        command-line argument and write the password on its STDOUT.
 772
 773core.attributesFile::
 774        In addition to '.gitattributes' (per-directory) and
 775        '.git/info/attributes', Git looks into this file for attributes
 776        (see linkgit:gitattributes[5]). Path expansions are made the same
 777        way as for `core.excludesFile`. Its default value is
 778        `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
 779        set or empty, `$HOME/.config/git/attributes` is used instead.
 780
 781core.hooksPath::
 782        By default Git will look for your hooks in the
 783        '$GIT_DIR/hooks' directory. Set this to different path,
 784        e.g. '/etc/git/hooks', and Git will try to find your hooks in
 785        that directory, e.g. '/etc/git/hooks/pre-receive' instead of
 786        in '$GIT_DIR/hooks/pre-receive'.
 787+
 788The path can be either absolute or relative. A relative path is
 789taken as relative to the directory where the hooks are run (see
 790the "DESCRIPTION" section of linkgit:githooks[5]).
 791+
 792This configuration variable is useful in cases where you'd like to
 793centrally configure your Git hooks instead of configuring them on a
 794per-repository basis, or as a more flexible and centralized
 795alternative to having an `init.templateDir` where you've changed
 796default hooks.
 797
 798core.editor::
 799        Commands such as `commit` and `tag` that let you edit
 800        messages by launching an editor use the value of this
 801        variable when it is set, and the environment variable
 802        `GIT_EDITOR` is not set.  See linkgit:git-var[1].
 803
 804core.commentChar::
 805        Commands such as `commit` and `tag` that let you edit
 806        messages consider a line that begins with this character
 807        commented, and removes them after the editor returns
 808        (default '#').
 809+
 810If set to "auto", `git-commit` would select a character that is not
 811the beginning character of any line in existing commit messages.
 812
 813core.filesRefLockTimeout::
 814        The length of time, in milliseconds, to retry when trying to
 815        lock an individual reference. Value 0 means not to retry at
 816        all; -1 means to try indefinitely. Default is 100 (i.e.,
 817        retry for 100ms).
 818
 819core.packedRefsTimeout::
 820        The length of time, in milliseconds, to retry when trying to
 821        lock the `packed-refs` file. Value 0 means not to retry at
 822        all; -1 means to try indefinitely. Default is 1000 (i.e.,
 823        retry for 1 second).
 824
 825sequence.editor::
 826        Text editor used by `git rebase -i` for editing the rebase instruction file.
 827        The value is meant to be interpreted by the shell when it is used.
 828        It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
 829        When not configured the default commit message editor is used instead.
 830
 831core.pager::
 832        Text viewer for use by Git commands (e.g., 'less').  The value
 833        is meant to be interpreted by the shell.  The order of preference
 834        is the `$GIT_PAGER` environment variable, then `core.pager`
 835        configuration, then `$PAGER`, and then the default chosen at
 836        compile time (usually 'less').
 837+
 838When the `LESS` environment variable is unset, Git sets it to `FRX`
 839(if `LESS` environment variable is set, Git does not change it at
 840all).  If you want to selectively override Git's default setting
 841for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
 842be passed to the shell by Git, which will translate the final
 843command to `LESS=FRX less -S`. The environment does not set the
 844`S` option but the command line does, instructing less to truncate
 845long lines. Similarly, setting `core.pager` to `less -+F` will
 846deactivate the `F` option specified by the environment from the
 847command-line, deactivating the "quit if one screen" behavior of
 848`less`.  One can specifically activate some flags for particular
 849commands: for example, setting `pager.blame` to `less -S` enables
 850line truncation only for `git blame`.
 851+
 852Likewise, when the `LV` environment variable is unset, Git sets it
 853to `-c`.  You can override this setting by exporting `LV` with
 854another value or setting `core.pager` to `lv +c`.
 855
 856core.whitespace::
 857        A comma separated list of common whitespace problems to
 858        notice.  'git diff' will use `color.diff.whitespace` to
 859        highlight them, and 'git apply --whitespace=error' will
 860        consider them as errors.  You can prefix `-` to disable
 861        any of them (e.g. `-trailing-space`):
 862+
 863* `blank-at-eol` treats trailing whitespaces at the end of the line
 864  as an error (enabled by default).
 865* `space-before-tab` treats a space character that appears immediately
 866  before a tab character in the initial indent part of the line as an
 867  error (enabled by default).
 868* `indent-with-non-tab` treats a line that is indented with space
 869  characters instead of the equivalent tabs as an error (not enabled by
 870  default).
 871* `tab-in-indent` treats a tab character in the initial indent part of
 872  the line as an error (not enabled by default).
 873* `blank-at-eof` treats blank lines added at the end of file as an error
 874  (enabled by default).
 875* `trailing-space` is a short-hand to cover both `blank-at-eol` and
 876  `blank-at-eof`.
 877* `cr-at-eol` treats a carriage-return at the end of line as
 878  part of the line terminator, i.e. with it, `trailing-space`
 879  does not trigger if the character before such a carriage-return
 880  is not a whitespace (not enabled by default).
 881* `tabwidth=<n>` tells how many character positions a tab occupies; this
 882  is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
 883  errors. The default tab width is 8. Allowed values are 1 to 63.
 884
 885core.fsyncObjectFiles::
 886        This boolean will enable 'fsync()' when writing object files.
 887+
 888This is a total waste of time and effort on a filesystem that orders
 889data writes properly, but can be useful for filesystems that do not use
 890journalling (traditional UNIX filesystems) or that only journal metadata
 891and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 892
 893core.preloadIndex::
 894        Enable parallel index preload for operations like 'git diff'
 895+
 896This can speed up operations like 'git diff' and 'git status' especially
 897on filesystems like NFS that have weak caching semantics and thus
 898relatively high IO latencies.  When enabled, Git will do the
 899index comparison to the filesystem data in parallel, allowing
 900overlapping IO's.  Defaults to true.
 901
 902core.createObject::
 903        You can set this to 'link', in which case a hardlink followed by
 904        a delete of the source are used to make sure that object creation
 905        will not overwrite existing objects.
 906+
 907On some file system/operating system combinations, this is unreliable.
 908Set this config setting to 'rename' there; However, This will remove the
 909check that makes sure that existing object files will not get overwritten.
 910
 911core.notesRef::
 912        When showing commit messages, also show notes which are stored in
 913        the given ref.  The ref must be fully qualified.  If the given
 914        ref does not exist, it is not an error but means that no
 915        notes should be printed.
 916+
 917This setting defaults to "refs/notes/commits", and it can be overridden by
 918the `GIT_NOTES_REF` environment variable.  See linkgit:git-notes[1].
 919
 920gc.commitGraph::
 921        If true, then gc will rewrite the commit-graph file when
 922        linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
 923        '--auto' the commit-graph will be updated if housekeeping is
 924        required. Default is false. See linkgit:git-commit-graph[1]
 925        for details.
 926
 927core.useReplaceRefs::
 928        If set to `false`, behave as if the `--no-replace-objects`
 929        option was given on the command line. See linkgit:git[1] and
 930        linkgit:git-replace[1] for more information.
 931
 932core.sparseCheckout::
 933        Enable "sparse checkout" feature. See section "Sparse checkout" in
 934        linkgit:git-read-tree[1] for more information.
 935
 936core.abbrev::
 937        Set the length object names are abbreviated to.  If
 938        unspecified or set to "auto", an appropriate value is
 939        computed based on the approximate number of packed objects
 940        in your repository, which hopefully is enough for
 941        abbreviated object names to stay unique for some time.
 942        The minimum length is 4.
 943
 944add.ignoreErrors::
 945add.ignore-errors (deprecated)::
 946        Tells 'git add' to continue adding files when some files cannot be
 947        added due to indexing errors. Equivalent to the `--ignore-errors`
 948        option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
 949        as it does not follow the usual naming convention for configuration
 950        variables.
 951
 952alias.*::
 953        Command aliases for the linkgit:git[1] command wrapper - e.g.
 954        after defining "alias.last = cat-file commit HEAD", the invocation
 955        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 956        confusion and troubles with script usage, aliases that
 957        hide existing Git commands are ignored. Arguments are split by
 958        spaces, the usual shell quoting and escaping is supported.
 959        A quote pair or a backslash can be used to quote them.
 960+
 961If the alias expansion is prefixed with an exclamation point,
 962it will be treated as a shell command.  For example, defining
 963"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 964"git new" is equivalent to running the shell command
 965"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 966executed from the top-level directory of a repository, which may
 967not necessarily be the current directory.
 968`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
 969from the original current directory. See linkgit:git-rev-parse[1].
 970
 971am.keepcr::
 972        If true, git-am will call git-mailsplit for patches in mbox format
 973        with parameter `--keep-cr`. In this case git-mailsplit will
 974        not remove `\r` from lines ending with `\r\n`. Can be overridden
 975        by giving `--no-keep-cr` from the command line.
 976        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 977
 978am.threeWay::
 979        By default, `git am` will fail if the patch does not apply cleanly. When
 980        set to true, this setting tells `git am` to fall back on 3-way merge if
 981        the patch records the identity of blobs it is supposed to apply to and
 982        we have those blobs available locally (equivalent to giving the `--3way`
 983        option from the command line). Defaults to `false`.
 984        See linkgit:git-am[1].
 985
 986apply.ignoreWhitespace::
 987        When set to 'change', tells 'git apply' to ignore changes in
 988        whitespace, in the same way as the `--ignore-space-change`
 989        option.
 990        When set to one of: no, none, never, false tells 'git apply' to
 991        respect all whitespace differences.
 992        See linkgit:git-apply[1].
 993
 994apply.whitespace::
 995        Tells 'git apply' how to handle whitespaces, in the same way
 996        as the `--whitespace` option. See linkgit:git-apply[1].
 997
 998blame.blankBoundary::
 999        Show blank commit object name for boundary commits in
1000        linkgit:git-blame[1]. This option defaults to false.
1001
1002blame.coloring::
1003        This determines the coloring scheme to be applied to blame
1004        output. It can be 'repeatedLines', 'highlightRecent',
1005        or 'none' which is the default.
1006
1007blame.date::
1008        Specifies the format used to output dates in linkgit:git-blame[1].
1009        If unset the iso format is used. For supported values,
1010        see the discussion of the `--date` option at linkgit:git-log[1].
1011
1012blame.showEmail::
1013        Show the author email instead of author name in linkgit:git-blame[1].
1014        This option defaults to false.
1015
1016blame.showRoot::
1017        Do not treat root commits as boundaries in linkgit:git-blame[1].
1018        This option defaults to false.
1019
1020branch.autoSetupMerge::
1021        Tells 'git branch' and 'git checkout' to set up new branches
1022        so that linkgit:git-pull[1] will appropriately merge from the
1023        starting point branch. Note that even if this option is not set,
1024        this behavior can be chosen per-branch using the `--track`
1025        and `--no-track` options. The valid settings are: `false` -- no
1026        automatic setup is done; `true` -- automatic setup is done when the
1027        starting point is a remote-tracking branch; `always` --
1028        automatic setup is done when the starting point is either a
1029        local branch or remote-tracking
1030        branch. This option defaults to true.
1031
1032branch.autoSetupRebase::
1033        When a new branch is created with 'git branch' or 'git checkout'
1034        that tracks another branch, this variable tells Git to set
1035        up pull to rebase instead of merge (see "branch.<name>.rebase").
1036        When `never`, rebase is never automatically set to true.
1037        When `local`, rebase is set to true for tracked branches of
1038        other local branches.
1039        When `remote`, rebase is set to true for tracked branches of
1040        remote-tracking branches.
1041        When `always`, rebase will be set to true for all tracking
1042        branches.
1043        See "branch.autoSetupMerge" for details on how to set up a
1044        branch to track another branch.
1045        This option defaults to never.
1046
1047branch.<name>.remote::
1048        When on branch <name>, it tells 'git fetch' and 'git push'
1049        which remote to fetch from/push to.  The remote to push to
1050        may be overridden with `remote.pushDefault` (for all branches).
1051        The remote to push to, for the current branch, may be further
1052        overridden by `branch.<name>.pushRemote`.  If no remote is
1053        configured, or if you are not on any branch, it defaults to
1054        `origin` for fetching and `remote.pushDefault` for pushing.
1055        Additionally, `.` (a period) is the current local repository
1056        (a dot-repository), see `branch.<name>.merge`'s final note below.
1057
1058branch.<name>.pushRemote::
1059        When on branch <name>, it overrides `branch.<name>.remote` for
1060        pushing.  It also overrides `remote.pushDefault` for pushing
1061        from branch <name>.  When you pull from one place (e.g. your
1062        upstream) and push to another place (e.g. your own publishing
1063        repository), you would want to set `remote.pushDefault` to
1064        specify the remote to push to for all branches, and use this
1065        option to override it for a specific branch.
1066
1067branch.<name>.merge::
1068        Defines, together with branch.<name>.remote, the upstream branch
1069        for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1070        branch to merge and can also affect 'git push' (see push.default).
1071        When in branch <name>, it tells 'git fetch' the default
1072        refspec to be marked for merging in FETCH_HEAD. The value is
1073        handled like the remote part of a refspec, and must match a
1074        ref which is fetched from the remote given by
1075        "branch.<name>.remote".
1076        The merge information is used by 'git pull' (which at first calls
1077        'git fetch') to lookup the default branch for merging. Without
1078        this option, 'git pull' defaults to merge the first refspec fetched.
1079        Specify multiple values to get an octopus merge.
1080        If you wish to setup 'git pull' so that it merges into <name> from
1081        another branch in the local repository, you can point
1082        branch.<name>.merge to the desired branch, and use the relative path
1083        setting `.` (a period) for branch.<name>.remote.
1084
1085branch.<name>.mergeOptions::
1086        Sets default options for merging into branch <name>. The syntax and
1087        supported options are the same as those of linkgit:git-merge[1], but
1088        option values containing whitespace characters are currently not
1089        supported.
1090
1091branch.<name>.rebase::
1092        When true, rebase the branch <name> on top of the fetched branch,
1093        instead of merging the default branch from the default remote when
1094        "git pull" is run. See "pull.rebase" for doing this in a non
1095        branch-specific manner.
1096+
1097When `merges`, pass the `--rebase-merges` option to 'git rebase'
1098so that the local merge commits are included in the rebase (see
1099linkgit:git-rebase[1] for details).
1100+
1101When preserve, also pass `--preserve-merges` along to 'git rebase'
1102so that locally committed merge commits will not be flattened
1103by running 'git pull'.
1104+
1105When the value is `interactive`, the rebase is run in interactive mode.
1106+
1107*NOTE*: this is a possibly dangerous operation; do *not* use
1108it unless you understand the implications (see linkgit:git-rebase[1]
1109for details).
1110
1111branch.<name>.description::
1112        Branch description, can be edited with
1113        `git branch --edit-description`. Branch description is
1114        automatically added in the format-patch cover letter or
1115        request-pull summary.
1116
1117browser.<tool>.cmd::
1118        Specify the command to invoke the specified browser. The
1119        specified command is evaluated in shell with the URLs passed
1120        as arguments. (See linkgit:git-web{litdd}browse[1].)
1121
1122browser.<tool>.path::
1123        Override the path for the given tool that may be used to
1124        browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1125        working repository in gitweb (see linkgit:git-instaweb[1]).
1126
1127checkout.defaultRemote::
1128        When you run 'git checkout <something>' and only have one
1129        remote, it may implicitly fall back on checking out and
1130        tracking e.g. 'origin/<something>'. This stops working as soon
1131        as you have more than one remote with a '<something>'
1132        reference. This setting allows for setting the name of a
1133        preferred remote that should always win when it comes to
1134        disambiguation. The typical use-case is to set this to
1135        `origin`.
1136+
1137Currently this is used by linkgit:git-checkout[1] when 'git checkout
1138<something>' will checkout the '<something>' branch on another remote,
1139and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1140remote branch. This setting might be used for other checkout-like
1141commands or functionality in the future.
1142
1143clean.requireForce::
1144        A boolean to make git-clean do nothing unless given -f,
1145        -i or -n.   Defaults to true.
1146
1147color.advice::
1148        A boolean to enable/disable color in hints (e.g. when a push
1149        failed, see `advice.*` for a list).  May be set to `always`,
1150        `false` (or `never`) or `auto` (or `true`), in which case colors
1151        are used only when the error output goes to a terminal. If
1152        unset, then the value of `color.ui` is used (`auto` by default).
1153
1154color.advice.hint::
1155        Use customized color for hints.
1156
1157color.blame.highlightRecent::
1158        This can be used to color the metadata of a blame line depending
1159        on age of the line.
1160+
1161This setting should be set to a comma-separated list of color and date settings,
1162starting and ending with a color, the dates should be set from oldest to newest.
1163The metadata will be colored given the colors if the the line was introduced
1164before the given timestamp, overwriting older timestamped colors.
1165+
1166Instead of an absolute timestamp relative timestamps work as well, e.g.
11672.weeks.ago is valid to address anything older than 2 weeks.
1168+
1169It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1170everything older than one year blue, recent changes between one month and
1171one year old are kept white, and lines introduced within the last month are
1172colored red.
1173
1174color.blame.repeatedLines::
1175        Use the customized color for the part of git-blame output that
1176        is repeated meta information per line (such as commit id,
1177        author name, date and timezone). Defaults to cyan.
1178
1179color.branch::
1180        A boolean to enable/disable color in the output of
1181        linkgit:git-branch[1]. May be set to `always`,
1182        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1183        only when the output is to a terminal. If unset, then the
1184        value of `color.ui` is used (`auto` by default).
1185
1186color.branch.<slot>::
1187        Use customized color for branch coloration. `<slot>` is one of
1188        `current` (the current branch), `local` (a local branch),
1189        `remote` (a remote-tracking branch in refs/remotes/),
1190        `upstream` (upstream tracking branch), `plain` (other
1191        refs).
1192
1193color.diff::
1194        Whether to use ANSI escape sequences to add color to patches.
1195        If this is set to `always`, linkgit:git-diff[1],
1196        linkgit:git-log[1], and linkgit:git-show[1] will use color
1197        for all patches.  If it is set to `true` or `auto`, those
1198        commands will only use color when output is to the terminal.
1199        If unset, then the value of `color.ui` is used (`auto` by
1200        default).
1201+
1202This does not affect linkgit:git-format-patch[1] or the
1203'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
1204command line with the `--color[=<when>]` option.
1205
1206diff.colorMoved::
1207        If set to either a valid `<mode>` or a true value, moved lines
1208        in a diff are colored differently, for details of valid modes
1209        see '--color-moved' in linkgit:git-diff[1]. If simply set to
1210        true the default color mode will be used. When set to false,
1211        moved lines are not colored.
1212
1213diff.colorMovedWS::
1214        When moved lines are colored using e.g. the `diff.colorMoved` setting,
1215        this option controls the `<mode>` how spaces are treated
1216        for details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].
1217
1218color.diff.<slot>::
1219        Use customized color for diff colorization.  `<slot>` specifies
1220        which part of the patch to use the specified color, and is one
1221        of `context` (context text - `plain` is a historical synonym),
1222        `meta` (metainformation), `frag`
1223        (hunk header), 'func' (function in hunk header), `old` (removed lines),
1224        `new` (added lines), `commit` (commit headers), `whitespace`
1225        (highlighting whitespace errors), `oldMoved` (deleted lines),
1226        `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1227        `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1228        and `newMovedAlternativeDimmed` (See the '<mode>'
1229        setting of '--color-moved' in linkgit:git-diff[1] for details).
1230
1231color.decorate.<slot>::
1232        Use customized color for 'git log --decorate' output.  `<slot>` is one
1233        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1234        branches, remote-tracking branches, tags, stash and HEAD, respectively
1235        and `grafted` for grafted commits.
1236
1237color.grep::
1238        When set to `always`, always highlight matches.  When `false` (or
1239        `never`), never.  When set to `true` or `auto`, use color only
1240        when the output is written to the terminal.  If unset, then the
1241        value of `color.ui` is used (`auto` by default).
1242
1243color.grep.<slot>::
1244        Use customized color for grep colorization.  `<slot>` specifies which
1245        part of the line to use the specified color, and is one of
1246+
1247--
1248`context`;;
1249        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1250`filename`;;
1251        filename prefix (when not using `-h`)
1252`function`;;
1253        function name lines (when using `-p`)
1254`lineNumber`;;
1255        line number prefix (when using `-n`)
1256`column`;;
1257        column number prefix (when using `--column`)
1258`match`;;
1259        matching text (same as setting `matchContext` and `matchSelected`)
1260`matchContext`;;
1261        matching text in context lines
1262`matchSelected`;;
1263        matching text in selected lines
1264`selected`;;
1265        non-matching text in selected lines
1266`separator`;;
1267        separators between fields on a line (`:`, `-`, and `=`)
1268        and between hunks (`--`)
1269--
1270
1271color.interactive::
1272        When set to `always`, always use colors for interactive prompts
1273        and displays (such as those used by "git-add --interactive" and
1274        "git-clean --interactive"). When false (or `never`), never.
1275        When set to `true` or `auto`, use colors only when the output is
1276        to the terminal. If unset, then the value of `color.ui` is
1277        used (`auto` by default).
1278
1279color.interactive.<slot>::
1280        Use customized color for 'git add --interactive' and 'git clean
1281        --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1282        or `error`, for four distinct types of normal output from
1283        interactive commands.
1284
1285color.pager::
1286        A boolean to enable/disable colored output when the pager is in
1287        use (default is true).
1288
1289color.push::
1290        A boolean to enable/disable color in push errors. May be set to
1291        `always`, `false` (or `never`) or `auto` (or `true`), in which
1292        case colors are used only when the error output goes to a terminal.
1293        If unset, then the value of `color.ui` is used (`auto` by default).
1294
1295color.push.error::
1296        Use customized color for push errors.
1297
1298color.showBranch::
1299        A boolean to enable/disable color in the output of
1300        linkgit:git-show-branch[1]. May be set to `always`,
1301        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1302        only when the output is to a terminal. If unset, then the
1303        value of `color.ui` is used (`auto` by default).
1304
1305color.status::
1306        A boolean to enable/disable color in the output of
1307        linkgit:git-status[1]. May be set to `always`,
1308        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1309        only when the output is to a terminal. If unset, then the
1310        value of `color.ui` is used (`auto` by default).
1311
1312color.status.<slot>::
1313        Use customized color for status colorization. `<slot>` is
1314        one of `header` (the header text of the status message),
1315        `added` or `updated` (files which are added but not committed),
1316        `changed` (files which are changed but not added in the index),
1317        `untracked` (files which are not tracked by Git),
1318        `branch` (the current branch),
1319        `nobranch` (the color the 'no branch' warning is shown in, defaulting
1320        to red),
1321        `localBranch` or `remoteBranch` (the local and remote branch names,
1322        respectively, when branch and tracking information is displayed in the
1323        status short-format), or
1324        `unmerged` (files which have unmerged changes).
1325
1326color.transport::
1327        A boolean to enable/disable color when pushes are rejected. May be
1328        set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1329        case colors are used only when the error output goes to a terminal.
1330        If unset, then the value of `color.ui` is used (`auto` by default).
1331
1332color.transport.rejected::
1333        Use customized color when a push was rejected.
1334
1335color.ui::
1336        This variable determines the default value for variables such
1337        as `color.diff` and `color.grep` that control the use of color
1338        per command family. Its scope will expand as more commands learn
1339        configuration to set a default for the `--color` option.  Set it
1340        to `false` or `never` if you prefer Git commands not to use
1341        color unless enabled explicitly with some other configuration
1342        or the `--color` option. Set it to `always` if you want all
1343        output not intended for machine consumption to use color, to
1344        `true` or `auto` (this is the default since Git 1.8.4) if you
1345        want such output to use color when written to the terminal.
1346
1347column.ui::
1348        Specify whether supported commands should output in columns.
1349        This variable consists of a list of tokens separated by spaces
1350        or commas:
1351+
1352These options control when the feature should be enabled
1353(defaults to 'never'):
1354+
1355--
1356`always`;;
1357        always show in columns
1358`never`;;
1359        never show in columns
1360`auto`;;
1361        show in columns if the output is to the terminal
1362--
1363+
1364These options control layout (defaults to 'column').  Setting any
1365of these implies 'always' if none of 'always', 'never', or 'auto' are
1366specified.
1367+
1368--
1369`column`;;
1370        fill columns before rows
1371`row`;;
1372        fill rows before columns
1373`plain`;;
1374        show in one column
1375--
1376+
1377Finally, these options can be combined with a layout option (defaults
1378to 'nodense'):
1379+
1380--
1381`dense`;;
1382        make unequal size columns to utilize more space
1383`nodense`;;
1384        make equal size columns
1385--
1386
1387column.branch::
1388        Specify whether to output branch listing in `git branch` in columns.
1389        See `column.ui` for details.
1390
1391column.clean::
1392        Specify the layout when list items in `git clean -i`, which always
1393        shows files and directories in columns. See `column.ui` for details.
1394
1395column.status::
1396        Specify whether to output untracked files in `git status` in columns.
1397        See `column.ui` for details.
1398
1399column.tag::
1400        Specify whether to output tag listing in `git tag` in columns.
1401        See `column.ui` for details.
1402
1403commit.cleanup::
1404        This setting overrides the default of the `--cleanup` option in
1405        `git commit`. See linkgit:git-commit[1] for details. Changing the
1406        default can be useful when you always want to keep lines that begin
1407        with comment character `#` in your log message, in which case you
1408        would do `git config commit.cleanup whitespace` (note that you will
1409        have to remove the help lines that begin with `#` in the commit log
1410        template yourself, if you do this).
1411
1412commit.gpgSign::
1413
1414        A boolean to specify whether all commits should be GPG signed.
1415        Use of this option when doing operations such as rebase can
1416        result in a large number of commits being signed. It may be
1417        convenient to use an agent to avoid typing your GPG passphrase
1418        several times.
1419
1420commit.status::
1421        A boolean to enable/disable inclusion of status information in the
1422        commit message template when using an editor to prepare the commit
1423        message.  Defaults to true.
1424
1425commit.template::
1426        Specify the pathname of a file to use as the template for
1427        new commit messages.
1428
1429commit.verbose::
1430        A boolean or int to specify the level of verbose with `git commit`.
1431        See linkgit:git-commit[1].
1432
1433credential.helper::
1434        Specify an external helper to be called when a username or
1435        password credential is needed; the helper may consult external
1436        storage to avoid prompting the user for the credentials. Note
1437        that multiple helpers may be defined. See linkgit:gitcredentials[7]
1438        for details.
1439
1440credential.useHttpPath::
1441        When acquiring credentials, consider the "path" component of an http
1442        or https URL to be important. Defaults to false. See
1443        linkgit:gitcredentials[7] for more information.
1444
1445credential.username::
1446        If no username is set for a network authentication, use this username
1447        by default. See credential.<context>.* below, and
1448        linkgit:gitcredentials[7].
1449
1450credential.<url>.*::
1451        Any of the credential.* options above can be applied selectively to
1452        some credentials. For example "credential.https://example.com.username"
1453        would set the default username only for https connections to
1454        example.com. See linkgit:gitcredentials[7] for details on how URLs are
1455        matched.
1456
1457credentialCache.ignoreSIGHUP::
1458        Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1459
1460completion.commands::
1461        This is only used by git-completion.bash to add or remove
1462        commands from the list of completed commands. Normally only
1463        porcelain commands and a few select others are completed. You
1464        can add more commands, separated by space, in this
1465        variable. Prefixing the command with '-' will remove it from
1466        the existing list.
1467
1468include::diff-config.txt[]
1469
1470difftool.<tool>.path::
1471        Override the path for the given tool.  This is useful in case
1472        your tool is not in the PATH.
1473
1474difftool.<tool>.cmd::
1475        Specify the command to invoke the specified diff tool.
1476        The specified command is evaluated in shell with the following
1477        variables available:  'LOCAL' is set to the name of the temporary
1478        file containing the contents of the diff pre-image and 'REMOTE'
1479        is set to the name of the temporary file containing the contents
1480        of the diff post-image.
1481
1482difftool.prompt::
1483        Prompt before each invocation of the diff tool.
1484
1485fastimport.unpackLimit::
1486        If the number of objects imported by linkgit:git-fast-import[1]
1487        is below this limit, then the objects will be unpacked into
1488        loose object files.  However if the number of imported objects
1489        equals or exceeds this limit then the pack will be stored as a
1490        pack.  Storing the pack from a fast-import can make the import
1491        operation complete faster, especially on slow filesystems.  If
1492        not set, the value of `transfer.unpackLimit` is used instead.
1493
1494fetch.recurseSubmodules::
1495        This option can be either set to a boolean value or to 'on-demand'.
1496        Setting it to a boolean changes the behavior of fetch and pull to
1497        unconditionally recurse into submodules when set to true or to not
1498        recurse at all when set to false. When set to 'on-demand' (the default
1499        value), fetch and pull will only recurse into a populated submodule
1500        when its superproject retrieves a commit that updates the submodule's
1501        reference.
1502
1503fetch.fsckObjects::
1504        If it is set to true, git-fetch-pack will check all fetched
1505        objects. See `transfer.fsckObjects` for what's
1506        checked. Defaults to false. If not set, the value of
1507        `transfer.fsckObjects` is used instead.
1508
1509fetch.fsck.<msg-id>::
1510        Acts like `fsck.<msg-id>`, but is used by
1511        linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1512        the `fsck.<msg-id>` documentation for details.
1513
1514fetch.fsck.skipList::
1515        Acts like `fsck.skipList`, but is used by
1516        linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1517        the `fsck.skipList` documentation for details.
1518
1519fetch.unpackLimit::
1520        If the number of objects fetched over the Git native
1521        transfer is below this
1522        limit, then the objects will be unpacked into loose object
1523        files. However if the number of received objects equals or
1524        exceeds this limit then the received pack will be stored as
1525        a pack, after adding any missing delta bases.  Storing the
1526        pack from a push can make the push operation complete faster,
1527        especially on slow filesystems.  If not set, the value of
1528        `transfer.unpackLimit` is used instead.
1529
1530fetch.prune::
1531        If true, fetch will automatically behave as if the `--prune`
1532        option was given on the command line.  See also `remote.<name>.prune`
1533        and the PRUNING section of linkgit:git-fetch[1].
1534
1535fetch.pruneTags::
1536        If true, fetch will automatically behave as if the
1537        `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1538        if not set already. This allows for setting both this option
1539        and `fetch.prune` to maintain a 1=1 mapping to upstream
1540        refs. See also `remote.<name>.pruneTags` and the PRUNING
1541        section of linkgit:git-fetch[1].
1542
1543fetch.output::
1544        Control how ref update status is printed. Valid values are
1545        `full` and `compact`. Default value is `full`. See section
1546        OUTPUT in linkgit:git-fetch[1] for detail.
1547
1548fetch.negotiationAlgorithm::
1549        Control how information about the commits in the local repository is
1550        sent when negotiating the contents of the packfile to be sent by the
1551        server. Set to "skipping" to use an algorithm that skips commits in an
1552        effort to converge faster, but may result in a larger-than-necessary
1553        packfile; The default is "default" which instructs Git to use the default algorithm
1554        that never skips commits (unless the server has acknowledged it or one
1555        of its descendants).
1556        Unknown values will cause 'git fetch' to error out.
1557+
1558See also the `--negotiation-tip` option for linkgit:git-fetch[1].
1559
1560format.attach::
1561        Enable multipart/mixed attachments as the default for
1562        'format-patch'.  The value can also be a double quoted string
1563        which will enable attachments as the default and set the
1564        value as the boundary.  See the --attach option in
1565        linkgit:git-format-patch[1].
1566
1567format.from::
1568        Provides the default value for the `--from` option to format-patch.
1569        Accepts a boolean value, or a name and email address.  If false,
1570        format-patch defaults to `--no-from`, using commit authors directly in
1571        the "From:" field of patch mails.  If true, format-patch defaults to
1572        `--from`, using your committer identity in the "From:" field of patch
1573        mails and including a "From:" field in the body of the patch mail if
1574        different.  If set to a non-boolean value, format-patch uses that
1575        value instead of your committer identity.  Defaults to false.
1576
1577format.numbered::
1578        A boolean which can enable or disable sequence numbers in patch
1579        subjects.  It defaults to "auto" which enables it only if there
1580        is more than one patch.  It can be enabled or disabled for all
1581        messages by setting it to "true" or "false".  See --numbered
1582        option in linkgit:git-format-patch[1].
1583
1584format.headers::
1585        Additional email headers to include in a patch to be submitted
1586        by mail.  See linkgit:git-format-patch[1].
1587
1588format.to::
1589format.cc::
1590        Additional recipients to include in a patch to be submitted
1591        by mail.  See the --to and --cc options in
1592        linkgit:git-format-patch[1].
1593
1594format.subjectPrefix::
1595        The default for format-patch is to output files with the '[PATCH]'
1596        subject prefix. Use this variable to change that prefix.
1597
1598format.signature::
1599        The default for format-patch is to output a signature containing
1600        the Git version number. Use this variable to change that default.
1601        Set this variable to the empty string ("") to suppress
1602        signature generation.
1603
1604format.signatureFile::
1605        Works just like format.signature except the contents of the
1606        file specified by this variable will be used as the signature.
1607
1608format.suffix::
1609        The default for format-patch is to output files with the suffix
1610        `.patch`. Use this variable to change that suffix (make sure to
1611        include the dot if you want it).
1612
1613format.pretty::
1614        The default pretty format for log/show/whatchanged command,
1615        See linkgit:git-log[1], linkgit:git-show[1],
1616        linkgit:git-whatchanged[1].
1617
1618format.thread::
1619        The default threading style for 'git format-patch'.  Can be
1620        a boolean value, or `shallow` or `deep`.  `shallow` threading
1621        makes every mail a reply to the head of the series,
1622        where the head is chosen from the cover letter, the
1623        `--in-reply-to`, and the first patch mail, in this order.
1624        `deep` threading makes every mail a reply to the previous one.
1625        A true boolean value is the same as `shallow`, and a false
1626        value disables threading.
1627
1628format.signOff::
1629        A boolean value which lets you enable the `-s/--signoff` option of
1630        format-patch by default. *Note:* Adding the Signed-off-by: line to a
1631        patch should be a conscious act and means that you certify you have
1632        the rights to submit this work under the same open source license.
1633        Please see the 'SubmittingPatches' document for further discussion.
1634
1635format.coverLetter::
1636        A boolean that controls whether to generate a cover-letter when
1637        format-patch is invoked, but in addition can be set to "auto", to
1638        generate a cover-letter only when there's more than one patch.
1639
1640format.outputDirectory::
1641        Set a custom directory to store the resulting files instead of the
1642        current working directory.
1643
1644format.useAutoBase::
1645        A boolean value which lets you enable the `--base=auto` option of
1646        format-patch by default.
1647
1648filter.<driver>.clean::
1649        The command which is used to convert the content of a worktree
1650        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1651        details.
1652
1653filter.<driver>.smudge::
1654        The command which is used to convert the content of a blob
1655        object to a worktree file upon checkout.  See
1656        linkgit:gitattributes[5] for details.
1657
1658fsck.<msg-id>::
1659        During fsck git may find issues with legacy data which
1660        wouldn't be generated by current versions of git, and which
1661        wouldn't be sent over the wire if `transfer.fsckObjects` was
1662        set. This feature is intended to support working with legacy
1663        repositories containing such data.
1664+
1665Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1666to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1667to clone or fetch it set `fetch.fsck.<msg-id>`.
1668+
1669The rest of the documentation discusses `fsck.*` for brevity, but the
1670same applies for the corresponding `receive.fsck.*` and
1671`fetch.<msg-id>.*`. variables.
1672+
1673Unlike variables like `color.ui` and `core.editor` the
1674`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1675fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1676uniformly configure the same fsck settings in different circumstances
1677all three of them they must all set to the same values.
1678+
1679When `fsck.<msg-id>` is set, errors can be switched to warnings and
1680vice versa by configuring the `fsck.<msg-id>` setting where the
1681`<msg-id>` is the fsck message ID and the value is one of `error`,
1682`warn` or `ignore`. For convenience, fsck prefixes the error/warning
1683with the message ID, e.g. "missingEmail: invalid author/committer line
1684- missing email" means that setting `fsck.missingEmail = ignore` will
1685hide that issue.
1686+
1687In general, it is better to enumerate existing objects with problems
1688with `fsck.skipList`, instead of listing the kind of breakages these
1689problematic objects share to be ignored, as doing the latter will
1690allow new instances of the same breakages go unnoticed.
1691+
1692Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1693doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1694will only cause git to warn.
1695
1696fsck.skipList::
1697        The path to a sorted list of object names (i.e. one SHA-1 per
1698        line) that are known to be broken in a non-fatal way and should
1699        be ignored. This feature is useful when an established project
1700        should be accepted despite early commits containing errors that
1701        can be safely ignored such as invalid committer email addresses.
1702        Note: corrupt objects cannot be skipped with this setting.
1703+
1704Like `fsck.<msg-id>` this variable has corresponding
1705`receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1706+
1707Unlike variables like `color.ui` and `core.editor` the
1708`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1709fall back on the `fsck.skipList` configuration if they aren't set. To
1710uniformly configure the same fsck settings in different circumstances
1711all three of them they must all set to the same values.
1712
1713gc.aggressiveDepth::
1714        The depth parameter used in the delta compression
1715        algorithm used by 'git gc --aggressive'.  This defaults
1716        to 50.
1717
1718gc.aggressiveWindow::
1719        The window size parameter used in the delta compression
1720        algorithm used by 'git gc --aggressive'.  This defaults
1721        to 250.
1722
1723gc.auto::
1724        When there are approximately more than this many loose
1725        objects in the repository, `git gc --auto` will pack them.
1726        Some Porcelain commands use this command to perform a
1727        light-weight garbage collection from time to time.  The
1728        default value is 6700.  Setting this to 0 disables it.
1729
1730gc.autoPackLimit::
1731        When there are more than this many packs that are not
1732        marked with `*.keep` file in the repository, `git gc
1733        --auto` consolidates them into one larger pack.  The
1734        default value is 50.  Setting this to 0 disables it.
1735
1736gc.autoDetach::
1737        Make `git gc --auto` return immediately and run in background
1738        if the system supports it. Default is true.
1739
1740gc.bigPackThreshold::
1741        If non-zero, all packs larger than this limit are kept when
1742        `git gc` is run. This is very similar to `--keep-base-pack`
1743        except that all packs that meet the threshold are kept, not
1744        just the base pack. Defaults to zero. Common unit suffixes of
1745        'k', 'm', or 'g' are supported.
1746+
1747Note that if the number of kept packs is more than gc.autoPackLimit,
1748this configuration variable is ignored, all packs except the base pack
1749will be repacked. After this the number of packs should go below
1750gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1751
1752gc.logExpiry::
1753        If the file gc.log exists, then `git gc --auto` won't run
1754        unless that file is more than 'gc.logExpiry' old.  Default is
1755        "1.day".  See `gc.pruneExpire` for more ways to specify its
1756        value.
1757
1758gc.packRefs::
1759        Running `git pack-refs` in a repository renders it
1760        unclonable by Git versions prior to 1.5.1.2 over dumb
1761        transports such as HTTP.  This variable determines whether
1762        'git gc' runs `git pack-refs`. This can be set to `notbare`
1763        to enable it within all non-bare repos or it can be set to a
1764        boolean value.  The default is `true`.
1765
1766gc.pruneExpire::
1767        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1768        Override the grace period with this config variable.  The value
1769        "now" may be used to disable this grace period and always prune
1770        unreachable objects immediately, or "never" may be used to
1771        suppress pruning.  This feature helps prevent corruption when
1772        'git gc' runs concurrently with another process writing to the
1773        repository; see the "NOTES" section of linkgit:git-gc[1].
1774
1775gc.worktreePruneExpire::
1776        When 'git gc' is run, it calls
1777        'git worktree prune --expire 3.months.ago'.
1778        This config variable can be used to set a different grace
1779        period. The value "now" may be used to disable the grace
1780        period and prune `$GIT_DIR/worktrees` immediately, or "never"
1781        may be used to suppress pruning.
1782
1783gc.reflogExpire::
1784gc.<pattern>.reflogExpire::
1785        'git reflog expire' removes reflog entries older than
1786        this time; defaults to 90 days. The value "now" expires all
1787        entries immediately, and "never" suppresses expiration
1788        altogether. With "<pattern>" (e.g.
1789        "refs/stash") in the middle the setting applies only to
1790        the refs that match the <pattern>.
1791
1792gc.reflogExpireUnreachable::
1793gc.<pattern>.reflogExpireUnreachable::
1794        'git reflog expire' removes reflog entries older than
1795        this time and are not reachable from the current tip;
1796        defaults to 30 days. The value "now" expires all entries
1797        immediately, and "never" suppresses expiration altogether.
1798        With "<pattern>" (e.g. "refs/stash")
1799        in the middle, the setting applies only to the refs that
1800        match the <pattern>.
1801
1802gc.rerereResolved::
1803        Records of conflicted merge you resolved earlier are
1804        kept for this many days when 'git rerere gc' is run.
1805        You can also use more human-readable "1.month.ago", etc.
1806        The default is 60 days.  See linkgit:git-rerere[1].
1807
1808gc.rerereUnresolved::
1809        Records of conflicted merge you have not resolved are
1810        kept for this many days when 'git rerere gc' is run.
1811        You can also use more human-readable "1.month.ago", etc.
1812        The default is 15 days.  See linkgit:git-rerere[1].
1813
1814gitcvs.commitMsgAnnotation::
1815        Append this string to each commit message. Set to empty string
1816        to disable this feature. Defaults to "via git-CVS emulator".
1817
1818gitcvs.enabled::
1819        Whether the CVS server interface is enabled for this repository.
1820        See linkgit:git-cvsserver[1].
1821
1822gitcvs.logFile::
1823        Path to a log file where the CVS server interface well... logs
1824        various stuff. See linkgit:git-cvsserver[1].
1825
1826gitcvs.usecrlfattr::
1827        If true, the server will look up the end-of-line conversion
1828        attributes for files to determine the `-k` modes to use. If
1829        the attributes force Git to treat a file as text,
1830        the `-k` mode will be left blank so CVS clients will
1831        treat it as text. If they suppress text conversion, the file
1832        will be set with '-kb' mode, which suppresses any newline munging
1833        the client might otherwise do. If the attributes do not allow
1834        the file type to be determined, then `gitcvs.allBinary` is
1835        used. See linkgit:gitattributes[5].
1836
1837gitcvs.allBinary::
1838        This is used if `gitcvs.usecrlfattr` does not resolve
1839        the correct '-kb' mode to use. If true, all
1840        unresolved files are sent to the client in
1841        mode '-kb'. This causes the client to treat them
1842        as binary files, which suppresses any newline munging it
1843        otherwise might do. Alternatively, if it is set to "guess",
1844        then the contents of the file are examined to decide if
1845        it is binary, similar to `core.autocrlf`.
1846
1847gitcvs.dbName::
1848        Database used by git-cvsserver to cache revision information
1849        derived from the Git repository. The exact meaning depends on the
1850        used database driver, for SQLite (which is the default driver) this
1851        is a filename. Supports variable substitution (see
1852        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1853        Default: '%Ggitcvs.%m.sqlite'
1854
1855gitcvs.dbDriver::
1856        Used Perl DBI driver. You can specify any available driver
1857        for this here, but it might not work. git-cvsserver is tested
1858        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1859        reported *not* to work with 'DBD::mysql'. Experimental feature.
1860        May not contain double colons (`:`). Default: 'SQLite'.
1861        See linkgit:git-cvsserver[1].
1862
1863gitcvs.dbUser, gitcvs.dbPass::
1864        Database user and password. Only useful if setting `gitcvs.dbDriver`,
1865        since SQLite has no concept of database users and/or passwords.
1866        'gitcvs.dbUser' supports variable substitution (see
1867        linkgit:git-cvsserver[1] for details).
1868
1869gitcvs.dbTableNamePrefix::
1870        Database table name prefix.  Prepended to the names of any
1871        database tables used, allowing a single database to be used
1872        for several repositories.  Supports variable substitution (see
1873        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1874        characters will be replaced with underscores.
1875
1876All gitcvs variables except for `gitcvs.usecrlfattr` and
1877`gitcvs.allBinary` can also be specified as
1878'gitcvs.<access_method>.<varname>' (where 'access_method'
1879is one of "ext" and "pserver") to make them apply only for the given
1880access method.
1881
1882gitweb.category::
1883gitweb.description::
1884gitweb.owner::
1885gitweb.url::
1886        See linkgit:gitweb[1] for description.
1887
1888gitweb.avatar::
1889gitweb.blame::
1890gitweb.grep::
1891gitweb.highlight::
1892gitweb.patches::
1893gitweb.pickaxe::
1894gitweb.remote_heads::
1895gitweb.showSizes::
1896gitweb.snapshot::
1897        See linkgit:gitweb.conf[5] for description.
1898
1899grep.lineNumber::
1900        If set to true, enable `-n` option by default.
1901
1902grep.column::
1903        If set to true, enable the `--column` option by default.
1904
1905grep.patternType::
1906        Set the default matching behavior. Using a value of 'basic', 'extended',
1907        'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1908        `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1909        value 'default' will return to the default matching behavior.
1910
1911grep.extendedRegexp::
1912        If set to true, enable `--extended-regexp` option by default. This
1913        option is ignored when the `grep.patternType` option is set to a value
1914        other than 'default'.
1915
1916grep.threads::
1917        Number of grep worker threads to use.
1918        See `grep.threads` in linkgit:git-grep[1] for more information.
1919
1920grep.fallbackToNoIndex::
1921        If set to true, fall back to git grep --no-index if git grep
1922        is executed outside of a git repository.  Defaults to false.
1923
1924gpg.program::
1925        Use this custom program instead of "`gpg`" found on `$PATH` when
1926        making or verifying a PGP signature. The program must support the
1927        same command-line interface as GPG, namely, to verify a detached
1928        signature, "`gpg --verify $file - <$signature`" is run, and the
1929        program is expected to signal a good signature by exiting with
1930        code 0, and to generate an ASCII-armored detached signature, the
1931        standard input of "`gpg -bsau $key`" is fed with the contents to be
1932        signed, and the program is expected to send the result to its
1933        standard output.
1934
1935gpg.format::
1936        Specifies which key format to use when signing with `--gpg-sign`.
1937        Default is "openpgp" and another possible value is "x509".
1938
1939gpg.<format>.program::
1940        Use this to customize the program used for the signing format you
1941        chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1942        be used as a legacy synonym for `gpg.openpgp.program`. The default
1943        value for `gpg.x509.program` is "gpgsm".
1944
1945gui.commitMsgWidth::
1946        Defines how wide the commit message window is in the
1947        linkgit:git-gui[1]. "75" is the default.
1948
1949gui.diffContext::
1950        Specifies how many context lines should be used in calls to diff
1951        made by the linkgit:git-gui[1]. The default is "5".
1952
1953gui.displayUntracked::
1954        Determines if linkgit:git-gui[1] shows untracked files
1955        in the file list. The default is "true".
1956
1957gui.encoding::
1958        Specifies the default encoding to use for displaying of
1959        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1960        It can be overridden by setting the 'encoding' attribute
1961        for relevant files (see linkgit:gitattributes[5]).
1962        If this option is not set, the tools default to the
1963        locale encoding.
1964
1965gui.matchTrackingBranch::
1966        Determines if new branches created with linkgit:git-gui[1] should
1967        default to tracking remote branches with matching names or
1968        not. Default: "false".
1969
1970gui.newBranchTemplate::
1971        Is used as suggested name when creating new branches using the
1972        linkgit:git-gui[1].
1973
1974gui.pruneDuringFetch::
1975        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1976        performing a fetch. The default value is "false".
1977
1978gui.trustmtime::
1979        Determines if linkgit:git-gui[1] should trust the file modification
1980        timestamp or not. By default the timestamps are not trusted.
1981
1982gui.spellingDictionary::
1983        Specifies the dictionary used for spell checking commit messages in
1984        the linkgit:git-gui[1]. When set to "none" spell checking is turned
1985        off.
1986
1987gui.fastCopyBlame::
1988        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
1989        location detection. It makes blame significantly faster on huge
1990        repositories at the expense of less thorough copy detection.
1991
1992gui.copyBlameThreshold::
1993        Specifies the threshold to use in 'git gui blame' original location
1994        detection, measured in alphanumeric characters. See the
1995        linkgit:git-blame[1] manual for more information on copy detection.
1996
1997gui.blamehistoryctx::
1998        Specifies the radius of history context in days to show in
1999        linkgit:gitk[1] for the selected commit, when the `Show History
2000        Context` menu item is invoked from 'git gui blame'. If this
2001        variable is set to zero, the whole history is shown.
2002
2003guitool.<name>.cmd::
2004        Specifies the shell command line to execute when the corresponding item
2005        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
2006        mandatory for every tool. The command is executed from the root of
2007        the working directory, and in the environment it receives the name of
2008        the tool as `GIT_GUITOOL`, the name of the currently selected file as
2009        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
2010        the head is detached, 'CUR_BRANCH' is empty).
2011
2012guitool.<name>.needsFile::
2013        Run the tool only if a diff is selected in the GUI. It guarantees
2014        that 'FILENAME' is not empty.
2015
2016guitool.<name>.noConsole::
2017        Run the command silently, without creating a window to display its
2018        output.
2019
2020guitool.<name>.noRescan::
2021        Don't rescan the working directory for changes after the tool
2022        finishes execution.
2023
2024guitool.<name>.confirm::
2025        Show a confirmation dialog before actually running the tool.
2026
2027guitool.<name>.argPrompt::
2028        Request a string argument from the user, and pass it to the tool
2029        through the `ARGS` environment variable. Since requesting an
2030        argument implies confirmation, the 'confirm' option has no effect
2031        if this is enabled. If the option is set to 'true', 'yes', or '1',
2032        the dialog uses a built-in generic prompt; otherwise the exact
2033        value of the variable is used.
2034
2035guitool.<name>.revPrompt::
2036        Request a single valid revision from the user, and set the
2037        `REVISION` environment variable. In other aspects this option
2038        is similar to 'argPrompt', and can be used together with it.
2039
2040guitool.<name>.revUnmerged::
2041        Show only unmerged branches in the 'revPrompt' subdialog.
2042        This is useful for tools similar to merge or rebase, but not
2043        for things like checkout or reset.
2044
2045guitool.<name>.title::
2046        Specifies the title to use for the prompt dialog. The default
2047        is the tool name.
2048
2049guitool.<name>.prompt::
2050        Specifies the general prompt string to display at the top of
2051        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
2052        The default value includes the actual command.
2053
2054help.browser::
2055        Specify the browser that will be used to display help in the
2056        'web' format. See linkgit:git-help[1].
2057
2058help.format::
2059        Override the default help format used by linkgit:git-help[1].
2060        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2061        the default. 'web' and 'html' are the same.
2062
2063help.autoCorrect::
2064        Automatically correct and execute mistyped commands after
2065        waiting for the given number of deciseconds (0.1 sec). If more
2066        than one command can be deduced from the entered text, nothing
2067        will be executed.  If the value of this option is negative,
2068        the corrected command will be executed immediately. If the
2069        value is 0 - the command will be just shown but not executed.
2070        This is the default.
2071
2072help.htmlPath::
2073        Specify the path where the HTML documentation resides. File system paths
2074        and URLs are supported. HTML pages will be prefixed with this path when
2075        help is displayed in the 'web' format. This defaults to the documentation
2076        path of your Git installation.
2077
2078http.proxy::
2079        Override the HTTP proxy, normally configured using the 'http_proxy',
2080        'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2081        addition to the syntax understood by curl, it is possible to specify a
2082        proxy string with a user name but no password, in which case git will
2083        attempt to acquire one in the same way it does for other credentials. See
2084        linkgit:gitcredentials[7] for more information. The syntax thus is
2085        '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2086        on a per-remote basis; see remote.<name>.proxy
2087
2088http.proxyAuthMethod::
2089        Set the method with which to authenticate against the HTTP proxy. This
2090        only takes effect if the configured proxy string contains a user name part
2091        (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2092        overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
2093        Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
2094        variable.  Possible values are:
2095+
2096--
2097* `anyauth` - Automatically pick a suitable authentication method. It is
2098  assumed that the proxy answers an unauthenticated request with a 407
2099  status code and one or more Proxy-authenticate headers with supported
2100  authentication methods. This is the default.
2101* `basic` - HTTP Basic authentication
2102* `digest` - HTTP Digest authentication; this prevents the password from being
2103  transmitted to the proxy in clear text
2104* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2105  of `curl(1)`)
2106* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2107--
2108
2109http.emptyAuth::
2110        Attempt authentication without seeking a username or password.  This
2111        can be used to attempt GSS-Negotiate authentication without specifying
2112        a username in the URL, as libcurl normally requires a username for
2113        authentication.
2114
2115http.delegation::
2116        Control GSSAPI credential delegation. The delegation is disabled
2117        by default in libcurl since version 7.21.7. Set parameter to tell
2118        the server what it is allowed to delegate when it comes to user
2119        credentials. Used with GSS/kerberos. Possible values are:
2120+
2121--
2122* `none` - Don't allow any delegation.
2123* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2124  Kerberos service ticket, which is a matter of realm policy.
2125* `always` - Unconditionally allow the server to delegate.
2126--
2127
2128
2129http.extraHeader::
2130        Pass an additional HTTP header when communicating with a server.  If
2131        more than one such entry exists, all of them are added as extra
2132        headers.  To allow overriding the settings inherited from the system
2133        config, an empty value will reset the extra headers to the empty list.
2134
2135http.cookieFile::
2136        The pathname of a file containing previously stored cookie lines,
2137        which should be used
2138        in the Git http session, if they match the server. The file format
2139        of the file to read cookies from should be plain HTTP headers or
2140        the Netscape/Mozilla cookie file format (see `curl(1)`).
2141        NOTE that the file specified with http.cookieFile is used only as
2142        input unless http.saveCookies is set.
2143
2144http.saveCookies::
2145        If set, store cookies received during requests to the file specified by
2146        http.cookieFile. Has no effect if http.cookieFile is unset.
2147
2148http.sslVersion::
2149        The SSL version to use when negotiating an SSL connection, if you
2150        want to force the default.  The available and default version
2151        depend on whether libcurl was built against NSS or OpenSSL and the
2152        particular configuration of the crypto library in use. Internally
2153        this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2154        documentation for more details on the format of this option and
2155        for the ssl version supported. Actually the possible values of
2156        this option are:
2157
2158        - sslv2
2159        - sslv3
2160        - tlsv1
2161        - tlsv1.0
2162        - tlsv1.1
2163        - tlsv1.2
2164        - tlsv1.3
2165
2166+
2167Can be overridden by the `GIT_SSL_VERSION` environment variable.
2168To force git to use libcurl's default ssl version and ignore any
2169explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2170empty string.
2171
2172http.sslCipherList::
2173  A list of SSL ciphers to use when negotiating an SSL connection.
2174  The available ciphers depend on whether libcurl was built against
2175  NSS or OpenSSL and the particular configuration of the crypto
2176  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2177  option; see the libcurl documentation for more details on the format
2178  of this list.
2179+
2180Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2181To force git to use libcurl's default cipher list and ignore any
2182explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2183empty string.
2184
2185http.sslVerify::
2186        Whether to verify the SSL certificate when fetching or pushing
2187        over HTTPS. Defaults to true. Can be overridden by the
2188        `GIT_SSL_NO_VERIFY` environment variable.
2189
2190http.sslCert::
2191        File containing the SSL certificate when fetching or pushing
2192        over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2193        variable.
2194
2195http.sslKey::
2196        File containing the SSL private key when fetching or pushing
2197        over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2198        variable.
2199
2200http.sslCertPasswordProtected::
2201        Enable Git's password prompt for the SSL certificate.  Otherwise
2202        OpenSSL will prompt the user, possibly many times, if the
2203        certificate or private key is encrypted.  Can be overridden by the
2204        `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2205
2206http.sslCAInfo::
2207        File containing the certificates to verify the peer with when
2208        fetching or pushing over HTTPS. Can be overridden by the
2209        `GIT_SSL_CAINFO` environment variable.
2210
2211http.sslCAPath::
2212        Path containing files with the CA certificates to verify the peer
2213        with when fetching or pushing over HTTPS. Can be overridden
2214        by the `GIT_SSL_CAPATH` environment variable.
2215
2216http.pinnedpubkey::
2217        Public key of the https service. It may either be the filename of
2218        a PEM or DER encoded public key file or a string starting with
2219        'sha256//' followed by the base64 encoded sha256 hash of the
2220        public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2221        exit with an error if this option is set but not supported by
2222        cURL.
2223
2224http.sslTry::
2225        Attempt to use AUTH SSL/TLS and encrypted data transfers
2226        when connecting via regular FTP protocol. This might be needed
2227        if the FTP server requires it for security reasons or you wish
2228        to connect securely whenever remote FTP server supports it.
2229        Default is false since it might trigger certificate verification
2230        errors on misconfigured servers.
2231
2232http.maxRequests::
2233        How many HTTP requests to launch in parallel. Can be overridden
2234        by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2235
2236http.minSessions::
2237        The number of curl sessions (counted across slots) to be kept across
2238        requests. They will not be ended with curl_easy_cleanup() until
2239        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2240        value will be capped at 1. Defaults to 1.
2241
2242http.postBuffer::
2243        Maximum size in bytes of the buffer used by smart HTTP
2244        transports when POSTing data to the remote system.
2245        For requests larger than this buffer size, HTTP/1.1 and
2246        Transfer-Encoding: chunked is used to avoid creating a
2247        massive pack file locally.  Default is 1 MiB, which is
2248        sufficient for most requests.
2249
2250http.lowSpeedLimit, http.lowSpeedTime::
2251        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2252        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2253        Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2254        `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2255
2256http.noEPSV::
2257        A boolean which disables using of EPSV ftp command by curl.
2258        This can helpful with some "poor" ftp servers which don't
2259        support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2260        environment variable. Default is false (curl will use EPSV).
2261
2262http.userAgent::
2263        The HTTP USER_AGENT string presented to an HTTP server.  The default
2264        value represents the version of the client Git such as git/1.7.1.
2265        This option allows you to override this value to a more common value
2266        such as Mozilla/4.0.  This may be necessary, for instance, if
2267        connecting through a firewall that restricts HTTP connections to a set
2268        of common USER_AGENT strings (but not including those like git/1.7.1).
2269        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2270
2271http.followRedirects::
2272        Whether git should follow HTTP redirects. If set to `true`, git
2273        will transparently follow any redirect issued by a server it
2274        encounters. If set to `false`, git will treat all redirects as
2275        errors. If set to `initial`, git will follow redirects only for
2276        the initial request to a remote, but not for subsequent
2277        follow-up HTTP requests. Since git uses the redirected URL as
2278        the base for the follow-up requests, this is generally
2279        sufficient. The default is `initial`.
2280
2281http.<url>.*::
2282        Any of the http.* options above can be applied selectively to some URLs.
2283        For a config key to match a URL, each element of the config key is
2284        compared to that of the URL, in the following order:
2285+
2286--
2287. Scheme (e.g., `https` in `https://example.com/`). This field
2288  must match exactly between the config key and the URL.
2289
2290. Host/domain name (e.g., `example.com` in `https://example.com/`).
2291  This field must match between the config key and the URL. It is
2292  possible to specify a `*` as part of the host name to match all subdomains
2293  at this level. `https://*.example.com/` for example would match
2294  `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2295
2296. Port number (e.g., `8080` in `http://example.com:8080/`).
2297  This field must match exactly between the config key and the URL.
2298  Omitted port numbers are automatically converted to the correct
2299  default for the scheme before matching.
2300
2301. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2302  path field of the config key must match the path field of the URL
2303  either exactly or as a prefix of slash-delimited path elements.  This means
2304  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
2305  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
2306  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2307  key with just path `foo/`).
2308
2309. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2310  the config key has a user name it must match the user name in the
2311  URL exactly. If the config key does not have a user name, that
2312  config key will match a URL with any user name (including none),
2313  but at a lower precedence than a config key with a user name.
2314--
2315+
2316The list above is ordered by decreasing precedence; a URL that matches
2317a config key's path is preferred to one that matches its user name. For example,
2318if the URL is `https://user@example.com/foo/bar` a config key match of
2319`https://example.com/foo` will be preferred over a config key match of
2320`https://user@example.com`.
2321+
2322All URLs are normalized before attempting any matching (the password part,
2323if embedded in the URL, is always ignored for matching purposes) so that
2324equivalent URLs that are simply spelled differently will match properly.
2325Environment variable settings always override any matches.  The URLs that are
2326matched against are those given directly to Git commands.  This means any URLs
2327visited as a result of a redirection do not participate in matching.
2328
2329ssh.variant::
2330        By default, Git determines the command line arguments to use
2331        based on the basename of the configured SSH command (configured
2332        using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2333        the config setting `core.sshCommand`). If the basename is
2334        unrecognized, Git will attempt to detect support of OpenSSH
2335        options by first invoking the configured SSH command with the
2336        `-G` (print configuration) option and will subsequently use
2337        OpenSSH options (if that is successful) or no options besides
2338        the host and remote command (if it fails).
2339+
2340The config variable `ssh.variant` can be set to override this detection.
2341Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2342`tortoiseplink`, `simple` (no options except the host and remote command).
2343The default auto-detection can be explicitly requested using the value
2344`auto`.  Any other value is treated as `ssh`.  This setting can also be
2345overridden via the environment variable `GIT_SSH_VARIANT`.
2346+
2347The current command-line parameters used for each variant are as
2348follows:
2349+
2350--
2351
2352* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2353
2354* `simple` - [username@]host command
2355
2356* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2357
2358* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2359
2360--
2361+
2362Except for the `simple` variant, command-line parameters are likely to
2363change as git gains new features.
2364
2365i18n.commitEncoding::
2366        Character encoding the commit messages are stored in; Git itself
2367        does not care per se, but this information is necessary e.g. when
2368        importing commits from emails or in the gitk graphical history
2369        browser (and possibly at other places in the future or in other
2370        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2371
2372i18n.logOutputEncoding::
2373        Character encoding the commit messages are converted to when
2374        running 'git log' and friends.
2375
2376imap::
2377        The configuration variables in the 'imap' section are described
2378        in linkgit:git-imap-send[1].
2379
2380index.version::
2381        Specify the version with which new index files should be
2382        initialized.  This does not affect existing repositories.
2383
2384init.templateDir::
2385        Specify the directory from which templates will be copied.
2386        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2387
2388instaweb.browser::
2389        Specify the program that will be used to browse your working
2390        repository in gitweb. See linkgit:git-instaweb[1].
2391
2392instaweb.httpd::
2393        The HTTP daemon command-line to start gitweb on your working
2394        repository. See linkgit:git-instaweb[1].
2395
2396instaweb.local::
2397        If true the web server started by linkgit:git-instaweb[1] will
2398        be bound to the local IP (127.0.0.1).
2399
2400instaweb.modulePath::
2401        The default module path for linkgit:git-instaweb[1] to use
2402        instead of /usr/lib/apache2/modules.  Only used if httpd
2403        is Apache.
2404
2405instaweb.port::
2406        The port number to bind the gitweb httpd to. See
2407        linkgit:git-instaweb[1].
2408
2409interactive.singleKey::
2410        In interactive commands, allow the user to provide one-letter
2411        input with a single key (i.e., without hitting enter).
2412        Currently this is used by the `--patch` mode of
2413        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2414        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2415        setting is silently ignored if portable keystroke input
2416        is not available; requires the Perl module Term::ReadKey.
2417
2418interactive.diffFilter::
2419        When an interactive command (such as `git add --patch`) shows
2420        a colorized diff, git will pipe the diff through the shell
2421        command defined by this configuration variable. The command may
2422        mark up the diff further for human consumption, provided that it
2423        retains a one-to-one correspondence with the lines in the
2424        original diff. Defaults to disabled (no filtering).
2425
2426log.abbrevCommit::
2427        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2428        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2429        override this option with `--no-abbrev-commit`.
2430
2431log.date::
2432        Set the default date-time mode for the 'log' command.
2433        Setting a value for log.date is similar to using 'git log''s
2434        `--date` option.  See linkgit:git-log[1] for details.
2435
2436log.decorate::
2437        Print out the ref names of any commits that are shown by the log
2438        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2439        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2440        specified, the full ref name (including prefix) will be printed.
2441        If 'auto' is specified, then if the output is going to a terminal,
2442        the ref names are shown as if 'short' were given, otherwise no ref
2443        names are shown. This is the same as the `--decorate` option
2444        of the `git log`.
2445
2446log.follow::
2447        If `true`, `git log` will act as if the `--follow` option was used when
2448        a single <path> is given.  This has the same limitations as `--follow`,
2449        i.e. it cannot be used to follow multiple files and does not work well
2450        on non-linear history.
2451
2452log.graphColors::
2453        A list of colors, separated by commas, that can be used to draw
2454        history lines in `git log --graph`.
2455
2456log.showRoot::
2457        If true, the initial commit will be shown as a big creation event.
2458        This is equivalent to a diff against an empty tree.
2459        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2460        normally hide the root commit will now show it. True by default.
2461
2462log.showSignature::
2463        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2464        linkgit:git-whatchanged[1] assume `--show-signature`.
2465
2466log.mailmap::
2467        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2468        linkgit:git-whatchanged[1] assume `--use-mailmap`.
2469
2470mailinfo.scissors::
2471        If true, makes linkgit:git-mailinfo[1] (and therefore
2472        linkgit:git-am[1]) act by default as if the --scissors option
2473        was provided on the command-line. When active, this features
2474        removes everything from the message body before a scissors
2475        line (i.e. consisting mainly of ">8", "8<" and "-").
2476
2477mailmap.file::
2478        The location of an augmenting mailmap file. The default
2479        mailmap, located in the root of the repository, is loaded
2480        first, then the mailmap file pointed to by this variable.
2481        The location of the mailmap file may be in a repository
2482        subdirectory, or somewhere outside of the repository itself.
2483        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2484
2485mailmap.blob::
2486        Like `mailmap.file`, but consider the value as a reference to a
2487        blob in the repository. If both `mailmap.file` and
2488        `mailmap.blob` are given, both are parsed, with entries from
2489        `mailmap.file` taking precedence. In a bare repository, this
2490        defaults to `HEAD:.mailmap`. In a non-bare repository, it
2491        defaults to empty.
2492
2493man.viewer::
2494        Specify the programs that may be used to display help in the
2495        'man' format. See linkgit:git-help[1].
2496
2497man.<tool>.cmd::
2498        Specify the command to invoke the specified man viewer. The
2499        specified command is evaluated in shell with the man page
2500        passed as argument. (See linkgit:git-help[1].)
2501
2502man.<tool>.path::
2503        Override the path for the given tool that may be used to
2504        display help in the 'man' format. See linkgit:git-help[1].
2505
2506include::merge-config.txt[]
2507
2508mergetool.<tool>.path::
2509        Override the path for the given tool.  This is useful in case
2510        your tool is not in the PATH.
2511
2512mergetool.<tool>.cmd::
2513        Specify the command to invoke the specified merge tool.  The
2514        specified command is evaluated in shell with the following
2515        variables available: 'BASE' is the name of a temporary file
2516        containing the common base of the files to be merged, if available;
2517        'LOCAL' is the name of a temporary file containing the contents of
2518        the file on the current branch; 'REMOTE' is the name of a temporary
2519        file containing the contents of the file from the branch being
2520        merged; 'MERGED' contains the name of the file to which the merge
2521        tool should write the results of a successful merge.
2522
2523mergetool.<tool>.trustExitCode::
2524        For a custom merge command, specify whether the exit code of
2525        the merge command can be used to determine whether the merge was
2526        successful.  If this is not set to true then the merge target file
2527        timestamp is checked and the merge assumed to have been successful
2528        if the file has been updated, otherwise the user is prompted to
2529        indicate the success of the merge.
2530
2531mergetool.meld.hasOutput::
2532        Older versions of `meld` do not support the `--output` option.
2533        Git will attempt to detect whether `meld` supports `--output`
2534        by inspecting the output of `meld --help`.  Configuring
2535        `mergetool.meld.hasOutput` will make Git skip these checks and
2536        use the configured value instead.  Setting `mergetool.meld.hasOutput`
2537        to `true` tells Git to unconditionally use the `--output` option,
2538        and `false` avoids using `--output`.
2539
2540mergetool.keepBackup::
2541        After performing a merge, the original file with conflict markers
2542        can be saved as a file with a `.orig` extension.  If this variable
2543        is set to `false` then this file is not preserved.  Defaults to
2544        `true` (i.e. keep the backup files).
2545
2546mergetool.keepTemporaries::
2547        When invoking a custom merge tool, Git uses a set of temporary
2548        files to pass to the tool. If the tool returns an error and this
2549        variable is set to `true`, then these temporary files will be
2550        preserved, otherwise they will be removed after the tool has
2551        exited. Defaults to `false`.
2552
2553mergetool.writeToTemp::
2554        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2555        conflicting files in the worktree by default.  Git will attempt
2556        to use a temporary directory for these files when set `true`.
2557        Defaults to `false`.
2558
2559mergetool.prompt::
2560        Prompt before each invocation of the merge resolution program.
2561
2562notes.mergeStrategy::
2563        Which merge strategy to choose by default when resolving notes
2564        conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2565        `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2566        section of linkgit:git-notes[1] for more information on each strategy.
2567
2568notes.<name>.mergeStrategy::
2569        Which merge strategy to choose when doing a notes merge into
2570        refs/notes/<name>.  This overrides the more general
2571        "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2572        linkgit:git-notes[1] for more information on the available strategies.
2573
2574notes.displayRef::
2575        The (fully qualified) refname from which to show notes when
2576        showing commit messages.  The value of this variable can be set
2577        to a glob, in which case notes from all matching refs will be
2578        shown.  You may also specify this configuration variable
2579        several times.  A warning will be issued for refs that do not
2580        exist, but a glob that does not match any refs is silently
2581        ignored.
2582+
2583This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2584environment variable, which must be a colon separated list of refs or
2585globs.
2586+
2587The effective value of "core.notesRef" (possibly overridden by
2588GIT_NOTES_REF) is also implicitly added to the list of refs to be
2589displayed.
2590
2591notes.rewrite.<command>::
2592        When rewriting commits with <command> (currently `amend` or
2593        `rebase`) and this variable is set to `true`, Git
2594        automatically copies your notes from the original to the
2595        rewritten commit.  Defaults to `true`, but see
2596        "notes.rewriteRef" below.
2597
2598notes.rewriteMode::
2599        When copying notes during a rewrite (see the
2600        "notes.rewrite.<command>" option), determines what to do if
2601        the target commit already has a note.  Must be one of
2602        `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2603        Defaults to `concatenate`.
2604+
2605This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2606environment variable.
2607
2608notes.rewriteRef::
2609        When copying notes during a rewrite, specifies the (fully
2610        qualified) ref whose notes should be copied.  The ref may be a
2611        glob, in which case notes in all matching refs will be copied.
2612        You may also specify this configuration several times.
2613+
2614Does not have a default value; you must configure this variable to
2615enable note rewriting.  Set it to `refs/notes/commits` to enable
2616rewriting for the default commit notes.
2617+
2618This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2619environment variable, which must be a colon separated list of refs or
2620globs.
2621
2622pack.window::
2623        The size of the window used by linkgit:git-pack-objects[1] when no
2624        window size is given on the command line. Defaults to 10.
2625
2626pack.depth::
2627        The maximum delta depth used by linkgit:git-pack-objects[1] when no
2628        maximum depth is given on the command line. Defaults to 50.
2629        Maximum value is 4095.
2630
2631pack.windowMemory::
2632        The maximum size of memory that is consumed by each thread
2633        in linkgit:git-pack-objects[1] for pack window memory when
2634        no limit is given on the command line.  The value can be
2635        suffixed with "k", "m", or "g".  When left unconfigured (or
2636        set explicitly to 0), there will be no limit.
2637
2638pack.compression::
2639        An integer -1..9, indicating the compression level for objects
2640        in a pack file. -1 is the zlib default. 0 means no
2641        compression, and 1..9 are various speed/size tradeoffs, 9 being
2642        slowest.  If not set,  defaults to core.compression.  If that is
2643        not set,  defaults to -1, the zlib default, which is "a default
2644        compromise between speed and compression (currently equivalent
2645        to level 6)."
2646+
2647Note that changing the compression level will not automatically recompress
2648all existing objects. You can force recompression by passing the -F option
2649to linkgit:git-repack[1].
2650
2651pack.deltaCacheSize::
2652        The maximum memory in bytes used for caching deltas in
2653        linkgit:git-pack-objects[1] before writing them out to a pack.
2654        This cache is used to speed up the writing object phase by not
2655        having to recompute the final delta result once the best match
2656        for all objects is found.  Repacking large repositories on machines
2657        which are tight with memory might be badly impacted by this though,
2658        especially if this cache pushes the system into swapping.
2659        A value of 0 means no limit. The smallest size of 1 byte may be
2660        used to virtually disable this cache. Defaults to 256 MiB.
2661
2662pack.deltaCacheLimit::
2663        The maximum size of a delta, that is cached in
2664        linkgit:git-pack-objects[1]. This cache is used to speed up the
2665        writing object phase by not having to recompute the final delta
2666        result once the best match for all objects is found.
2667        Defaults to 1000. Maximum value is 65535.
2668
2669pack.threads::
2670        Specifies the number of threads to spawn when searching for best
2671        delta matches.  This requires that linkgit:git-pack-objects[1]
2672        be compiled with pthreads otherwise this option is ignored with a
2673        warning. This is meant to reduce packing time on multiprocessor
2674        machines. The required amount of memory for the delta search window
2675        is however multiplied by the number of threads.
2676        Specifying 0 will cause Git to auto-detect the number of CPU's
2677        and set the number of threads accordingly.
2678
2679pack.indexVersion::
2680        Specify the default pack index version.  Valid values are 1 for
2681        legacy pack index used by Git versions prior to 1.5.2, and 2 for
2682        the new pack index with capabilities for packs larger than 4 GB
2683        as well as proper protection against the repacking of corrupted
2684        packs.  Version 2 is the default.  Note that version 2 is enforced
2685        and this config option ignored whenever the corresponding pack is
2686        larger than 2 GB.
2687+
2688If you have an old Git that does not understand the version 2 `*.idx` file,
2689cloning or fetching over a non native protocol (e.g. "http")
2690that will copy both `*.pack` file and corresponding `*.idx` file from the
2691other side may give you a repository that cannot be accessed with your
2692older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2693you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2694the `*.idx` file.
2695
2696pack.packSizeLimit::
2697        The maximum size of a pack.  This setting only affects
2698        packing to a file when repacking, i.e. the git:// protocol
2699        is unaffected.  It can be overridden by the `--max-pack-size`
2700        option of linkgit:git-repack[1].  Reaching this limit results
2701        in the creation of multiple packfiles; which in turn prevents
2702        bitmaps from being created.
2703        The minimum size allowed is limited to 1 MiB.
2704        The default is unlimited.
2705        Common unit suffixes of 'k', 'm', or 'g' are
2706        supported.
2707
2708pack.useBitmaps::
2709        When true, git will use pack bitmaps (if available) when packing
2710        to stdout (e.g., during the server side of a fetch). Defaults to
2711        true. You should not generally need to turn this off unless
2712        you are debugging pack bitmaps.
2713
2714pack.writeBitmaps (deprecated)::
2715        This is a deprecated synonym for `repack.writeBitmaps`.
2716
2717pack.writeBitmapHashCache::
2718        When true, git will include a "hash cache" section in the bitmap
2719        index (if one is written). This cache can be used to feed git's
2720        delta heuristics, potentially leading to better deltas between
2721        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2722        between an older, bitmapped pack and objects that have been
2723        pushed since the last gc). The downside is that it consumes 4
2724        bytes per object of disk space, and that JGit's bitmap
2725        implementation does not understand it, causing it to complain if
2726        Git and JGit are used on the same repository. Defaults to false.
2727
2728pager.<cmd>::
2729        If the value is boolean, turns on or off pagination of the
2730        output of a particular Git subcommand when writing to a tty.
2731        Otherwise, turns on pagination for the subcommand using the
2732        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2733        or `--no-pager` is specified on the command line, it takes
2734        precedence over this option.  To disable pagination for all
2735        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2736
2737pretty.<name>::
2738        Alias for a --pretty= format string, as specified in
2739        linkgit:git-log[1]. Any aliases defined here can be used just
2740        as the built-in pretty formats could. For example,
2741        running `git config pretty.changelog "format:* %H %s"`
2742        would cause the invocation `git log --pretty=changelog`
2743        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2744        Note that an alias with the same name as a built-in format
2745        will be silently ignored.
2746
2747protocol.allow::
2748        If set, provide a user defined default policy for all protocols which
2749        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
2750        if unset, known-safe protocols (http, https, git, ssh, file) have a
2751        default policy of `always`, known-dangerous protocols (ext) have a
2752        default policy of `never`, and all other protocols have a default
2753        policy of `user`.  Supported policies:
2754+
2755--
2756
2757* `always` - protocol is always able to be used.
2758
2759* `never` - protocol is never able to be used.
2760
2761* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2762  either unset or has a value of 1.  This policy should be used when you want a
2763  protocol to be directly usable by the user but don't want it used by commands which
2764  execute clone/fetch/push commands without user input, e.g. recursive
2765  submodule initialization.
2766
2767--
2768
2769protocol.<name>.allow::
2770        Set a policy to be used by protocol `<name>` with clone/fetch/push
2771        commands. See `protocol.allow` above for the available policies.
2772+
2773The protocol names currently used by git are:
2774+
2775--
2776  - `file`: any local file-based path (including `file://` URLs,
2777    or local paths)
2778
2779  - `git`: the anonymous git protocol over a direct TCP
2780    connection (or proxy, if configured)
2781
2782  - `ssh`: git over ssh (including `host:path` syntax,
2783    `ssh://`, etc).
2784
2785  - `http`: git over http, both "smart http" and "dumb http".
2786    Note that this does _not_ include `https`; if you want to configure
2787    both, you must do so individually.
2788
2789  - any external helpers are named by their protocol (e.g., use
2790    `hg` to allow the `git-remote-hg` helper)
2791--
2792
2793protocol.version::
2794        Experimental. If set, clients will attempt to communicate with a
2795        server using the specified protocol version.  If unset, no
2796        attempt will be made by the client to communicate using a
2797        particular protocol version, this results in protocol version 0
2798        being used.
2799        Supported versions:
2800+
2801--
2802
2803* `0` - the original wire protocol.
2804
2805* `1` - the original wire protocol with the addition of a version string
2806  in the initial response from the server.
2807
2808--
2809
2810pull.ff::
2811        By default, Git does not create an extra merge commit when merging
2812        a commit that is a descendant of the current commit. Instead, the
2813        tip of the current branch is fast-forwarded. When set to `false`,
2814        this variable tells Git to create an extra merge commit in such
2815        a case (equivalent to giving the `--no-ff` option from the command
2816        line). When set to `only`, only such fast-forward merges are
2817        allowed (equivalent to giving the `--ff-only` option from the
2818        command line). This setting overrides `merge.ff` when pulling.
2819
2820pull.rebase::
2821        When true, rebase branches on top of the fetched branch, instead
2822        of merging the default branch from the default remote when "git
2823        pull" is run. See "branch.<name>.rebase" for setting this on a
2824        per-branch basis.
2825+
2826When `merges`, pass the `--rebase-merges` option to 'git rebase'
2827so that the local merge commits are included in the rebase (see
2828linkgit:git-rebase[1] for details).
2829+
2830When preserve, also pass `--preserve-merges` along to 'git rebase'
2831so that locally committed merge commits will not be flattened
2832by running 'git pull'.
2833+
2834When the value is `interactive`, the rebase is run in interactive mode.
2835+
2836*NOTE*: this is a possibly dangerous operation; do *not* use
2837it unless you understand the implications (see linkgit:git-rebase[1]
2838for details).
2839
2840pull.octopus::
2841        The default merge strategy to use when pulling multiple branches
2842        at once.
2843
2844pull.twohead::
2845        The default merge strategy to use when pulling a single branch.
2846
2847push.default::
2848        Defines the action `git push` should take if no refspec is
2849        explicitly given.  Different values are well-suited for
2850        specific workflows; for instance, in a purely central workflow
2851        (i.e. the fetch source is equal to the push destination),
2852        `upstream` is probably what you want.  Possible values are:
2853+
2854--
2855
2856* `nothing` - do not push anything (error out) unless a refspec is
2857  explicitly given. This is primarily meant for people who want to
2858  avoid mistakes by always being explicit.
2859
2860* `current` - push the current branch to update a branch with the same
2861  name on the receiving end.  Works in both central and non-central
2862  workflows.
2863
2864* `upstream` - push the current branch back to the branch whose
2865  changes are usually integrated into the current branch (which is
2866  called `@{upstream}`).  This mode only makes sense if you are
2867  pushing to the same repository you would normally pull from
2868  (i.e. central workflow).
2869
2870* `tracking` - This is a deprecated synonym for `upstream`.
2871
2872* `simple` - in centralized workflow, work like `upstream` with an
2873  added safety to refuse to push if the upstream branch's name is
2874  different from the local one.
2875+
2876When pushing to a remote that is different from the remote you normally
2877pull from, work as `current`.  This is the safest option and is suited
2878for beginners.
2879+
2880This mode has become the default in Git 2.0.
2881
2882* `matching` - push all branches having the same name on both ends.
2883  This makes the repository you are pushing to remember the set of
2884  branches that will be pushed out (e.g. if you always push 'maint'
2885  and 'master' there and no other branches, the repository you push
2886  to will have these two branches, and your local 'maint' and
2887  'master' will be pushed there).
2888+
2889To use this mode effectively, you have to make sure _all_ the
2890branches you would push out are ready to be pushed out before
2891running 'git push', as the whole point of this mode is to allow you
2892to push all of the branches in one go.  If you usually finish work
2893on only one branch and push out the result, while other branches are
2894unfinished, this mode is not for you.  Also this mode is not
2895suitable for pushing into a shared central repository, as other
2896people may add new branches there, or update the tip of existing
2897branches outside your control.
2898+
2899This used to be the default, but not since Git 2.0 (`simple` is the
2900new default).
2901
2902--
2903
2904push.followTags::
2905        If set to true enable `--follow-tags` option by default.  You
2906        may override this configuration at time of push by specifying
2907        `--no-follow-tags`.
2908
2909push.gpgSign::
2910        May be set to a boolean value, or the string 'if-asked'. A true
2911        value causes all pushes to be GPG signed, as if `--signed` is
2912        passed to linkgit:git-push[1]. The string 'if-asked' causes
2913        pushes to be signed if the server supports it, as if
2914        `--signed=if-asked` is passed to 'git push'. A false value may
2915        override a value from a lower-priority config file. An explicit
2916        command-line flag always overrides this config option.
2917
2918push.pushOption::
2919        When no `--push-option=<option>` argument is given from the
2920        command line, `git push` behaves as if each <value> of
2921        this variable is given as `--push-option=<value>`.
2922+
2923This is a multi-valued variable, and an empty value can be used in a
2924higher priority configuration file (e.g. `.git/config` in a
2925repository) to clear the values inherited from a lower priority
2926configuration files (e.g. `$HOME/.gitconfig`).
2927+
2928--
2929
2930Example:
2931
2932/etc/gitconfig
2933  push.pushoption = a
2934  push.pushoption = b
2935
2936~/.gitconfig
2937  push.pushoption = c
2938
2939repo/.git/config
2940  push.pushoption =
2941  push.pushoption = b
2942
2943This will result in only b (a and c are cleared).
2944
2945--
2946
2947push.recurseSubmodules::
2948        Make sure all submodule commits used by the revisions to be pushed
2949        are available on a remote-tracking branch. If the value is 'check'
2950        then Git will verify that all submodule commits that changed in the
2951        revisions to be pushed are available on at least one remote of the
2952        submodule. If any commits are missing, the push will be aborted and
2953        exit with non-zero status. If the value is 'on-demand' then all
2954        submodules that changed in the revisions to be pushed will be
2955        pushed. If on-demand was not able to push all necessary revisions
2956        it will also be aborted and exit with non-zero status. If the value
2957        is 'no' then default behavior of ignoring submodules when pushing
2958        is retained. You may override this configuration at time of push by
2959        specifying '--recurse-submodules=check|on-demand|no'.
2960
2961include::rebase-config.txt[]
2962
2963receive.advertiseAtomic::
2964        By default, git-receive-pack will advertise the atomic push
2965        capability to its clients. If you don't want to advertise this
2966        capability, set this variable to false.
2967
2968receive.advertisePushOptions::
2969        When set to true, git-receive-pack will advertise the push options
2970        capability to its clients. False by default.
2971
2972receive.autogc::
2973        By default, git-receive-pack will run "git-gc --auto" after
2974        receiving data from git-push and updating refs.  You can stop
2975        it by setting this variable to false.
2976
2977receive.certNonceSeed::
2978        By setting this variable to a string, `git receive-pack`
2979        will accept a `git push --signed` and verifies it by using
2980        a "nonce" protected by HMAC using this string as a secret
2981        key.
2982
2983receive.certNonceSlop::
2984        When a `git push --signed` sent a push certificate with a
2985        "nonce" that was issued by a receive-pack serving the same
2986        repository within this many seconds, export the "nonce"
2987        found in the certificate to `GIT_PUSH_CERT_NONCE` to the
2988        hooks (instead of what the receive-pack asked the sending
2989        side to include).  This may allow writing checks in
2990        `pre-receive` and `post-receive` a bit easier.  Instead of
2991        checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
2992        that records by how many seconds the nonce is stale to
2993        decide if they want to accept the certificate, they only
2994        can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
2995
2996receive.fsckObjects::
2997        If it is set to true, git-receive-pack will check all received
2998        objects. See `transfer.fsckObjects` for what's checked.
2999        Defaults to false. If not set, the value of
3000        `transfer.fsckObjects` is used instead.
3001
3002receive.fsck.<msg-id>::
3003        Acts like `fsck.<msg-id>`, but is used by
3004        linkgit:git-receive-pack[1] instead of
3005        linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for
3006        details.
3007
3008receive.fsck.skipList::
3009        Acts like `fsck.skipList`, but is used by
3010        linkgit:git-receive-pack[1] instead of
3011        linkgit:git-fsck[1]. See the `fsck.skipList` documentation for
3012        details.
3013
3014receive.keepAlive::
3015        After receiving the pack from the client, `receive-pack` may
3016        produce no output (if `--quiet` was specified) while processing
3017        the pack, causing some networks to drop the TCP connection.
3018        With this option set, if `receive-pack` does not transmit
3019        any data in this phase for `receive.keepAlive` seconds, it will
3020        send a short keepalive packet.  The default is 5 seconds; set
3021        to 0 to disable keepalives entirely.
3022
3023receive.unpackLimit::
3024        If the number of objects received in a push is below this
3025        limit then the objects will be unpacked into loose object
3026        files. However if the number of received objects equals or
3027        exceeds this limit then the received pack will be stored as
3028        a pack, after adding any missing delta bases.  Storing the
3029        pack from a push can make the push operation complete faster,
3030        especially on slow filesystems.  If not set, the value of
3031        `transfer.unpackLimit` is used instead.
3032
3033receive.maxInputSize::
3034        If the size of the incoming pack stream is larger than this
3035        limit, then git-receive-pack will error out, instead of
3036        accepting the pack file. If not set or set to 0, then the size
3037        is unlimited.
3038
3039receive.denyDeletes::
3040        If set to true, git-receive-pack will deny a ref update that deletes
3041        the ref. Use this to prevent such a ref deletion via a push.
3042
3043receive.denyDeleteCurrent::
3044        If set to true, git-receive-pack will deny a ref update that
3045        deletes the currently checked out branch of a non-bare repository.
3046
3047receive.denyCurrentBranch::
3048        If set to true or "refuse", git-receive-pack will deny a ref update
3049        to the currently checked out branch of a non-bare repository.
3050        Such a push is potentially dangerous because it brings the HEAD
3051        out of sync with the index and working tree. If set to "warn",
3052        print a warning of such a push to stderr, but allow the push to
3053        proceed. If set to false or "ignore", allow such pushes with no
3054        message. Defaults to "refuse".
3055+
3056Another option is "updateInstead" which will update the working
3057tree if pushing into the current branch.  This option is
3058intended for synchronizing working directories when one side is not easily
3059accessible via interactive ssh (e.g. a live web site, hence the requirement
3060that the working directory be clean). This mode also comes in handy when
3061developing inside a VM to test and fix code on different Operating Systems.
3062+
3063By default, "updateInstead" will refuse the push if the working tree or
3064the index have any difference from the HEAD, but the `push-to-checkout`
3065hook can be used to customize this.  See linkgit:githooks[5].
3066
3067receive.denyNonFastForwards::
3068        If set to true, git-receive-pack will deny a ref update which is
3069        not a fast-forward. Use this to prevent such an update via a push,
3070        even if that push is forced. This configuration variable is
3071        set when initializing a shared repository.
3072
3073receive.hideRefs::
3074        This variable is the same as `transfer.hideRefs`, but applies
3075        only to `receive-pack` (and so affects pushes, but not fetches).
3076        An attempt to update or delete a hidden ref by `git push` is
3077        rejected.
3078
3079receive.updateServerInfo::
3080        If set to true, git-receive-pack will run git-update-server-info
3081        after receiving data from git-push and updating refs.
3082
3083receive.shallowUpdate::
3084        If set to true, .git/shallow can be updated when new refs
3085        require new shallow roots. Otherwise those refs are rejected.
3086
3087remote.pushDefault::
3088        The remote to push to by default.  Overrides
3089        `branch.<name>.remote` for all branches, and is overridden by
3090        `branch.<name>.pushRemote` for specific branches.
3091
3092remote.<name>.url::
3093        The URL of a remote repository.  See linkgit:git-fetch[1] or
3094        linkgit:git-push[1].
3095
3096remote.<name>.pushurl::
3097        The push URL of a remote repository.  See linkgit:git-push[1].
3098
3099remote.<name>.proxy::
3100        For remotes that require curl (http, https and ftp), the URL to
3101        the proxy to use for that remote.  Set to the empty string to
3102        disable proxying for that remote.
3103
3104remote.<name>.proxyAuthMethod::
3105        For remotes that require curl (http, https and ftp), the method to use for
3106        authenticating against the proxy in use (probably set in
3107        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3108
3109remote.<name>.fetch::
3110        The default set of "refspec" for linkgit:git-fetch[1]. See
3111        linkgit:git-fetch[1].
3112
3113remote.<name>.push::
3114        The default set of "refspec" for linkgit:git-push[1]. See
3115        linkgit:git-push[1].
3116
3117remote.<name>.mirror::
3118        If true, pushing to this remote will automatically behave
3119        as if the `--mirror` option was given on the command line.
3120
3121remote.<name>.skipDefaultUpdate::
3122        If true, this remote will be skipped by default when updating
3123        using linkgit:git-fetch[1] or the `update` subcommand of
3124        linkgit:git-remote[1].
3125
3126remote.<name>.skipFetchAll::
3127        If true, this remote will be skipped by default when updating
3128        using linkgit:git-fetch[1] or the `update` subcommand of
3129        linkgit:git-remote[1].
3130
3131remote.<name>.receivepack::
3132        The default program to execute on the remote side when pushing.  See
3133        option --receive-pack of linkgit:git-push[1].
3134
3135remote.<name>.uploadpack::
3136        The default program to execute on the remote side when fetching.  See
3137        option --upload-pack of linkgit:git-fetch-pack[1].
3138
3139remote.<name>.tagOpt::
3140        Setting this value to --no-tags disables automatic tag following when
3141        fetching from remote <name>. Setting it to --tags will fetch every
3142        tag from remote <name>, even if they are not reachable from remote
3143        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3144        override this setting. See options --tags and --no-tags of
3145        linkgit:git-fetch[1].
3146
3147remote.<name>.vcs::
3148        Setting this to a value <vcs> will cause Git to interact with
3149        the remote with the git-remote-<vcs> helper.
3150
3151remote.<name>.prune::
3152        When set to true, fetching from this remote by default will also
3153        remove any remote-tracking references that no longer exist on the
3154        remote (as if the `--prune` option was given on the command line).
3155        Overrides `fetch.prune` settings, if any.
3156
3157remote.<name>.pruneTags::
3158        When set to true, fetching from this remote by default will also
3159        remove any local tags that no longer exist on the remote if pruning
3160        is activated in general via `remote.<name>.prune`, `fetch.prune` or
3161        `--prune`. Overrides `fetch.pruneTags` settings, if any.
3162+
3163See also `remote.<name>.prune` and the PRUNING section of
3164linkgit:git-fetch[1].
3165
3166remotes.<group>::
3167        The list of remotes which are fetched by "git remote update
3168        <group>".  See linkgit:git-remote[1].
3169
3170repack.useDeltaBaseOffset::
3171        By default, linkgit:git-repack[1] creates packs that use
3172        delta-base offset. If you need to share your repository with
3173        Git older than version 1.4.4, either directly or via a dumb
3174        protocol such as http, then you need to set this option to
3175        "false" and repack. Access from old Git versions over the
3176        native protocol are unaffected by this option.
3177
3178repack.packKeptObjects::
3179        If set to true, makes `git repack` act as if
3180        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3181        details. Defaults to `false` normally, but `true` if a bitmap
3182        index is being written (either via `--write-bitmap-index` or
3183        `repack.writeBitmaps`).
3184
3185repack.writeBitmaps::
3186        When true, git will write a bitmap index when packing all
3187        objects to disk (e.g., when `git repack -a` is run).  This
3188        index can speed up the "counting objects" phase of subsequent
3189        packs created for clones and fetches, at the cost of some disk
3190        space and extra time spent on the initial repack.  This has
3191        no effect if multiple packfiles are created.
3192        Defaults to false.
3193
3194rerere.autoUpdate::
3195        When set to true, `git-rerere` updates the index with the
3196        resulting contents after it cleanly resolves conflicts using
3197        previously recorded resolution.  Defaults to false.
3198
3199rerere.enabled::
3200        Activate recording of resolved conflicts, so that identical
3201        conflict hunks can be resolved automatically, should they be
3202        encountered again.  By default, linkgit:git-rerere[1] is
3203        enabled if there is an `rr-cache` directory under the
3204        `$GIT_DIR`, e.g. if "rerere" was previously used in the
3205        repository.
3206
3207sendemail.identity::
3208        A configuration identity. When given, causes values in the
3209        'sendemail.<identity>' subsection to take precedence over
3210        values in the 'sendemail' section. The default identity is
3211        the value of `sendemail.identity`.
3212
3213sendemail.smtpEncryption::
3214        See linkgit:git-send-email[1] for description.  Note that this
3215        setting is not subject to the 'identity' mechanism.
3216
3217sendemail.smtpssl (deprecated)::
3218        Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3219
3220sendemail.smtpsslcertpath::
3221        Path to ca-certificates (either a directory or a single file).
3222        Set it to an empty string to disable certificate verification.
3223
3224sendemail.<identity>.*::
3225        Identity-specific versions of the 'sendemail.*' parameters
3226        found below, taking precedence over those when this
3227        identity is selected, through either the command-line or
3228        `sendemail.identity`.
3229
3230sendemail.aliasesFile::
3231sendemail.aliasFileType::
3232sendemail.annotate::
3233sendemail.bcc::
3234sendemail.cc::
3235sendemail.ccCmd::
3236sendemail.chainReplyTo::
3237sendemail.confirm::
3238sendemail.envelopeSender::
3239sendemail.from::
3240sendemail.multiEdit::
3241sendemail.signedoffbycc::
3242sendemail.smtpPass::
3243sendemail.suppresscc::
3244sendemail.suppressFrom::
3245sendemail.to::
3246sendemail.tocmd::
3247sendemail.smtpDomain::
3248sendemail.smtpServer::
3249sendemail.smtpServerPort::
3250sendemail.smtpServerOption::
3251sendemail.smtpUser::
3252sendemail.thread::
3253sendemail.transferEncoding::
3254sendemail.validate::
3255sendemail.xmailer::
3256        See linkgit:git-send-email[1] for description.
3257
3258sendemail.signedoffcc (deprecated)::
3259        Deprecated alias for `sendemail.signedoffbycc`.
3260
3261sendemail.smtpBatchSize::
3262        Number of messages to be sent per connection, after that a relogin
3263        will happen.  If the value is 0 or undefined, send all messages in
3264        one connection.
3265        See also the `--batch-size` option of linkgit:git-send-email[1].
3266
3267sendemail.smtpReloginDelay::
3268        Seconds wait before reconnecting to smtp server.
3269        See also the `--relogin-delay` option of linkgit:git-send-email[1].
3270
3271showbranch.default::
3272        The default set of branches for linkgit:git-show-branch[1].
3273        See linkgit:git-show-branch[1].
3274
3275splitIndex.maxPercentChange::
3276        When the split index feature is used, this specifies the
3277        percent of entries the split index can contain compared to the
3278        total number of entries in both the split index and the shared
3279        index before a new shared index is written.
3280        The value should be between 0 and 100. If the value is 0 then
3281        a new shared index is always written, if it is 100 a new
3282        shared index is never written.
3283        By default the value is 20, so a new shared index is written
3284        if the number of entries in the split index would be greater
3285        than 20 percent of the total number of entries.
3286        See linkgit:git-update-index[1].
3287
3288splitIndex.sharedIndexExpire::
3289        When the split index feature is used, shared index files that
3290        were not modified since the time this variable specifies will
3291        be removed when a new shared index file is created. The value
3292        "now" expires all entries immediately, and "never" suppresses
3293        expiration altogether.
3294        The default value is "2.weeks.ago".
3295        Note that a shared index file is considered modified (for the
3296        purpose of expiration) each time a new split-index file is
3297        either created based on it or read from it.
3298        See linkgit:git-update-index[1].
3299
3300status.relativePaths::
3301        By default, linkgit:git-status[1] shows paths relative to the
3302        current directory. Setting this variable to `false` shows paths
3303        relative to the repository root (this was the default for Git
3304        prior to v1.5.4).
3305
3306status.short::
3307        Set to true to enable --short by default in linkgit:git-status[1].
3308        The option --no-short takes precedence over this variable.
3309
3310status.branch::
3311        Set to true to enable --branch by default in linkgit:git-status[1].
3312        The option --no-branch takes precedence over this variable.
3313
3314status.displayCommentPrefix::
3315        If set to true, linkgit:git-status[1] will insert a comment
3316        prefix before each output line (starting with
3317        `core.commentChar`, i.e. `#` by default). This was the
3318        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3319        Defaults to false.
3320
3321status.renameLimit::
3322        The number of files to consider when performing rename detection
3323        in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3324        the value of diff.renameLimit.
3325
3326status.renames::
3327        Whether and how Git detects renames in linkgit:git-status[1] and
3328        linkgit:git-commit[1] .  If set to "false", rename detection is
3329        disabled. If set to "true", basic rename detection is enabled.
3330        If set to "copies" or "copy", Git will detect copies, as well.
3331        Defaults to the value of diff.renames.
3332
3333status.showStash::
3334        If set to true, linkgit:git-status[1] will display the number of
3335        entries currently stashed away.
3336        Defaults to false.
3337
3338status.showUntrackedFiles::
3339        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3340        files which are not currently tracked by Git. Directories which
3341        contain only untracked files, are shown with the directory name
3342        only. Showing untracked files means that Git needs to lstat() all
3343        the files in the whole repository, which might be slow on some
3344        systems. So, this variable controls how the commands displays
3345        the untracked files. Possible values are:
3346+
3347--
3348* `no` - Show no untracked files.
3349* `normal` - Show untracked files and directories.
3350* `all` - Show also individual files in untracked directories.
3351--
3352+
3353If this variable is not specified, it defaults to 'normal'.
3354This variable can be overridden with the -u|--untracked-files option
3355of linkgit:git-status[1] and linkgit:git-commit[1].
3356
3357status.submoduleSummary::
3358        Defaults to false.
3359        If this is set to a non zero number or true (identical to -1 or an
3360        unlimited number), the submodule summary will be enabled and a
3361        summary of commits for modified submodules will be shown (see
3362        --summary-limit option of linkgit:git-submodule[1]). Please note
3363        that the summary output command will be suppressed for all
3364        submodules when `diff.ignoreSubmodules` is set to 'all' or only
3365        for those submodules where `submodule.<name>.ignore=all`. The only
3366        exception to that rule is that status and commit will show staged
3367        submodule changes. To
3368        also view the summary for ignored submodules you can either use
3369        the --ignore-submodules=dirty command-line option or the 'git
3370        submodule summary' command, which shows a similar output but does
3371        not honor these settings.
3372
3373stash.showPatch::
3374        If this is set to true, the `git stash show` command without an
3375        option will show the stash entry in patch form.  Defaults to false.
3376        See description of 'show' command in linkgit:git-stash[1].
3377
3378stash.showStat::
3379        If this is set to true, the `git stash show` command without an
3380        option will show diffstat of the stash entry.  Defaults to true.
3381        See description of 'show' command in linkgit:git-stash[1].
3382
3383submodule.<name>.url::
3384        The URL for a submodule. This variable is copied from the .gitmodules
3385        file to the git config via 'git submodule init'. The user can change
3386        the configured URL before obtaining the submodule via 'git submodule
3387        update'. If neither submodule.<name>.active or submodule.active are
3388        set, the presence of this variable is used as a fallback to indicate
3389        whether the submodule is of interest to git commands.
3390        See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3391
3392submodule.<name>.update::
3393        The method by which a submodule is updated by 'git submodule update',
3394        which is the only affected command, others such as
3395        'git checkout --recurse-submodules' are unaffected. It exists for
3396        historical reasons, when 'git submodule' was the only command to
3397        interact with submodules; settings like `submodule.active`
3398        and `pull.rebase` are more specific. It is populated by
3399        `git submodule init` from the linkgit:gitmodules[5] file.
3400        See description of 'update' command in linkgit:git-submodule[1].
3401
3402submodule.<name>.branch::
3403        The remote branch name for a submodule, used by `git submodule
3404        update --remote`.  Set this option to override the value found in
3405        the `.gitmodules` file.  See linkgit:git-submodule[1] and
3406        linkgit:gitmodules[5] for details.
3407
3408submodule.<name>.fetchRecurseSubmodules::
3409        This option can be used to control recursive fetching of this
3410        submodule. It can be overridden by using the --[no-]recurse-submodules
3411        command-line option to "git fetch" and "git pull".
3412        This setting will override that from in the linkgit:gitmodules[5]
3413        file.
3414
3415submodule.<name>.ignore::
3416        Defines under what circumstances "git status" and the diff family show
3417        a submodule as modified. When set to "all", it will never be considered
3418        modified (but it will nonetheless show up in the output of status and
3419        commit when it has been staged), "dirty" will ignore all changes
3420        to the submodules work tree and
3421        takes only differences between the HEAD of the submodule and the commit
3422        recorded in the superproject into account. "untracked" will additionally
3423        let submodules with modified tracked files in their work tree show up.
3424        Using "none" (the default when this option is not set) also shows
3425        submodules that have untracked files in their work tree as changed.
3426        This setting overrides any setting made in .gitmodules for this submodule,
3427        both settings can be overridden on the command line by using the
3428        "--ignore-submodules" option. The 'git submodule' commands are not
3429        affected by this setting.
3430
3431submodule.<name>.active::
3432        Boolean value indicating if the submodule is of interest to git
3433        commands.  This config option takes precedence over the
3434        submodule.active config option. See linkgit:gitsubmodules[7] for
3435        details.
3436
3437submodule.active::
3438        A repeated field which contains a pathspec used to match against a
3439        submodule's path to determine if the submodule is of interest to git
3440        commands. See linkgit:gitsubmodules[7] for details.
3441
3442submodule.recurse::
3443        Specifies if commands recurse into submodules by default. This
3444        applies to all commands that have a `--recurse-submodules` option,
3445        except `clone`.
3446        Defaults to false.
3447
3448submodule.fetchJobs::
3449        Specifies how many submodules are fetched/cloned at the same time.
3450        A positive integer allows up to that number of submodules fetched
3451        in parallel. A value of 0 will give some reasonable default.
3452        If unset, it defaults to 1.
3453
3454submodule.alternateLocation::
3455        Specifies how the submodules obtain alternates when submodules are
3456        cloned. Possible values are `no`, `superproject`.
3457        By default `no` is assumed, which doesn't add references. When the
3458        value is set to `superproject` the submodule to be cloned computes
3459        its alternates location relative to the superprojects alternate.
3460
3461submodule.alternateErrorStrategy::
3462        Specifies how to treat errors with the alternates for a submodule
3463        as computed via `submodule.alternateLocation`. Possible values are
3464        `ignore`, `info`, `die`. Default is `die`.
3465
3466tag.forceSignAnnotated::
3467        A boolean to specify whether annotated tags created should be GPG signed.
3468        If `--annotate` is specified on the command line, it takes
3469        precedence over this option.
3470
3471tag.sort::
3472        This variable controls the sort ordering of tags when displayed by
3473        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3474        value of this variable will be used as the default.
3475
3476tar.umask::
3477        This variable can be used to restrict the permission bits of
3478        tar archive entries.  The default is 0002, which turns off the
3479        world write bit.  The special value "user" indicates that the
3480        archiving user's umask will be used instead.  See umask(2) and
3481        linkgit:git-archive[1].
3482
3483transfer.fsckObjects::
3484        When `fetch.fsckObjects` or `receive.fsckObjects` are
3485        not set, the value of this variable is used instead.
3486        Defaults to false.
3487+
3488When set, the fetch or receive will abort in the case of a malformed
3489object or a link to a nonexistent object. In addition, various other
3490issues are checked for, including legacy issues (see `fsck.<msg-id>`),
3491and potential security issues like the existence of a `.GIT` directory
3492or a malicious `.gitmodules` file (see the release notes for v2.2.1
3493and v2.17.1 for details). Other sanity and security checks may be
3494added in future releases.
3495+
3496On the receiving side, failing fsckObjects will make those objects
3497unreachable, see "QUARANTINE ENVIRONMENT" in
3498linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
3499instead be left unreferenced in the repository.
3500+
3501Due to the non-quarantine nature of the `fetch.fsckObjects`
3502implementation it can not be relied upon to leave the object store
3503clean like `receive.fsckObjects` can.
3504+
3505As objects are unpacked they're written to the object store, so there
3506can be cases where malicious objects get introduced even though the
3507"fetch" failed, only to have a subsequent "fetch" succeed because only
3508new incoming objects are checked, not those that have already been
3509written to the object store. That difference in behavior should not be
3510relied upon. In the future, such objects may be quarantined for
3511"fetch" as well.
3512+
3513For now, the paranoid need to find some way to emulate the quarantine
3514environment if they'd like the same protection as "push". E.g. in the
3515case of an internal mirror do the mirroring in two steps, one to fetch
3516the untrusted objects, and then do a second "push" (which will use the
3517quarantine) to another internal repo, and have internal clients
3518consume this pushed-to repository, or embargo internal fetches and
3519only allow them once a full "fsck" has run (and no new fetches have
3520happened in the meantime).
3521
3522transfer.hideRefs::
3523        String(s) `receive-pack` and `upload-pack` use to decide which
3524        refs to omit from their initial advertisements.  Use more than
3525        one definition to specify multiple prefix strings. A ref that is
3526        under the hierarchies listed in the value of this variable is
3527        excluded, and is hidden when responding to `git push` or `git
3528        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
3529        program-specific versions of this config.
3530+
3531You may also include a `!` in front of the ref name to negate the entry,
3532explicitly exposing it, even if an earlier entry marked it as hidden.
3533If you have multiple hideRefs values, later entries override earlier ones
3534(and entries in more-specific config files override less-specific ones).
3535+
3536If a namespace is in use, the namespace prefix is stripped from each
3537reference before it is matched against `transfer.hiderefs` patterns.
3538For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3539the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3540is omitted from the advertisements but `refs/heads/master` and
3541`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3542"have" lines. In order to match refs before stripping, add a `^` in front of
3543the ref name. If you combine `!` and `^`, `!` must be specified first.
3544+
3545Even if you hide refs, a client may still be able to steal the target
3546objects via the techniques described in the "SECURITY" section of the
3547linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3548separate repository.
3549
3550transfer.unpackLimit::
3551        When `fetch.unpackLimit` or `receive.unpackLimit` are
3552        not set, the value of this variable is used instead.
3553        The default value is 100.
3554
3555uploadarchive.allowUnreachable::
3556        If true, allow clients to use `git archive --remote` to request
3557        any tree, whether reachable from the ref tips or not. See the
3558        discussion in the "SECURITY" section of
3559        linkgit:git-upload-archive[1] for more details. Defaults to
3560        `false`.
3561
3562uploadpack.hideRefs::
3563        This variable is the same as `transfer.hideRefs`, but applies
3564        only to `upload-pack` (and so affects only fetches, not pushes).
3565        An attempt to fetch a hidden ref by `git fetch` will fail.  See
3566        also `uploadpack.allowTipSHA1InWant`.
3567
3568uploadpack.allowTipSHA1InWant::
3569        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3570        to accept a fetch request that asks for an object at the tip
3571        of a hidden ref (by default, such a request is rejected).
3572        See also `uploadpack.hideRefs`.  Even if this is false, a client
3573        may be able to steal objects via the techniques described in the
3574        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3575        best to keep private data in a separate repository.
3576
3577uploadpack.allowReachableSHA1InWant::
3578        Allow `upload-pack` to accept a fetch request that asks for an
3579        object that is reachable from any ref tip. However, note that
3580        calculating object reachability is computationally expensive.
3581        Defaults to `false`.  Even if this is false, a client may be able
3582        to steal objects via the techniques described in the "SECURITY"
3583        section of the linkgit:gitnamespaces[7] man page; it's best to
3584        keep private data in a separate repository.
3585
3586uploadpack.allowAnySHA1InWant::
3587        Allow `upload-pack` to accept a fetch request that asks for any
3588        object at all.
3589        Defaults to `false`.
3590
3591uploadpack.keepAlive::
3592        When `upload-pack` has started `pack-objects`, there may be a
3593        quiet period while `pack-objects` prepares the pack. Normally
3594        it would output progress information, but if `--quiet` was used
3595        for the fetch, `pack-objects` will output nothing at all until
3596        the pack data begins. Some clients and networks may consider
3597        the server to be hung and give up. Setting this option instructs
3598        `upload-pack` to send an empty keepalive packet every
3599        `uploadpack.keepAlive` seconds. Setting this option to 0
3600        disables keepalive packets entirely. The default is 5 seconds.
3601
3602uploadpack.packObjectsHook::
3603        If this option is set, when `upload-pack` would run
3604        `git pack-objects` to create a packfile for a client, it will
3605        run this shell command instead.  The `pack-objects` command and
3606        arguments it _would_ have run (including the `git pack-objects`
3607        at the beginning) are appended to the shell command. The stdin
3608        and stdout of the hook are treated as if `pack-objects` itself
3609        was run. I.e., `upload-pack` will feed input intended for
3610        `pack-objects` to the hook, and expects a completed packfile on
3611        stdout.
3612
3613uploadpack.allowFilter::
3614        If this option is set, `upload-pack` will support partial
3615        clone and partial fetch object filtering.
3616+
3617Note that this configuration variable is ignored if it is seen in the
3618repository-level config (this is a safety measure against fetching from
3619untrusted repositories).
3620
3621uploadpack.allowRefInWant::
3622        If this option is set, `upload-pack` will support the `ref-in-want`
3623        feature of the protocol version 2 `fetch` command.  This feature
3624        is intended for the benefit of load-balanced servers which may
3625        not have the same view of what OIDs their refs point to due to
3626        replication delay.
3627
3628url.<base>.insteadOf::
3629        Any URL that starts with this value will be rewritten to
3630        start, instead, with <base>. In cases where some site serves a
3631        large number of repositories, and serves them with multiple
3632        access methods, and some users need to use different access
3633        methods, this feature allows people to specify any of the
3634        equivalent URLs and have Git automatically rewrite the URL to
3635        the best alternative for the particular user, even for a
3636        never-before-seen repository on the site.  When more than one
3637        insteadOf strings match a given URL, the longest match is used.
3638+
3639Note that any protocol restrictions will be applied to the rewritten
3640URL. If the rewrite changes the URL to use a custom protocol or remote
3641helper, you may need to adjust the `protocol.*.allow` config to permit
3642the request.  In particular, protocols you expect to use for submodules
3643must be set to `always` rather than the default of `user`. See the
3644description of `protocol.allow` above.
3645
3646url.<base>.pushInsteadOf::
3647        Any URL that starts with this value will not be pushed to;
3648        instead, it will be rewritten to start with <base>, and the
3649        resulting URL will be pushed to. In cases where some site serves
3650        a large number of repositories, and serves them with multiple
3651        access methods, some of which do not allow push, this feature
3652        allows people to specify a pull-only URL and have Git
3653        automatically use an appropriate URL to push, even for a
3654        never-before-seen repository on the site.  When more than one
3655        pushInsteadOf strings match a given URL, the longest match is
3656        used.  If a remote has an explicit pushurl, Git will ignore this
3657        setting for that remote.
3658
3659user.email::
3660        Your email address to be recorded in any newly created commits.
3661        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3662        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
3663
3664user.name::
3665        Your full name to be recorded in any newly created commits.
3666        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3667        environment variables.  See linkgit:git-commit-tree[1].
3668
3669user.useConfigOnly::
3670        Instruct Git to avoid trying to guess defaults for `user.email`
3671        and `user.name`, and instead retrieve the values only from the
3672        configuration. For example, if you have multiple email addresses
3673        and would like to use a different one for each repository, then
3674        with this configuration option set to `true` in the global config
3675        along with a name, Git will prompt you to set up an email before
3676        making new commits in a newly cloned repository.
3677        Defaults to `false`.
3678
3679user.signingKey::
3680        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3681        key you want it to automatically when creating a signed tag or
3682        commit, you can override the default selection with this variable.
3683        This option is passed unchanged to gpg's --local-user parameter,
3684        so you may specify a key using any method that gpg supports.
3685
3686versionsort.prereleaseSuffix (deprecated)::
3687        Deprecated alias for `versionsort.suffix`.  Ignored if
3688        `versionsort.suffix` is set.
3689
3690versionsort.suffix::
3691        Even when version sort is used in linkgit:git-tag[1], tagnames
3692        with the same base version but different suffixes are still sorted
3693        lexicographically, resulting e.g. in prerelease tags appearing
3694        after the main release (e.g. "1.0-rc1" after "1.0").  This
3695        variable can be specified to determine the sorting order of tags
3696        with different suffixes.
3697+
3698By specifying a single suffix in this variable, any tagname containing
3699that suffix will appear before the corresponding main release.  E.g. if
3700the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3701"1.0".  If specified multiple times, once per suffix, then the order of
3702suffixes in the configuration will determine the sorting order of tagnames
3703with those suffixes.  E.g. if "-pre" appears before "-rc" in the
3704configuration, then all "1.0-preX" tags will be listed before any
3705"1.0-rcX" tags.  The placement of the main release tag relative to tags
3706with various suffixes can be determined by specifying the empty suffix
3707among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
3708"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3709are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3710"v4.8-bfsX".
3711+
3712If more than one suffixes match the same tagname, then that tagname will
3713be sorted according to the suffix which starts at the earliest position in
3714the tagname.  If more than one different matching suffixes start at
3715that earliest position, then that tagname will be sorted according to the
3716longest of those suffixes.
3717The sorting order between different suffixes is undefined if they are
3718in multiple config files.
3719
3720web.browser::
3721        Specify a web browser that may be used by some commands.
3722        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3723        may use it.
3724
3725worktree.guessRemote::
3726        With `add`, if no branch argument, and neither of `-b` nor
3727        `-B` nor `--detach` are given, the command defaults to
3728        creating a new branch from HEAD.  If `worktree.guessRemote` is
3729        set to true, `worktree add` tries to find a remote-tracking
3730        branch whose name uniquely matches the new branch name.  If
3731        such a branch exists, it is checked out and set as "upstream"
3732        for the new branch.  If no such match can be found, it falls
3733        back to creating a new branch from the current HEAD.