Documentation / config.txton commit multi-pack-index: verify oid fanout order (2f23d3f)
   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.multiPackIndex::
 933        Use the multi-pack-index file to track multiple packfiles using a
 934        single index. See link:technical/multi-pack-index.html[the
 935        multi-pack-index design document].
 936
 937core.sparseCheckout::
 938        Enable "sparse checkout" feature. See section "Sparse checkout" in
 939        linkgit:git-read-tree[1] for more information.
 940
 941core.abbrev::
 942        Set the length object names are abbreviated to.  If
 943        unspecified or set to "auto", an appropriate value is
 944        computed based on the approximate number of packed objects
 945        in your repository, which hopefully is enough for
 946        abbreviated object names to stay unique for some time.
 947        The minimum length is 4.
 948
 949add.ignoreErrors::
 950add.ignore-errors (deprecated)::
 951        Tells 'git add' to continue adding files when some files cannot be
 952        added due to indexing errors. Equivalent to the `--ignore-errors`
 953        option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
 954        as it does not follow the usual naming convention for configuration
 955        variables.
 956
 957alias.*::
 958        Command aliases for the linkgit:git[1] command wrapper - e.g.
 959        after defining "alias.last = cat-file commit HEAD", the invocation
 960        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 961        confusion and troubles with script usage, aliases that
 962        hide existing Git commands are ignored. Arguments are split by
 963        spaces, the usual shell quoting and escaping is supported.
 964        A quote pair or a backslash can be used to quote them.
 965+
 966If the alias expansion is prefixed with an exclamation point,
 967it will be treated as a shell command.  For example, defining
 968"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 969"git new" is equivalent to running the shell command
 970"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 971executed from the top-level directory of a repository, which may
 972not necessarily be the current directory.
 973`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
 974from the original current directory. See linkgit:git-rev-parse[1].
 975
 976am.keepcr::
 977        If true, git-am will call git-mailsplit for patches in mbox format
 978        with parameter `--keep-cr`. In this case git-mailsplit will
 979        not remove `\r` from lines ending with `\r\n`. Can be overridden
 980        by giving `--no-keep-cr` from the command line.
 981        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 982
 983am.threeWay::
 984        By default, `git am` will fail if the patch does not apply cleanly. When
 985        set to true, this setting tells `git am` to fall back on 3-way merge if
 986        the patch records the identity of blobs it is supposed to apply to and
 987        we have those blobs available locally (equivalent to giving the `--3way`
 988        option from the command line). Defaults to `false`.
 989        See linkgit:git-am[1].
 990
 991apply.ignoreWhitespace::
 992        When set to 'change', tells 'git apply' to ignore changes in
 993        whitespace, in the same way as the `--ignore-space-change`
 994        option.
 995        When set to one of: no, none, never, false tells 'git apply' to
 996        respect all whitespace differences.
 997        See linkgit:git-apply[1].
 998
 999apply.whitespace::
1000        Tells 'git apply' how to handle whitespaces, in the same way
1001        as the `--whitespace` option. See linkgit:git-apply[1].
1002
1003blame.blankBoundary::
1004        Show blank commit object name for boundary commits in
1005        linkgit:git-blame[1]. This option defaults to false.
1006
1007blame.coloring::
1008        This determines the coloring scheme to be applied to blame
1009        output. It can be 'repeatedLines', 'highlightRecent',
1010        or 'none' which is the default.
1011
1012blame.date::
1013        Specifies the format used to output dates in linkgit:git-blame[1].
1014        If unset the iso format is used. For supported values,
1015        see the discussion of the `--date` option at linkgit:git-log[1].
1016
1017blame.showEmail::
1018        Show the author email instead of author name in linkgit:git-blame[1].
1019        This option defaults to false.
1020
1021blame.showRoot::
1022        Do not treat root commits as boundaries in linkgit:git-blame[1].
1023        This option defaults to false.
1024
1025branch.autoSetupMerge::
1026        Tells 'git branch' and 'git checkout' to set up new branches
1027        so that linkgit:git-pull[1] will appropriately merge from the
1028        starting point branch. Note that even if this option is not set,
1029        this behavior can be chosen per-branch using the `--track`
1030        and `--no-track` options. The valid settings are: `false` -- no
1031        automatic setup is done; `true` -- automatic setup is done when the
1032        starting point is a remote-tracking branch; `always` --
1033        automatic setup is done when the starting point is either a
1034        local branch or remote-tracking
1035        branch. This option defaults to true.
1036
1037branch.autoSetupRebase::
1038        When a new branch is created with 'git branch' or 'git checkout'
1039        that tracks another branch, this variable tells Git to set
1040        up pull to rebase instead of merge (see "branch.<name>.rebase").
1041        When `never`, rebase is never automatically set to true.
1042        When `local`, rebase is set to true for tracked branches of
1043        other local branches.
1044        When `remote`, rebase is set to true for tracked branches of
1045        remote-tracking branches.
1046        When `always`, rebase will be set to true for all tracking
1047        branches.
1048        See "branch.autoSetupMerge" for details on how to set up a
1049        branch to track another branch.
1050        This option defaults to never.
1051
1052branch.<name>.remote::
1053        When on branch <name>, it tells 'git fetch' and 'git push'
1054        which remote to fetch from/push to.  The remote to push to
1055        may be overridden with `remote.pushDefault` (for all branches).
1056        The remote to push to, for the current branch, may be further
1057        overridden by `branch.<name>.pushRemote`.  If no remote is
1058        configured, or if you are not on any branch, it defaults to
1059        `origin` for fetching and `remote.pushDefault` for pushing.
1060        Additionally, `.` (a period) is the current local repository
1061        (a dot-repository), see `branch.<name>.merge`'s final note below.
1062
1063branch.<name>.pushRemote::
1064        When on branch <name>, it overrides `branch.<name>.remote` for
1065        pushing.  It also overrides `remote.pushDefault` for pushing
1066        from branch <name>.  When you pull from one place (e.g. your
1067        upstream) and push to another place (e.g. your own publishing
1068        repository), you would want to set `remote.pushDefault` to
1069        specify the remote to push to for all branches, and use this
1070        option to override it for a specific branch.
1071
1072branch.<name>.merge::
1073        Defines, together with branch.<name>.remote, the upstream branch
1074        for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1075        branch to merge and can also affect 'git push' (see push.default).
1076        When in branch <name>, it tells 'git fetch' the default
1077        refspec to be marked for merging in FETCH_HEAD. The value is
1078        handled like the remote part of a refspec, and must match a
1079        ref which is fetched from the remote given by
1080        "branch.<name>.remote".
1081        The merge information is used by 'git pull' (which at first calls
1082        'git fetch') to lookup the default branch for merging. Without
1083        this option, 'git pull' defaults to merge the first refspec fetched.
1084        Specify multiple values to get an octopus merge.
1085        If you wish to setup 'git pull' so that it merges into <name> from
1086        another branch in the local repository, you can point
1087        branch.<name>.merge to the desired branch, and use the relative path
1088        setting `.` (a period) for branch.<name>.remote.
1089
1090branch.<name>.mergeOptions::
1091        Sets default options for merging into branch <name>. The syntax and
1092        supported options are the same as those of linkgit:git-merge[1], but
1093        option values containing whitespace characters are currently not
1094        supported.
1095
1096branch.<name>.rebase::
1097        When true, rebase the branch <name> on top of the fetched branch,
1098        instead of merging the default branch from the default remote when
1099        "git pull" is run. See "pull.rebase" for doing this in a non
1100        branch-specific manner.
1101+
1102When `merges`, pass the `--rebase-merges` option to 'git rebase'
1103so that the local merge commits are included in the rebase (see
1104linkgit:git-rebase[1] for details).
1105+
1106When preserve, also pass `--preserve-merges` along to 'git rebase'
1107so that locally committed merge commits will not be flattened
1108by running 'git pull'.
1109+
1110When the value is `interactive`, the rebase is run in interactive mode.
1111+
1112*NOTE*: this is a possibly dangerous operation; do *not* use
1113it unless you understand the implications (see linkgit:git-rebase[1]
1114for details).
1115
1116branch.<name>.description::
1117        Branch description, can be edited with
1118        `git branch --edit-description`. Branch description is
1119        automatically added in the format-patch cover letter or
1120        request-pull summary.
1121
1122browser.<tool>.cmd::
1123        Specify the command to invoke the specified browser. The
1124        specified command is evaluated in shell with the URLs passed
1125        as arguments. (See linkgit:git-web{litdd}browse[1].)
1126
1127browser.<tool>.path::
1128        Override the path for the given tool that may be used to
1129        browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1130        working repository in gitweb (see linkgit:git-instaweb[1]).
1131
1132checkout.defaultRemote::
1133        When you run 'git checkout <something>' and only have one
1134        remote, it may implicitly fall back on checking out and
1135        tracking e.g. 'origin/<something>'. This stops working as soon
1136        as you have more than one remote with a '<something>'
1137        reference. This setting allows for setting the name of a
1138        preferred remote that should always win when it comes to
1139        disambiguation. The typical use-case is to set this to
1140        `origin`.
1141+
1142Currently this is used by linkgit:git-checkout[1] when 'git checkout
1143<something>' will checkout the '<something>' branch on another remote,
1144and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1145remote branch. This setting might be used for other checkout-like
1146commands or functionality in the future.
1147
1148clean.requireForce::
1149        A boolean to make git-clean do nothing unless given -f,
1150        -i or -n.   Defaults to true.
1151
1152color.advice::
1153        A boolean to enable/disable color in hints (e.g. when a push
1154        failed, see `advice.*` for a list).  May be set to `always`,
1155        `false` (or `never`) or `auto` (or `true`), in which case colors
1156        are used only when the error output goes to a terminal. If
1157        unset, then the value of `color.ui` is used (`auto` by default).
1158
1159color.advice.hint::
1160        Use customized color for hints.
1161
1162color.blame.highlightRecent::
1163        This can be used to color the metadata of a blame line depending
1164        on age of the line.
1165+
1166This setting should be set to a comma-separated list of color and date settings,
1167starting and ending with a color, the dates should be set from oldest to newest.
1168The metadata will be colored given the colors if the the line was introduced
1169before the given timestamp, overwriting older timestamped colors.
1170+
1171Instead of an absolute timestamp relative timestamps work as well, e.g.
11722.weeks.ago is valid to address anything older than 2 weeks.
1173+
1174It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1175everything older than one year blue, recent changes between one month and
1176one year old are kept white, and lines introduced within the last month are
1177colored red.
1178
1179color.blame.repeatedLines::
1180        Use the customized color for the part of git-blame output that
1181        is repeated meta information per line (such as commit id,
1182        author name, date and timezone). Defaults to cyan.
1183
1184color.branch::
1185        A boolean to enable/disable color in the output of
1186        linkgit:git-branch[1]. May be set to `always`,
1187        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1188        only when the output is to a terminal. If unset, then the
1189        value of `color.ui` is used (`auto` by default).
1190
1191color.branch.<slot>::
1192        Use customized color for branch coloration. `<slot>` is one of
1193        `current` (the current branch), `local` (a local branch),
1194        `remote` (a remote-tracking branch in refs/remotes/),
1195        `upstream` (upstream tracking branch), `plain` (other
1196        refs).
1197
1198color.diff::
1199        Whether to use ANSI escape sequences to add color to patches.
1200        If this is set to `always`, linkgit:git-diff[1],
1201        linkgit:git-log[1], and linkgit:git-show[1] will use color
1202        for all patches.  If it is set to `true` or `auto`, those
1203        commands will only use color when output is to the terminal.
1204        If unset, then the value of `color.ui` is used (`auto` by
1205        default).
1206+
1207This does not affect linkgit:git-format-patch[1] or the
1208'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
1209command line with the `--color[=<when>]` option.
1210
1211diff.colorMoved::
1212        If set to either a valid `<mode>` or a true value, moved lines
1213        in a diff are colored differently, for details of valid modes
1214        see '--color-moved' in linkgit:git-diff[1]. If simply set to
1215        true the default color mode will be used. When set to false,
1216        moved lines are not colored.
1217
1218diff.colorMovedWS::
1219        When moved lines are colored using e.g. the `diff.colorMoved` setting,
1220        this option controls the `<mode>` how spaces are treated
1221        for details of valid modes see '--color-moved-ws' in linkgit:git-diff[1].
1222
1223color.diff.<slot>::
1224        Use customized color for diff colorization.  `<slot>` specifies
1225        which part of the patch to use the specified color, and is one
1226        of `context` (context text - `plain` is a historical synonym),
1227        `meta` (metainformation), `frag`
1228        (hunk header), 'func' (function in hunk header), `old` (removed lines),
1229        `new` (added lines), `commit` (commit headers), `whitespace`
1230        (highlighting whitespace errors), `oldMoved` (deleted lines),
1231        `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1232        `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1233        `newMovedAlternativeDimmed` (See the '<mode>'
1234        setting of '--color-moved' in linkgit:git-diff[1] for details),
1235        `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1236        `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1237
1238color.decorate.<slot>::
1239        Use customized color for 'git log --decorate' output.  `<slot>` is one
1240        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1241        branches, remote-tracking branches, tags, stash and HEAD, respectively
1242        and `grafted` for grafted commits.
1243
1244color.grep::
1245        When set to `always`, always highlight matches.  When `false` (or
1246        `never`), never.  When set to `true` or `auto`, use color only
1247        when the output is written to the terminal.  If unset, then the
1248        value of `color.ui` is used (`auto` by default).
1249
1250color.grep.<slot>::
1251        Use customized color for grep colorization.  `<slot>` specifies which
1252        part of the line to use the specified color, and is one of
1253+
1254--
1255`context`;;
1256        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1257`filename`;;
1258        filename prefix (when not using `-h`)
1259`function`;;
1260        function name lines (when using `-p`)
1261`lineNumber`;;
1262        line number prefix (when using `-n`)
1263`column`;;
1264        column number prefix (when using `--column`)
1265`match`;;
1266        matching text (same as setting `matchContext` and `matchSelected`)
1267`matchContext`;;
1268        matching text in context lines
1269`matchSelected`;;
1270        matching text in selected lines
1271`selected`;;
1272        non-matching text in selected lines
1273`separator`;;
1274        separators between fields on a line (`:`, `-`, and `=`)
1275        and between hunks (`--`)
1276--
1277
1278color.interactive::
1279        When set to `always`, always use colors for interactive prompts
1280        and displays (such as those used by "git-add --interactive" and
1281        "git-clean --interactive"). When false (or `never`), never.
1282        When set to `true` or `auto`, use colors only when the output is
1283        to the terminal. If unset, then the value of `color.ui` is
1284        used (`auto` by default).
1285
1286color.interactive.<slot>::
1287        Use customized color for 'git add --interactive' and 'git clean
1288        --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1289        or `error`, for four distinct types of normal output from
1290        interactive commands.
1291
1292color.pager::
1293        A boolean to enable/disable colored output when the pager is in
1294        use (default is true).
1295
1296color.push::
1297        A boolean to enable/disable color in push errors. May be set to
1298        `always`, `false` (or `never`) or `auto` (or `true`), in which
1299        case colors are used only when the error output goes to a terminal.
1300        If unset, then the value of `color.ui` is used (`auto` by default).
1301
1302color.push.error::
1303        Use customized color for push errors.
1304
1305color.remote::
1306        If set, keywords at the start of the line are highlighted. The
1307        keywords are "error", "warning", "hint" and "success", and are
1308        matched case-insensitively. May be set to `always`, `false` (or
1309        `never`) or `auto` (or `true`). If unset, then the value of
1310        `color.ui` is used (`auto` by default).
1311
1312color.remote.<slot>::
1313        Use customized color for each remote keyword. `<slot>` may be
1314        `hint`, `warning`, `success` or `error` which match the
1315        corresponding keyword.
1316
1317color.showBranch::
1318        A boolean to enable/disable color in the output of
1319        linkgit:git-show-branch[1]. May be set to `always`,
1320        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1321        only when the output is to a terminal. If unset, then the
1322        value of `color.ui` is used (`auto` by default).
1323
1324color.status::
1325        A boolean to enable/disable color in the output of
1326        linkgit:git-status[1]. May be set to `always`,
1327        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1328        only when the output is to a terminal. If unset, then the
1329        value of `color.ui` is used (`auto` by default).
1330
1331color.status.<slot>::
1332        Use customized color for status colorization. `<slot>` is
1333        one of `header` (the header text of the status message),
1334        `added` or `updated` (files which are added but not committed),
1335        `changed` (files which are changed but not added in the index),
1336        `untracked` (files which are not tracked by Git),
1337        `branch` (the current branch),
1338        `nobranch` (the color the 'no branch' warning is shown in, defaulting
1339        to red),
1340        `localBranch` or `remoteBranch` (the local and remote branch names,
1341        respectively, when branch and tracking information is displayed in the
1342        status short-format), or
1343        `unmerged` (files which have unmerged changes).
1344
1345color.transport::
1346        A boolean to enable/disable color when pushes are rejected. May be
1347        set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1348        case colors are used only when the error output goes to a terminal.
1349        If unset, then the value of `color.ui` is used (`auto` by default).
1350
1351color.transport.rejected::
1352        Use customized color when a push was rejected.
1353
1354color.ui::
1355        This variable determines the default value for variables such
1356        as `color.diff` and `color.grep` that control the use of color
1357        per command family. Its scope will expand as more commands learn
1358        configuration to set a default for the `--color` option.  Set it
1359        to `false` or `never` if you prefer Git commands not to use
1360        color unless enabled explicitly with some other configuration
1361        or the `--color` option. Set it to `always` if you want all
1362        output not intended for machine consumption to use color, to
1363        `true` or `auto` (this is the default since Git 1.8.4) if you
1364        want such output to use color when written to the terminal.
1365
1366column.ui::
1367        Specify whether supported commands should output in columns.
1368        This variable consists of a list of tokens separated by spaces
1369        or commas:
1370+
1371These options control when the feature should be enabled
1372(defaults to 'never'):
1373+
1374--
1375`always`;;
1376        always show in columns
1377`never`;;
1378        never show in columns
1379`auto`;;
1380        show in columns if the output is to the terminal
1381--
1382+
1383These options control layout (defaults to 'column').  Setting any
1384of these implies 'always' if none of 'always', 'never', or 'auto' are
1385specified.
1386+
1387--
1388`column`;;
1389        fill columns before rows
1390`row`;;
1391        fill rows before columns
1392`plain`;;
1393        show in one column
1394--
1395+
1396Finally, these options can be combined with a layout option (defaults
1397to 'nodense'):
1398+
1399--
1400`dense`;;
1401        make unequal size columns to utilize more space
1402`nodense`;;
1403        make equal size columns
1404--
1405
1406column.branch::
1407        Specify whether to output branch listing in `git branch` in columns.
1408        See `column.ui` for details.
1409
1410column.clean::
1411        Specify the layout when list items in `git clean -i`, which always
1412        shows files and directories in columns. See `column.ui` for details.
1413
1414column.status::
1415        Specify whether to output untracked files in `git status` in columns.
1416        See `column.ui` for details.
1417
1418column.tag::
1419        Specify whether to output tag listing in `git tag` in columns.
1420        See `column.ui` for details.
1421
1422commit.cleanup::
1423        This setting overrides the default of the `--cleanup` option in
1424        `git commit`. See linkgit:git-commit[1] for details. Changing the
1425        default can be useful when you always want to keep lines that begin
1426        with comment character `#` in your log message, in which case you
1427        would do `git config commit.cleanup whitespace` (note that you will
1428        have to remove the help lines that begin with `#` in the commit log
1429        template yourself, if you do this).
1430
1431commit.gpgSign::
1432
1433        A boolean to specify whether all commits should be GPG signed.
1434        Use of this option when doing operations such as rebase can
1435        result in a large number of commits being signed. It may be
1436        convenient to use an agent to avoid typing your GPG passphrase
1437        several times.
1438
1439commit.status::
1440        A boolean to enable/disable inclusion of status information in the
1441        commit message template when using an editor to prepare the commit
1442        message.  Defaults to true.
1443
1444commit.template::
1445        Specify the pathname of a file to use as the template for
1446        new commit messages.
1447
1448commit.verbose::
1449        A boolean or int to specify the level of verbose with `git commit`.
1450        See linkgit:git-commit[1].
1451
1452credential.helper::
1453        Specify an external helper to be called when a username or
1454        password credential is needed; the helper may consult external
1455        storage to avoid prompting the user for the credentials. Note
1456        that multiple helpers may be defined. See linkgit:gitcredentials[7]
1457        for details.
1458
1459credential.useHttpPath::
1460        When acquiring credentials, consider the "path" component of an http
1461        or https URL to be important. Defaults to false. See
1462        linkgit:gitcredentials[7] for more information.
1463
1464credential.username::
1465        If no username is set for a network authentication, use this username
1466        by default. See credential.<context>.* below, and
1467        linkgit:gitcredentials[7].
1468
1469credential.<url>.*::
1470        Any of the credential.* options above can be applied selectively to
1471        some credentials. For example "credential.https://example.com.username"
1472        would set the default username only for https connections to
1473        example.com. See linkgit:gitcredentials[7] for details on how URLs are
1474        matched.
1475
1476credentialCache.ignoreSIGHUP::
1477        Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1478
1479completion.commands::
1480        This is only used by git-completion.bash to add or remove
1481        commands from the list of completed commands. Normally only
1482        porcelain commands and a few select others are completed. You
1483        can add more commands, separated by space, in this
1484        variable. Prefixing the command with '-' will remove it from
1485        the existing list.
1486
1487include::diff-config.txt[]
1488
1489difftool.<tool>.path::
1490        Override the path for the given tool.  This is useful in case
1491        your tool is not in the PATH.
1492
1493difftool.<tool>.cmd::
1494        Specify the command to invoke the specified diff tool.
1495        The specified command is evaluated in shell with the following
1496        variables available:  'LOCAL' is set to the name of the temporary
1497        file containing the contents of the diff pre-image and 'REMOTE'
1498        is set to the name of the temporary file containing the contents
1499        of the diff post-image.
1500
1501difftool.prompt::
1502        Prompt before each invocation of the diff tool.
1503
1504fastimport.unpackLimit::
1505        If the number of objects imported by linkgit:git-fast-import[1]
1506        is below this limit, then the objects will be unpacked into
1507        loose object files.  However if the number of imported objects
1508        equals or exceeds this limit then the pack will be stored as a
1509        pack.  Storing the pack from a fast-import can make the import
1510        operation complete faster, especially on slow filesystems.  If
1511        not set, the value of `transfer.unpackLimit` is used instead.
1512
1513fetch.recurseSubmodules::
1514        This option can be either set to a boolean value or to 'on-demand'.
1515        Setting it to a boolean changes the behavior of fetch and pull to
1516        unconditionally recurse into submodules when set to true or to not
1517        recurse at all when set to false. When set to 'on-demand' (the default
1518        value), fetch and pull will only recurse into a populated submodule
1519        when its superproject retrieves a commit that updates the submodule's
1520        reference.
1521
1522fetch.fsckObjects::
1523        If it is set to true, git-fetch-pack will check all fetched
1524        objects. See `transfer.fsckObjects` for what's
1525        checked. Defaults to false. If not set, the value of
1526        `transfer.fsckObjects` is used instead.
1527
1528fetch.fsck.<msg-id>::
1529        Acts like `fsck.<msg-id>`, but is used by
1530        linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1531        the `fsck.<msg-id>` documentation for details.
1532
1533fetch.fsck.skipList::
1534        Acts like `fsck.skipList`, but is used by
1535        linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
1536        the `fsck.skipList` documentation for details.
1537
1538fetch.unpackLimit::
1539        If the number of objects fetched over the Git native
1540        transfer is below this
1541        limit, then the objects will be unpacked into loose object
1542        files. However if the number of received objects equals or
1543        exceeds this limit then the received pack will be stored as
1544        a pack, after adding any missing delta bases.  Storing the
1545        pack from a push can make the push operation complete faster,
1546        especially on slow filesystems.  If not set, the value of
1547        `transfer.unpackLimit` is used instead.
1548
1549fetch.prune::
1550        If true, fetch will automatically behave as if the `--prune`
1551        option was given on the command line.  See also `remote.<name>.prune`
1552        and the PRUNING section of linkgit:git-fetch[1].
1553
1554fetch.pruneTags::
1555        If true, fetch will automatically behave as if the
1556        `refs/tags/*:refs/tags/*` refspec was provided when pruning,
1557        if not set already. This allows for setting both this option
1558        and `fetch.prune` to maintain a 1=1 mapping to upstream
1559        refs. See also `remote.<name>.pruneTags` and the PRUNING
1560        section of linkgit:git-fetch[1].
1561
1562fetch.output::
1563        Control how ref update status is printed. Valid values are
1564        `full` and `compact`. Default value is `full`. See section
1565        OUTPUT in linkgit:git-fetch[1] for detail.
1566
1567fetch.negotiationAlgorithm::
1568        Control how information about the commits in the local repository is
1569        sent when negotiating the contents of the packfile to be sent by the
1570        server. Set to "skipping" to use an algorithm that skips commits in an
1571        effort to converge faster, but may result in a larger-than-necessary
1572        packfile; The default is "default" which instructs Git to use the default algorithm
1573        that never skips commits (unless the server has acknowledged it or one
1574        of its descendants).
1575        Unknown values will cause 'git fetch' to error out.
1576+
1577See also the `--negotiation-tip` option for linkgit:git-fetch[1].
1578
1579format.attach::
1580        Enable multipart/mixed attachments as the default for
1581        'format-patch'.  The value can also be a double quoted string
1582        which will enable attachments as the default and set the
1583        value as the boundary.  See the --attach option in
1584        linkgit:git-format-patch[1].
1585
1586format.from::
1587        Provides the default value for the `--from` option to format-patch.
1588        Accepts a boolean value, or a name and email address.  If false,
1589        format-patch defaults to `--no-from`, using commit authors directly in
1590        the "From:" field of patch mails.  If true, format-patch defaults to
1591        `--from`, using your committer identity in the "From:" field of patch
1592        mails and including a "From:" field in the body of the patch mail if
1593        different.  If set to a non-boolean value, format-patch uses that
1594        value instead of your committer identity.  Defaults to false.
1595
1596format.numbered::
1597        A boolean which can enable or disable sequence numbers in patch
1598        subjects.  It defaults to "auto" which enables it only if there
1599        is more than one patch.  It can be enabled or disabled for all
1600        messages by setting it to "true" or "false".  See --numbered
1601        option in linkgit:git-format-patch[1].
1602
1603format.headers::
1604        Additional email headers to include in a patch to be submitted
1605        by mail.  See linkgit:git-format-patch[1].
1606
1607format.to::
1608format.cc::
1609        Additional recipients to include in a patch to be submitted
1610        by mail.  See the --to and --cc options in
1611        linkgit:git-format-patch[1].
1612
1613format.subjectPrefix::
1614        The default for format-patch is to output files with the '[PATCH]'
1615        subject prefix. Use this variable to change that prefix.
1616
1617format.signature::
1618        The default for format-patch is to output a signature containing
1619        the Git version number. Use this variable to change that default.
1620        Set this variable to the empty string ("") to suppress
1621        signature generation.
1622
1623format.signatureFile::
1624        Works just like format.signature except the contents of the
1625        file specified by this variable will be used as the signature.
1626
1627format.suffix::
1628        The default for format-patch is to output files with the suffix
1629        `.patch`. Use this variable to change that suffix (make sure to
1630        include the dot if you want it).
1631
1632format.pretty::
1633        The default pretty format for log/show/whatchanged command,
1634        See linkgit:git-log[1], linkgit:git-show[1],
1635        linkgit:git-whatchanged[1].
1636
1637format.thread::
1638        The default threading style for 'git format-patch'.  Can be
1639        a boolean value, or `shallow` or `deep`.  `shallow` threading
1640        makes every mail a reply to the head of the series,
1641        where the head is chosen from the cover letter, the
1642        `--in-reply-to`, and the first patch mail, in this order.
1643        `deep` threading makes every mail a reply to the previous one.
1644        A true boolean value is the same as `shallow`, and a false
1645        value disables threading.
1646
1647format.signOff::
1648        A boolean value which lets you enable the `-s/--signoff` option of
1649        format-patch by default. *Note:* Adding the Signed-off-by: line to a
1650        patch should be a conscious act and means that you certify you have
1651        the rights to submit this work under the same open source license.
1652        Please see the 'SubmittingPatches' document for further discussion.
1653
1654format.coverLetter::
1655        A boolean that controls whether to generate a cover-letter when
1656        format-patch is invoked, but in addition can be set to "auto", to
1657        generate a cover-letter only when there's more than one patch.
1658
1659format.outputDirectory::
1660        Set a custom directory to store the resulting files instead of the
1661        current working directory.
1662
1663format.useAutoBase::
1664        A boolean value which lets you enable the `--base=auto` option of
1665        format-patch by default.
1666
1667filter.<driver>.clean::
1668        The command which is used to convert the content of a worktree
1669        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1670        details.
1671
1672filter.<driver>.smudge::
1673        The command which is used to convert the content of a blob
1674        object to a worktree file upon checkout.  See
1675        linkgit:gitattributes[5] for details.
1676
1677fsck.<msg-id>::
1678        During fsck git may find issues with legacy data which
1679        wouldn't be generated by current versions of git, and which
1680        wouldn't be sent over the wire if `transfer.fsckObjects` was
1681        set. This feature is intended to support working with legacy
1682        repositories containing such data.
1683+
1684Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1685to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1686to clone or fetch it set `fetch.fsck.<msg-id>`.
1687+
1688The rest of the documentation discusses `fsck.*` for brevity, but the
1689same applies for the corresponding `receive.fsck.*` and
1690`fetch.<msg-id>.*`. variables.
1691+
1692Unlike variables like `color.ui` and `core.editor` the
1693`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1694fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1695uniformly configure the same fsck settings in different circumstances
1696all three of them they must all set to the same values.
1697+
1698When `fsck.<msg-id>` is set, errors can be switched to warnings and
1699vice versa by configuring the `fsck.<msg-id>` setting where the
1700`<msg-id>` is the fsck message ID and the value is one of `error`,
1701`warn` or `ignore`. For convenience, fsck prefixes the error/warning
1702with the message ID, e.g. "missingEmail: invalid author/committer line
1703- missing email" means that setting `fsck.missingEmail = ignore` will
1704hide that issue.
1705+
1706In general, it is better to enumerate existing objects with problems
1707with `fsck.skipList`, instead of listing the kind of breakages these
1708problematic objects share to be ignored, as doing the latter will
1709allow new instances of the same breakages go unnoticed.
1710+
1711Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1712doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1713will only cause git to warn.
1714
1715fsck.skipList::
1716        The path to a sorted list of object names (i.e. one SHA-1 per
1717        line) that are known to be broken in a non-fatal way and should
1718        be ignored. This feature is useful when an established project
1719        should be accepted despite early commits containing errors that
1720        can be safely ignored such as invalid committer email addresses.
1721        Note: corrupt objects cannot be skipped with this setting.
1722+
1723Like `fsck.<msg-id>` this variable has corresponding
1724`receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1725+
1726Unlike variables like `color.ui` and `core.editor` the
1727`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1728fall back on the `fsck.skipList` configuration if they aren't set. To
1729uniformly configure the same fsck settings in different circumstances
1730all three of them they must all set to the same values.
1731
1732gc.aggressiveDepth::
1733        The depth parameter used in the delta compression
1734        algorithm used by 'git gc --aggressive'.  This defaults
1735        to 50.
1736
1737gc.aggressiveWindow::
1738        The window size parameter used in the delta compression
1739        algorithm used by 'git gc --aggressive'.  This defaults
1740        to 250.
1741
1742gc.auto::
1743        When there are approximately more than this many loose
1744        objects in the repository, `git gc --auto` will pack them.
1745        Some Porcelain commands use this command to perform a
1746        light-weight garbage collection from time to time.  The
1747        default value is 6700.  Setting this to 0 disables it.
1748
1749gc.autoPackLimit::
1750        When there are more than this many packs that are not
1751        marked with `*.keep` file in the repository, `git gc
1752        --auto` consolidates them into one larger pack.  The
1753        default value is 50.  Setting this to 0 disables it.
1754
1755gc.autoDetach::
1756        Make `git gc --auto` return immediately and run in background
1757        if the system supports it. Default is true.
1758
1759gc.bigPackThreshold::
1760        If non-zero, all packs larger than this limit are kept when
1761        `git gc` is run. This is very similar to `--keep-base-pack`
1762        except that all packs that meet the threshold are kept, not
1763        just the base pack. Defaults to zero. Common unit suffixes of
1764        'k', 'm', or 'g' are supported.
1765+
1766Note that if the number of kept packs is more than gc.autoPackLimit,
1767this configuration variable is ignored, all packs except the base pack
1768will be repacked. After this the number of packs should go below
1769gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1770
1771gc.logExpiry::
1772        If the file gc.log exists, then `git gc --auto` won't run
1773        unless that file is more than 'gc.logExpiry' old.  Default is
1774        "1.day".  See `gc.pruneExpire` for more ways to specify its
1775        value.
1776
1777gc.packRefs::
1778        Running `git pack-refs` in a repository renders it
1779        unclonable by Git versions prior to 1.5.1.2 over dumb
1780        transports such as HTTP.  This variable determines whether
1781        'git gc' runs `git pack-refs`. This can be set to `notbare`
1782        to enable it within all non-bare repos or it can be set to a
1783        boolean value.  The default is `true`.
1784
1785gc.pruneExpire::
1786        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1787        Override the grace period with this config variable.  The value
1788        "now" may be used to disable this grace period and always prune
1789        unreachable objects immediately, or "never" may be used to
1790        suppress pruning.  This feature helps prevent corruption when
1791        'git gc' runs concurrently with another process writing to the
1792        repository; see the "NOTES" section of linkgit:git-gc[1].
1793
1794gc.worktreePruneExpire::
1795        When 'git gc' is run, it calls
1796        'git worktree prune --expire 3.months.ago'.
1797        This config variable can be used to set a different grace
1798        period. The value "now" may be used to disable the grace
1799        period and prune `$GIT_DIR/worktrees` immediately, or "never"
1800        may be used to suppress pruning.
1801
1802gc.reflogExpire::
1803gc.<pattern>.reflogExpire::
1804        'git reflog expire' removes reflog entries older than
1805        this time; defaults to 90 days. The value "now" expires all
1806        entries immediately, and "never" suppresses expiration
1807        altogether. With "<pattern>" (e.g.
1808        "refs/stash") in the middle the setting applies only to
1809        the refs that match the <pattern>.
1810
1811gc.reflogExpireUnreachable::
1812gc.<pattern>.reflogExpireUnreachable::
1813        'git reflog expire' removes reflog entries older than
1814        this time and are not reachable from the current tip;
1815        defaults to 30 days. The value "now" expires all entries
1816        immediately, and "never" suppresses expiration altogether.
1817        With "<pattern>" (e.g. "refs/stash")
1818        in the middle, the setting applies only to the refs that
1819        match the <pattern>.
1820
1821gc.rerereResolved::
1822        Records of conflicted merge you resolved earlier are
1823        kept for this many days when 'git rerere gc' is run.
1824        You can also use more human-readable "1.month.ago", etc.
1825        The default is 60 days.  See linkgit:git-rerere[1].
1826
1827gc.rerereUnresolved::
1828        Records of conflicted merge you have not resolved are
1829        kept for this many days when 'git rerere gc' is run.
1830        You can also use more human-readable "1.month.ago", etc.
1831        The default is 15 days.  See linkgit:git-rerere[1].
1832
1833gitcvs.commitMsgAnnotation::
1834        Append this string to each commit message. Set to empty string
1835        to disable this feature. Defaults to "via git-CVS emulator".
1836
1837gitcvs.enabled::
1838        Whether the CVS server interface is enabled for this repository.
1839        See linkgit:git-cvsserver[1].
1840
1841gitcvs.logFile::
1842        Path to a log file where the CVS server interface well... logs
1843        various stuff. See linkgit:git-cvsserver[1].
1844
1845gitcvs.usecrlfattr::
1846        If true, the server will look up the end-of-line conversion
1847        attributes for files to determine the `-k` modes to use. If
1848        the attributes force Git to treat a file as text,
1849        the `-k` mode will be left blank so CVS clients will
1850        treat it as text. If they suppress text conversion, the file
1851        will be set with '-kb' mode, which suppresses any newline munging
1852        the client might otherwise do. If the attributes do not allow
1853        the file type to be determined, then `gitcvs.allBinary` is
1854        used. See linkgit:gitattributes[5].
1855
1856gitcvs.allBinary::
1857        This is used if `gitcvs.usecrlfattr` does not resolve
1858        the correct '-kb' mode to use. If true, all
1859        unresolved files are sent to the client in
1860        mode '-kb'. This causes the client to treat them
1861        as binary files, which suppresses any newline munging it
1862        otherwise might do. Alternatively, if it is set to "guess",
1863        then the contents of the file are examined to decide if
1864        it is binary, similar to `core.autocrlf`.
1865
1866gitcvs.dbName::
1867        Database used by git-cvsserver to cache revision information
1868        derived from the Git repository. The exact meaning depends on the
1869        used database driver, for SQLite (which is the default driver) this
1870        is a filename. Supports variable substitution (see
1871        linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`).
1872        Default: '%Ggitcvs.%m.sqlite'
1873
1874gitcvs.dbDriver::
1875        Used Perl DBI driver. You can specify any available driver
1876        for this here, but it might not work. git-cvsserver is tested
1877        with 'DBD::SQLite', reported to work with 'DBD::Pg', and
1878        reported *not* to work with 'DBD::mysql'. Experimental feature.
1879        May not contain double colons (`:`). Default: 'SQLite'.
1880        See linkgit:git-cvsserver[1].
1881
1882gitcvs.dbUser, gitcvs.dbPass::
1883        Database user and password. Only useful if setting `gitcvs.dbDriver`,
1884        since SQLite has no concept of database users and/or passwords.
1885        'gitcvs.dbUser' supports variable substitution (see
1886        linkgit:git-cvsserver[1] for details).
1887
1888gitcvs.dbTableNamePrefix::
1889        Database table name prefix.  Prepended to the names of any
1890        database tables used, allowing a single database to be used
1891        for several repositories.  Supports variable substitution (see
1892        linkgit:git-cvsserver[1] for details).  Any non-alphabetic
1893        characters will be replaced with underscores.
1894
1895All gitcvs variables except for `gitcvs.usecrlfattr` and
1896`gitcvs.allBinary` can also be specified as
1897'gitcvs.<access_method>.<varname>' (where 'access_method'
1898is one of "ext" and "pserver") to make them apply only for the given
1899access method.
1900
1901gitweb.category::
1902gitweb.description::
1903gitweb.owner::
1904gitweb.url::
1905        See linkgit:gitweb[1] for description.
1906
1907gitweb.avatar::
1908gitweb.blame::
1909gitweb.grep::
1910gitweb.highlight::
1911gitweb.patches::
1912gitweb.pickaxe::
1913gitweb.remote_heads::
1914gitweb.showSizes::
1915gitweb.snapshot::
1916        See linkgit:gitweb.conf[5] for description.
1917
1918grep.lineNumber::
1919        If set to true, enable `-n` option by default.
1920
1921grep.column::
1922        If set to true, enable the `--column` option by default.
1923
1924grep.patternType::
1925        Set the default matching behavior. Using a value of 'basic', 'extended',
1926        'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1927        `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1928        value 'default' will return to the default matching behavior.
1929
1930grep.extendedRegexp::
1931        If set to true, enable `--extended-regexp` option by default. This
1932        option is ignored when the `grep.patternType` option is set to a value
1933        other than 'default'.
1934
1935grep.threads::
1936        Number of grep worker threads to use.
1937        See `grep.threads` in linkgit:git-grep[1] for more information.
1938
1939grep.fallbackToNoIndex::
1940        If set to true, fall back to git grep --no-index if git grep
1941        is executed outside of a git repository.  Defaults to false.
1942
1943gpg.program::
1944        Use this custom program instead of "`gpg`" found on `$PATH` when
1945        making or verifying a PGP signature. The program must support the
1946        same command-line interface as GPG, namely, to verify a detached
1947        signature, "`gpg --verify $file - <$signature`" is run, and the
1948        program is expected to signal a good signature by exiting with
1949        code 0, and to generate an ASCII-armored detached signature, the
1950        standard input of "`gpg -bsau $key`" is fed with the contents to be
1951        signed, and the program is expected to send the result to its
1952        standard output.
1953
1954gpg.format::
1955        Specifies which key format to use when signing with `--gpg-sign`.
1956        Default is "openpgp" and another possible value is "x509".
1957
1958gpg.<format>.program::
1959        Use this to customize the program used for the signing format you
1960        chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1961        be used as a legacy synonym for `gpg.openpgp.program`. The default
1962        value for `gpg.x509.program` is "gpgsm".
1963
1964gui.commitMsgWidth::
1965        Defines how wide the commit message window is in the
1966        linkgit:git-gui[1]. "75" is the default.
1967
1968gui.diffContext::
1969        Specifies how many context lines should be used in calls to diff
1970        made by the linkgit:git-gui[1]. The default is "5".
1971
1972gui.displayUntracked::
1973        Determines if linkgit:git-gui[1] shows untracked files
1974        in the file list. The default is "true".
1975
1976gui.encoding::
1977        Specifies the default encoding to use for displaying of
1978        file contents in linkgit:git-gui[1] and linkgit:gitk[1].
1979        It can be overridden by setting the 'encoding' attribute
1980        for relevant files (see linkgit:gitattributes[5]).
1981        If this option is not set, the tools default to the
1982        locale encoding.
1983
1984gui.matchTrackingBranch::
1985        Determines if new branches created with linkgit:git-gui[1] should
1986        default to tracking remote branches with matching names or
1987        not. Default: "false".
1988
1989gui.newBranchTemplate::
1990        Is used as suggested name when creating new branches using the
1991        linkgit:git-gui[1].
1992
1993gui.pruneDuringFetch::
1994        "true" if linkgit:git-gui[1] should prune remote-tracking branches when
1995        performing a fetch. The default value is "false".
1996
1997gui.trustmtime::
1998        Determines if linkgit:git-gui[1] should trust the file modification
1999        timestamp or not. By default the timestamps are not trusted.
2000
2001gui.spellingDictionary::
2002        Specifies the dictionary used for spell checking commit messages in
2003        the linkgit:git-gui[1]. When set to "none" spell checking is turned
2004        off.
2005
2006gui.fastCopyBlame::
2007        If true, 'git gui blame' uses `-C` instead of `-C -C` for original
2008        location detection. It makes blame significantly faster on huge
2009        repositories at the expense of less thorough copy detection.
2010
2011gui.copyBlameThreshold::
2012        Specifies the threshold to use in 'git gui blame' original location
2013        detection, measured in alphanumeric characters. See the
2014        linkgit:git-blame[1] manual for more information on copy detection.
2015
2016gui.blamehistoryctx::
2017        Specifies the radius of history context in days to show in
2018        linkgit:gitk[1] for the selected commit, when the `Show History
2019        Context` menu item is invoked from 'git gui blame'. If this
2020        variable is set to zero, the whole history is shown.
2021
2022guitool.<name>.cmd::
2023        Specifies the shell command line to execute when the corresponding item
2024        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
2025        mandatory for every tool. The command is executed from the root of
2026        the working directory, and in the environment it receives the name of
2027        the tool as `GIT_GUITOOL`, the name of the currently selected file as
2028        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
2029        the head is detached, 'CUR_BRANCH' is empty).
2030
2031guitool.<name>.needsFile::
2032        Run the tool only if a diff is selected in the GUI. It guarantees
2033        that 'FILENAME' is not empty.
2034
2035guitool.<name>.noConsole::
2036        Run the command silently, without creating a window to display its
2037        output.
2038
2039guitool.<name>.noRescan::
2040        Don't rescan the working directory for changes after the tool
2041        finishes execution.
2042
2043guitool.<name>.confirm::
2044        Show a confirmation dialog before actually running the tool.
2045
2046guitool.<name>.argPrompt::
2047        Request a string argument from the user, and pass it to the tool
2048        through the `ARGS` environment variable. Since requesting an
2049        argument implies confirmation, the 'confirm' option has no effect
2050        if this is enabled. If the option is set to 'true', 'yes', or '1',
2051        the dialog uses a built-in generic prompt; otherwise the exact
2052        value of the variable is used.
2053
2054guitool.<name>.revPrompt::
2055        Request a single valid revision from the user, and set the
2056        `REVISION` environment variable. In other aspects this option
2057        is similar to 'argPrompt', and can be used together with it.
2058
2059guitool.<name>.revUnmerged::
2060        Show only unmerged branches in the 'revPrompt' subdialog.
2061        This is useful for tools similar to merge or rebase, but not
2062        for things like checkout or reset.
2063
2064guitool.<name>.title::
2065        Specifies the title to use for the prompt dialog. The default
2066        is the tool name.
2067
2068guitool.<name>.prompt::
2069        Specifies the general prompt string to display at the top of
2070        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
2071        The default value includes the actual command.
2072
2073help.browser::
2074        Specify the browser that will be used to display help in the
2075        'web' format. See linkgit:git-help[1].
2076
2077help.format::
2078        Override the default help format used by linkgit:git-help[1].
2079        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
2080        the default. 'web' and 'html' are the same.
2081
2082help.autoCorrect::
2083        Automatically correct and execute mistyped commands after
2084        waiting for the given number of deciseconds (0.1 sec). If more
2085        than one command can be deduced from the entered text, nothing
2086        will be executed.  If the value of this option is negative,
2087        the corrected command will be executed immediately. If the
2088        value is 0 - the command will be just shown but not executed.
2089        This is the default.
2090
2091help.htmlPath::
2092        Specify the path where the HTML documentation resides. File system paths
2093        and URLs are supported. HTML pages will be prefixed with this path when
2094        help is displayed in the 'web' format. This defaults to the documentation
2095        path of your Git installation.
2096
2097http.proxy::
2098        Override the HTTP proxy, normally configured using the 'http_proxy',
2099        'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
2100        addition to the syntax understood by curl, it is possible to specify a
2101        proxy string with a user name but no password, in which case git will
2102        attempt to acquire one in the same way it does for other credentials. See
2103        linkgit:gitcredentials[7] for more information. The syntax thus is
2104        '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
2105        on a per-remote basis; see remote.<name>.proxy
2106
2107http.proxyAuthMethod::
2108        Set the method with which to authenticate against the HTTP proxy. This
2109        only takes effect if the configured proxy string contains a user name part
2110        (i.e. is of the form 'user@host' or 'user@host:port'). This can be
2111        overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
2112        Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
2113        variable.  Possible values are:
2114+
2115--
2116* `anyauth` - Automatically pick a suitable authentication method. It is
2117  assumed that the proxy answers an unauthenticated request with a 407
2118  status code and one or more Proxy-authenticate headers with supported
2119  authentication methods. This is the default.
2120* `basic` - HTTP Basic authentication
2121* `digest` - HTTP Digest authentication; this prevents the password from being
2122  transmitted to the proxy in clear text
2123* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
2124  of `curl(1)`)
2125* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
2126--
2127
2128http.emptyAuth::
2129        Attempt authentication without seeking a username or password.  This
2130        can be used to attempt GSS-Negotiate authentication without specifying
2131        a username in the URL, as libcurl normally requires a username for
2132        authentication.
2133
2134http.delegation::
2135        Control GSSAPI credential delegation. The delegation is disabled
2136        by default in libcurl since version 7.21.7. Set parameter to tell
2137        the server what it is allowed to delegate when it comes to user
2138        credentials. Used with GSS/kerberos. Possible values are:
2139+
2140--
2141* `none` - Don't allow any delegation.
2142* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
2143  Kerberos service ticket, which is a matter of realm policy.
2144* `always` - Unconditionally allow the server to delegate.
2145--
2146
2147
2148http.extraHeader::
2149        Pass an additional HTTP header when communicating with a server.  If
2150        more than one such entry exists, all of them are added as extra
2151        headers.  To allow overriding the settings inherited from the system
2152        config, an empty value will reset the extra headers to the empty list.
2153
2154http.cookieFile::
2155        The pathname of a file containing previously stored cookie lines,
2156        which should be used
2157        in the Git http session, if they match the server. The file format
2158        of the file to read cookies from should be plain HTTP headers or
2159        the Netscape/Mozilla cookie file format (see `curl(1)`).
2160        NOTE that the file specified with http.cookieFile is used only as
2161        input unless http.saveCookies is set.
2162
2163http.saveCookies::
2164        If set, store cookies received during requests to the file specified by
2165        http.cookieFile. Has no effect if http.cookieFile is unset.
2166
2167http.sslVersion::
2168        The SSL version to use when negotiating an SSL connection, if you
2169        want to force the default.  The available and default version
2170        depend on whether libcurl was built against NSS or OpenSSL and the
2171        particular configuration of the crypto library in use. Internally
2172        this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
2173        documentation for more details on the format of this option and
2174        for the ssl version supported. Actually the possible values of
2175        this option are:
2176
2177        - sslv2
2178        - sslv3
2179        - tlsv1
2180        - tlsv1.0
2181        - tlsv1.1
2182        - tlsv1.2
2183        - tlsv1.3
2184
2185+
2186Can be overridden by the `GIT_SSL_VERSION` environment variable.
2187To force git to use libcurl's default ssl version and ignore any
2188explicit http.sslversion option, set `GIT_SSL_VERSION` to the
2189empty string.
2190
2191http.sslCipherList::
2192  A list of SSL ciphers to use when negotiating an SSL connection.
2193  The available ciphers depend on whether libcurl was built against
2194  NSS or OpenSSL and the particular configuration of the crypto
2195  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
2196  option; see the libcurl documentation for more details on the format
2197  of this list.
2198+
2199Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
2200To force git to use libcurl's default cipher list and ignore any
2201explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
2202empty string.
2203
2204http.sslVerify::
2205        Whether to verify the SSL certificate when fetching or pushing
2206        over HTTPS. Defaults to true. Can be overridden by the
2207        `GIT_SSL_NO_VERIFY` environment variable.
2208
2209http.sslCert::
2210        File containing the SSL certificate when fetching or pushing
2211        over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
2212        variable.
2213
2214http.sslKey::
2215        File containing the SSL private key when fetching or pushing
2216        over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
2217        variable.
2218
2219http.sslCertPasswordProtected::
2220        Enable Git's password prompt for the SSL certificate.  Otherwise
2221        OpenSSL will prompt the user, possibly many times, if the
2222        certificate or private key is encrypted.  Can be overridden by the
2223        `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
2224
2225http.sslCAInfo::
2226        File containing the certificates to verify the peer with when
2227        fetching or pushing over HTTPS. Can be overridden by the
2228        `GIT_SSL_CAINFO` environment variable.
2229
2230http.sslCAPath::
2231        Path containing files with the CA certificates to verify the peer
2232        with when fetching or pushing over HTTPS. Can be overridden
2233        by the `GIT_SSL_CAPATH` environment variable.
2234
2235http.pinnedpubkey::
2236        Public key of the https service. It may either be the filename of
2237        a PEM or DER encoded public key file or a string starting with
2238        'sha256//' followed by the base64 encoded sha256 hash of the
2239        public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
2240        exit with an error if this option is set but not supported by
2241        cURL.
2242
2243http.sslTry::
2244        Attempt to use AUTH SSL/TLS and encrypted data transfers
2245        when connecting via regular FTP protocol. This might be needed
2246        if the FTP server requires it for security reasons or you wish
2247        to connect securely whenever remote FTP server supports it.
2248        Default is false since it might trigger certificate verification
2249        errors on misconfigured servers.
2250
2251http.maxRequests::
2252        How many HTTP requests to launch in parallel. Can be overridden
2253        by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
2254
2255http.minSessions::
2256        The number of curl sessions (counted across slots) to be kept across
2257        requests. They will not be ended with curl_easy_cleanup() until
2258        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
2259        value will be capped at 1. Defaults to 1.
2260
2261http.postBuffer::
2262        Maximum size in bytes of the buffer used by smart HTTP
2263        transports when POSTing data to the remote system.
2264        For requests larger than this buffer size, HTTP/1.1 and
2265        Transfer-Encoding: chunked is used to avoid creating a
2266        massive pack file locally.  Default is 1 MiB, which is
2267        sufficient for most requests.
2268
2269http.lowSpeedLimit, http.lowSpeedTime::
2270        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
2271        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
2272        Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
2273        `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2274
2275http.noEPSV::
2276        A boolean which disables using of EPSV ftp command by curl.
2277        This can helpful with some "poor" ftp servers which don't
2278        support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2279        environment variable. Default is false (curl will use EPSV).
2280
2281http.userAgent::
2282        The HTTP USER_AGENT string presented to an HTTP server.  The default
2283        value represents the version of the client Git such as git/1.7.1.
2284        This option allows you to override this value to a more common value
2285        such as Mozilla/4.0.  This may be necessary, for instance, if
2286        connecting through a firewall that restricts HTTP connections to a set
2287        of common USER_AGENT strings (but not including those like git/1.7.1).
2288        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2289
2290http.followRedirects::
2291        Whether git should follow HTTP redirects. If set to `true`, git
2292        will transparently follow any redirect issued by a server it
2293        encounters. If set to `false`, git will treat all redirects as
2294        errors. If set to `initial`, git will follow redirects only for
2295        the initial request to a remote, but not for subsequent
2296        follow-up HTTP requests. Since git uses the redirected URL as
2297        the base for the follow-up requests, this is generally
2298        sufficient. The default is `initial`.
2299
2300http.<url>.*::
2301        Any of the http.* options above can be applied selectively to some URLs.
2302        For a config key to match a URL, each element of the config key is
2303        compared to that of the URL, in the following order:
2304+
2305--
2306. Scheme (e.g., `https` in `https://example.com/`). This field
2307  must match exactly between the config key and the URL.
2308
2309. Host/domain name (e.g., `example.com` in `https://example.com/`).
2310  This field must match between the config key and the URL. It is
2311  possible to specify a `*` as part of the host name to match all subdomains
2312  at this level. `https://*.example.com/` for example would match
2313  `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2314
2315. Port number (e.g., `8080` in `http://example.com:8080/`).
2316  This field must match exactly between the config key and the URL.
2317  Omitted port numbers are automatically converted to the correct
2318  default for the scheme before matching.
2319
2320. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2321  path field of the config key must match the path field of the URL
2322  either exactly or as a prefix of slash-delimited path elements.  This means
2323  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
2324  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
2325  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2326  key with just path `foo/`).
2327
2328. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2329  the config key has a user name it must match the user name in the
2330  URL exactly. If the config key does not have a user name, that
2331  config key will match a URL with any user name (including none),
2332  but at a lower precedence than a config key with a user name.
2333--
2334+
2335The list above is ordered by decreasing precedence; a URL that matches
2336a config key's path is preferred to one that matches its user name. For example,
2337if the URL is `https://user@example.com/foo/bar` a config key match of
2338`https://example.com/foo` will be preferred over a config key match of
2339`https://user@example.com`.
2340+
2341All URLs are normalized before attempting any matching (the password part,
2342if embedded in the URL, is always ignored for matching purposes) so that
2343equivalent URLs that are simply spelled differently will match properly.
2344Environment variable settings always override any matches.  The URLs that are
2345matched against are those given directly to Git commands.  This means any URLs
2346visited as a result of a redirection do not participate in matching.
2347
2348ssh.variant::
2349        By default, Git determines the command line arguments to use
2350        based on the basename of the configured SSH command (configured
2351        using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2352        the config setting `core.sshCommand`). If the basename is
2353        unrecognized, Git will attempt to detect support of OpenSSH
2354        options by first invoking the configured SSH command with the
2355        `-G` (print configuration) option and will subsequently use
2356        OpenSSH options (if that is successful) or no options besides
2357        the host and remote command (if it fails).
2358+
2359The config variable `ssh.variant` can be set to override this detection.
2360Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2361`tortoiseplink`, `simple` (no options except the host and remote command).
2362The default auto-detection can be explicitly requested using the value
2363`auto`.  Any other value is treated as `ssh`.  This setting can also be
2364overridden via the environment variable `GIT_SSH_VARIANT`.
2365+
2366The current command-line parameters used for each variant are as
2367follows:
2368+
2369--
2370
2371* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2372
2373* `simple` - [username@]host command
2374
2375* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2376
2377* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2378
2379--
2380+
2381Except for the `simple` variant, command-line parameters are likely to
2382change as git gains new features.
2383
2384i18n.commitEncoding::
2385        Character encoding the commit messages are stored in; Git itself
2386        does not care per se, but this information is necessary e.g. when
2387        importing commits from emails or in the gitk graphical history
2388        browser (and possibly at other places in the future or in other
2389        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2390
2391i18n.logOutputEncoding::
2392        Character encoding the commit messages are converted to when
2393        running 'git log' and friends.
2394
2395imap::
2396        The configuration variables in the 'imap' section are described
2397        in linkgit:git-imap-send[1].
2398
2399index.version::
2400        Specify the version with which new index files should be
2401        initialized.  This does not affect existing repositories.
2402
2403init.templateDir::
2404        Specify the directory from which templates will be copied.
2405        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2406
2407instaweb.browser::
2408        Specify the program that will be used to browse your working
2409        repository in gitweb. See linkgit:git-instaweb[1].
2410
2411instaweb.httpd::
2412        The HTTP daemon command-line to start gitweb on your working
2413        repository. See linkgit:git-instaweb[1].
2414
2415instaweb.local::
2416        If true the web server started by linkgit:git-instaweb[1] will
2417        be bound to the local IP (127.0.0.1).
2418
2419instaweb.modulePath::
2420        The default module path for linkgit:git-instaweb[1] to use
2421        instead of /usr/lib/apache2/modules.  Only used if httpd
2422        is Apache.
2423
2424instaweb.port::
2425        The port number to bind the gitweb httpd to. See
2426        linkgit:git-instaweb[1].
2427
2428interactive.singleKey::
2429        In interactive commands, allow the user to provide one-letter
2430        input with a single key (i.e., without hitting enter).
2431        Currently this is used by the `--patch` mode of
2432        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2433        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2434        setting is silently ignored if portable keystroke input
2435        is not available; requires the Perl module Term::ReadKey.
2436
2437interactive.diffFilter::
2438        When an interactive command (such as `git add --patch`) shows
2439        a colorized diff, git will pipe the diff through the shell
2440        command defined by this configuration variable. The command may
2441        mark up the diff further for human consumption, provided that it
2442        retains a one-to-one correspondence with the lines in the
2443        original diff. Defaults to disabled (no filtering).
2444
2445log.abbrevCommit::
2446        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2447        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2448        override this option with `--no-abbrev-commit`.
2449
2450log.date::
2451        Set the default date-time mode for the 'log' command.
2452        Setting a value for log.date is similar to using 'git log''s
2453        `--date` option.  See linkgit:git-log[1] for details.
2454
2455log.decorate::
2456        Print out the ref names of any commits that are shown by the log
2457        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2458        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2459        specified, the full ref name (including prefix) will be printed.
2460        If 'auto' is specified, then if the output is going to a terminal,
2461        the ref names are shown as if 'short' were given, otherwise no ref
2462        names are shown. This is the same as the `--decorate` option
2463        of the `git log`.
2464
2465log.follow::
2466        If `true`, `git log` will act as if the `--follow` option was used when
2467        a single <path> is given.  This has the same limitations as `--follow`,
2468        i.e. it cannot be used to follow multiple files and does not work well
2469        on non-linear history.
2470
2471log.graphColors::
2472        A list of colors, separated by commas, that can be used to draw
2473        history lines in `git log --graph`.
2474
2475log.showRoot::
2476        If true, the initial commit will be shown as a big creation event.
2477        This is equivalent to a diff against an empty tree.
2478        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2479        normally hide the root commit will now show it. True by default.
2480
2481log.showSignature::
2482        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2483        linkgit:git-whatchanged[1] assume `--show-signature`.
2484
2485log.mailmap::
2486        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2487        linkgit:git-whatchanged[1] assume `--use-mailmap`.
2488
2489mailinfo.scissors::
2490        If true, makes linkgit:git-mailinfo[1] (and therefore
2491        linkgit:git-am[1]) act by default as if the --scissors option
2492        was provided on the command-line. When active, this features
2493        removes everything from the message body before a scissors
2494        line (i.e. consisting mainly of ">8", "8<" and "-").
2495
2496mailmap.file::
2497        The location of an augmenting mailmap file. The default
2498        mailmap, located in the root of the repository, is loaded
2499        first, then the mailmap file pointed to by this variable.
2500        The location of the mailmap file may be in a repository
2501        subdirectory, or somewhere outside of the repository itself.
2502        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2503
2504mailmap.blob::
2505        Like `mailmap.file`, but consider the value as a reference to a
2506        blob in the repository. If both `mailmap.file` and
2507        `mailmap.blob` are given, both are parsed, with entries from
2508        `mailmap.file` taking precedence. In a bare repository, this
2509        defaults to `HEAD:.mailmap`. In a non-bare repository, it
2510        defaults to empty.
2511
2512man.viewer::
2513        Specify the programs that may be used to display help in the
2514        'man' format. See linkgit:git-help[1].
2515
2516man.<tool>.cmd::
2517        Specify the command to invoke the specified man viewer. The
2518        specified command is evaluated in shell with the man page
2519        passed as argument. (See linkgit:git-help[1].)
2520
2521man.<tool>.path::
2522        Override the path for the given tool that may be used to
2523        display help in the 'man' format. See linkgit:git-help[1].
2524
2525include::merge-config.txt[]
2526
2527mergetool.<tool>.path::
2528        Override the path for the given tool.  This is useful in case
2529        your tool is not in the PATH.
2530
2531mergetool.<tool>.cmd::
2532        Specify the command to invoke the specified merge tool.  The
2533        specified command is evaluated in shell with the following
2534        variables available: 'BASE' is the name of a temporary file
2535        containing the common base of the files to be merged, if available;
2536        'LOCAL' is the name of a temporary file containing the contents of
2537        the file on the current branch; 'REMOTE' is the name of a temporary
2538        file containing the contents of the file from the branch being
2539        merged; 'MERGED' contains the name of the file to which the merge
2540        tool should write the results of a successful merge.
2541
2542mergetool.<tool>.trustExitCode::
2543        For a custom merge command, specify whether the exit code of
2544        the merge command can be used to determine whether the merge was
2545        successful.  If this is not set to true then the merge target file
2546        timestamp is checked and the merge assumed to have been successful
2547        if the file has been updated, otherwise the user is prompted to
2548        indicate the success of the merge.
2549
2550mergetool.meld.hasOutput::
2551        Older versions of `meld` do not support the `--output` option.
2552        Git will attempt to detect whether `meld` supports `--output`
2553        by inspecting the output of `meld --help`.  Configuring
2554        `mergetool.meld.hasOutput` will make Git skip these checks and
2555        use the configured value instead.  Setting `mergetool.meld.hasOutput`
2556        to `true` tells Git to unconditionally use the `--output` option,
2557        and `false` avoids using `--output`.
2558
2559mergetool.keepBackup::
2560        After performing a merge, the original file with conflict markers
2561        can be saved as a file with a `.orig` extension.  If this variable
2562        is set to `false` then this file is not preserved.  Defaults to
2563        `true` (i.e. keep the backup files).
2564
2565mergetool.keepTemporaries::
2566        When invoking a custom merge tool, Git uses a set of temporary
2567        files to pass to the tool. If the tool returns an error and this
2568        variable is set to `true`, then these temporary files will be
2569        preserved, otherwise they will be removed after the tool has
2570        exited. Defaults to `false`.
2571
2572mergetool.writeToTemp::
2573        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2574        conflicting files in the worktree by default.  Git will attempt
2575        to use a temporary directory for these files when set `true`.
2576        Defaults to `false`.
2577
2578mergetool.prompt::
2579        Prompt before each invocation of the merge resolution program.
2580
2581notes.mergeStrategy::
2582        Which merge strategy to choose by default when resolving notes
2583        conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2584        `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2585        section of linkgit:git-notes[1] for more information on each strategy.
2586
2587notes.<name>.mergeStrategy::
2588        Which merge strategy to choose when doing a notes merge into
2589        refs/notes/<name>.  This overrides the more general
2590        "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2591        linkgit:git-notes[1] for more information on the available strategies.
2592
2593notes.displayRef::
2594        The (fully qualified) refname from which to show notes when
2595        showing commit messages.  The value of this variable can be set
2596        to a glob, in which case notes from all matching refs will be
2597        shown.  You may also specify this configuration variable
2598        several times.  A warning will be issued for refs that do not
2599        exist, but a glob that does not match any refs is silently
2600        ignored.
2601+
2602This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2603environment variable, which must be a colon separated list of refs or
2604globs.
2605+
2606The effective value of "core.notesRef" (possibly overridden by
2607GIT_NOTES_REF) is also implicitly added to the list of refs to be
2608displayed.
2609
2610notes.rewrite.<command>::
2611        When rewriting commits with <command> (currently `amend` or
2612        `rebase`) and this variable is set to `true`, Git
2613        automatically copies your notes from the original to the
2614        rewritten commit.  Defaults to `true`, but see
2615        "notes.rewriteRef" below.
2616
2617notes.rewriteMode::
2618        When copying notes during a rewrite (see the
2619        "notes.rewrite.<command>" option), determines what to do if
2620        the target commit already has a note.  Must be one of
2621        `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2622        Defaults to `concatenate`.
2623+
2624This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2625environment variable.
2626
2627notes.rewriteRef::
2628        When copying notes during a rewrite, specifies the (fully
2629        qualified) ref whose notes should be copied.  The ref may be a
2630        glob, in which case notes in all matching refs will be copied.
2631        You may also specify this configuration several times.
2632+
2633Does not have a default value; you must configure this variable to
2634enable note rewriting.  Set it to `refs/notes/commits` to enable
2635rewriting for the default commit notes.
2636+
2637This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2638environment variable, which must be a colon separated list of refs or
2639globs.
2640
2641pack.window::
2642        The size of the window used by linkgit:git-pack-objects[1] when no
2643        window size is given on the command line. Defaults to 10.
2644
2645pack.depth::
2646        The maximum delta depth used by linkgit:git-pack-objects[1] when no
2647        maximum depth is given on the command line. Defaults to 50.
2648        Maximum value is 4095.
2649
2650pack.windowMemory::
2651        The maximum size of memory that is consumed by each thread
2652        in linkgit:git-pack-objects[1] for pack window memory when
2653        no limit is given on the command line.  The value can be
2654        suffixed with "k", "m", or "g".  When left unconfigured (or
2655        set explicitly to 0), there will be no limit.
2656
2657pack.compression::
2658        An integer -1..9, indicating the compression level for objects
2659        in a pack file. -1 is the zlib default. 0 means no
2660        compression, and 1..9 are various speed/size tradeoffs, 9 being
2661        slowest.  If not set,  defaults to core.compression.  If that is
2662        not set,  defaults to -1, the zlib default, which is "a default
2663        compromise between speed and compression (currently equivalent
2664        to level 6)."
2665+
2666Note that changing the compression level will not automatically recompress
2667all existing objects. You can force recompression by passing the -F option
2668to linkgit:git-repack[1].
2669
2670pack.deltaCacheSize::
2671        The maximum memory in bytes used for caching deltas in
2672        linkgit:git-pack-objects[1] before writing them out to a pack.
2673        This cache is used to speed up the writing object phase by not
2674        having to recompute the final delta result once the best match
2675        for all objects is found.  Repacking large repositories on machines
2676        which are tight with memory might be badly impacted by this though,
2677        especially if this cache pushes the system into swapping.
2678        A value of 0 means no limit. The smallest size of 1 byte may be
2679        used to virtually disable this cache. Defaults to 256 MiB.
2680
2681pack.deltaCacheLimit::
2682        The maximum size of a delta, that is cached in
2683        linkgit:git-pack-objects[1]. This cache is used to speed up the
2684        writing object phase by not having to recompute the final delta
2685        result once the best match for all objects is found.
2686        Defaults to 1000. Maximum value is 65535.
2687
2688pack.threads::
2689        Specifies the number of threads to spawn when searching for best
2690        delta matches.  This requires that linkgit:git-pack-objects[1]
2691        be compiled with pthreads otherwise this option is ignored with a
2692        warning. This is meant to reduce packing time on multiprocessor
2693        machines. The required amount of memory for the delta search window
2694        is however multiplied by the number of threads.
2695        Specifying 0 will cause Git to auto-detect the number of CPU's
2696        and set the number of threads accordingly.
2697
2698pack.indexVersion::
2699        Specify the default pack index version.  Valid values are 1 for
2700        legacy pack index used by Git versions prior to 1.5.2, and 2 for
2701        the new pack index with capabilities for packs larger than 4 GB
2702        as well as proper protection against the repacking of corrupted
2703        packs.  Version 2 is the default.  Note that version 2 is enforced
2704        and this config option ignored whenever the corresponding pack is
2705        larger than 2 GB.
2706+
2707If you have an old Git that does not understand the version 2 `*.idx` file,
2708cloning or fetching over a non native protocol (e.g. "http")
2709that will copy both `*.pack` file and corresponding `*.idx` file from the
2710other side may give you a repository that cannot be accessed with your
2711older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2712you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2713the `*.idx` file.
2714
2715pack.packSizeLimit::
2716        The maximum size of a pack.  This setting only affects
2717        packing to a file when repacking, i.e. the git:// protocol
2718        is unaffected.  It can be overridden by the `--max-pack-size`
2719        option of linkgit:git-repack[1].  Reaching this limit results
2720        in the creation of multiple packfiles; which in turn prevents
2721        bitmaps from being created.
2722        The minimum size allowed is limited to 1 MiB.
2723        The default is unlimited.
2724        Common unit suffixes of 'k', 'm', or 'g' are
2725        supported.
2726
2727pack.useBitmaps::
2728        When true, git will use pack bitmaps (if available) when packing
2729        to stdout (e.g., during the server side of a fetch). Defaults to
2730        true. You should not generally need to turn this off unless
2731        you are debugging pack bitmaps.
2732
2733pack.writeBitmaps (deprecated)::
2734        This is a deprecated synonym for `repack.writeBitmaps`.
2735
2736pack.writeBitmapHashCache::
2737        When true, git will include a "hash cache" section in the bitmap
2738        index (if one is written). This cache can be used to feed git's
2739        delta heuristics, potentially leading to better deltas between
2740        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2741        between an older, bitmapped pack and objects that have been
2742        pushed since the last gc). The downside is that it consumes 4
2743        bytes per object of disk space, and that JGit's bitmap
2744        implementation does not understand it, causing it to complain if
2745        Git and JGit are used on the same repository. Defaults to false.
2746
2747pager.<cmd>::
2748        If the value is boolean, turns on or off pagination of the
2749        output of a particular Git subcommand when writing to a tty.
2750        Otherwise, turns on pagination for the subcommand using the
2751        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2752        or `--no-pager` is specified on the command line, it takes
2753        precedence over this option.  To disable pagination for all
2754        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2755
2756pretty.<name>::
2757        Alias for a --pretty= format string, as specified in
2758        linkgit:git-log[1]. Any aliases defined here can be used just
2759        as the built-in pretty formats could. For example,
2760        running `git config pretty.changelog "format:* %H %s"`
2761        would cause the invocation `git log --pretty=changelog`
2762        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2763        Note that an alias with the same name as a built-in format
2764        will be silently ignored.
2765
2766protocol.allow::
2767        If set, provide a user defined default policy for all protocols which
2768        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
2769        if unset, known-safe protocols (http, https, git, ssh, file) have a
2770        default policy of `always`, known-dangerous protocols (ext) have a
2771        default policy of `never`, and all other protocols have a default
2772        policy of `user`.  Supported policies:
2773+
2774--
2775
2776* `always` - protocol is always able to be used.
2777
2778* `never` - protocol is never able to be used.
2779
2780* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2781  either unset or has a value of 1.  This policy should be used when you want a
2782  protocol to be directly usable by the user but don't want it used by commands which
2783  execute clone/fetch/push commands without user input, e.g. recursive
2784  submodule initialization.
2785
2786--
2787
2788protocol.<name>.allow::
2789        Set a policy to be used by protocol `<name>` with clone/fetch/push
2790        commands. See `protocol.allow` above for the available policies.
2791+
2792The protocol names currently used by git are:
2793+
2794--
2795  - `file`: any local file-based path (including `file://` URLs,
2796    or local paths)
2797
2798  - `git`: the anonymous git protocol over a direct TCP
2799    connection (or proxy, if configured)
2800
2801  - `ssh`: git over ssh (including `host:path` syntax,
2802    `ssh://`, etc).
2803
2804  - `http`: git over http, both "smart http" and "dumb http".
2805    Note that this does _not_ include `https`; if you want to configure
2806    both, you must do so individually.
2807
2808  - any external helpers are named by their protocol (e.g., use
2809    `hg` to allow the `git-remote-hg` helper)
2810--
2811
2812protocol.version::
2813        Experimental. If set, clients will attempt to communicate with a
2814        server using the specified protocol version.  If unset, no
2815        attempt will be made by the client to communicate using a
2816        particular protocol version, this results in protocol version 0
2817        being used.
2818        Supported versions:
2819+
2820--
2821
2822* `0` - the original wire protocol.
2823
2824* `1` - the original wire protocol with the addition of a version string
2825  in the initial response from the server.
2826
2827--
2828
2829pull.ff::
2830        By default, Git does not create an extra merge commit when merging
2831        a commit that is a descendant of the current commit. Instead, the
2832        tip of the current branch is fast-forwarded. When set to `false`,
2833        this variable tells Git to create an extra merge commit in such
2834        a case (equivalent to giving the `--no-ff` option from the command
2835        line). When set to `only`, only such fast-forward merges are
2836        allowed (equivalent to giving the `--ff-only` option from the
2837        command line). This setting overrides `merge.ff` when pulling.
2838
2839pull.rebase::
2840        When true, rebase branches on top of the fetched branch, instead
2841        of merging the default branch from the default remote when "git
2842        pull" is run. See "branch.<name>.rebase" for setting this on a
2843        per-branch basis.
2844+
2845When `merges`, pass the `--rebase-merges` option to 'git rebase'
2846so that the local merge commits are included in the rebase (see
2847linkgit:git-rebase[1] for details).
2848+
2849When preserve, also pass `--preserve-merges` along to 'git rebase'
2850so that locally committed merge commits will not be flattened
2851by running 'git pull'.
2852+
2853When the value is `interactive`, the rebase is run in interactive mode.
2854+
2855*NOTE*: this is a possibly dangerous operation; do *not* use
2856it unless you understand the implications (see linkgit:git-rebase[1]
2857for details).
2858
2859pull.octopus::
2860        The default merge strategy to use when pulling multiple branches
2861        at once.
2862
2863pull.twohead::
2864        The default merge strategy to use when pulling a single branch.
2865
2866push.default::
2867        Defines the action `git push` should take if no refspec is
2868        explicitly given.  Different values are well-suited for
2869        specific workflows; for instance, in a purely central workflow
2870        (i.e. the fetch source is equal to the push destination),
2871        `upstream` is probably what you want.  Possible values are:
2872+
2873--
2874
2875* `nothing` - do not push anything (error out) unless a refspec is
2876  explicitly given. This is primarily meant for people who want to
2877  avoid mistakes by always being explicit.
2878
2879* `current` - push the current branch to update a branch with the same
2880  name on the receiving end.  Works in both central and non-central
2881  workflows.
2882
2883* `upstream` - push the current branch back to the branch whose
2884  changes are usually integrated into the current branch (which is
2885  called `@{upstream}`).  This mode only makes sense if you are
2886  pushing to the same repository you would normally pull from
2887  (i.e. central workflow).
2888
2889* `tracking` - This is a deprecated synonym for `upstream`.
2890
2891* `simple` - in centralized workflow, work like `upstream` with an
2892  added safety to refuse to push if the upstream branch's name is
2893  different from the local one.
2894+
2895When pushing to a remote that is different from the remote you normally
2896pull from, work as `current`.  This is the safest option and is suited
2897for beginners.
2898+
2899This mode has become the default in Git 2.0.
2900
2901* `matching` - push all branches having the same name on both ends.
2902  This makes the repository you are pushing to remember the set of
2903  branches that will be pushed out (e.g. if you always push 'maint'
2904  and 'master' there and no other branches, the repository you push
2905  to will have these two branches, and your local 'maint' and
2906  'master' will be pushed there).
2907+
2908To use this mode effectively, you have to make sure _all_ the
2909branches you would push out are ready to be pushed out before
2910running 'git push', as the whole point of this mode is to allow you
2911to push all of the branches in one go.  If you usually finish work
2912on only one branch and push out the result, while other branches are
2913unfinished, this mode is not for you.  Also this mode is not
2914suitable for pushing into a shared central repository, as other
2915people may add new branches there, or update the tip of existing
2916branches outside your control.
2917+
2918This used to be the default, but not since Git 2.0 (`simple` is the
2919new default).
2920
2921--
2922
2923push.followTags::
2924        If set to true enable `--follow-tags` option by default.  You
2925        may override this configuration at time of push by specifying
2926        `--no-follow-tags`.
2927
2928push.gpgSign::
2929        May be set to a boolean value, or the string 'if-asked'. A true
2930        value causes all pushes to be GPG signed, as if `--signed` is
2931        passed to linkgit:git-push[1]. The string 'if-asked' causes
2932        pushes to be signed if the server supports it, as if
2933        `--signed=if-asked` is passed to 'git push'. A false value may
2934        override a value from a lower-priority config file. An explicit
2935        command-line flag always overrides this config option.
2936
2937push.pushOption::
2938        When no `--push-option=<option>` argument is given from the
2939        command line, `git push` behaves as if each <value> of
2940        this variable is given as `--push-option=<value>`.
2941+
2942This is a multi-valued variable, and an empty value can be used in a
2943higher priority configuration file (e.g. `.git/config` in a
2944repository) to clear the values inherited from a lower priority
2945configuration files (e.g. `$HOME/.gitconfig`).
2946+
2947--
2948
2949Example:
2950
2951/etc/gitconfig
2952  push.pushoption = a
2953  push.pushoption = b
2954
2955~/.gitconfig
2956  push.pushoption = c
2957
2958repo/.git/config
2959  push.pushoption =
2960  push.pushoption = b
2961
2962This will result in only b (a and c are cleared).
2963
2964--
2965
2966push.recurseSubmodules::
2967        Make sure all submodule commits used by the revisions to be pushed
2968        are available on a remote-tracking branch. If the value is 'check'
2969        then Git will verify that all submodule commits that changed in the
2970        revisions to be pushed are available on at least one remote of the
2971        submodule. If any commits are missing, the push will be aborted and
2972        exit with non-zero status. If the value is 'on-demand' then all
2973        submodules that changed in the revisions to be pushed will be
2974        pushed. If on-demand was not able to push all necessary revisions
2975        it will also be aborted and exit with non-zero status. If the value
2976        is 'no' then default behavior of ignoring submodules when pushing
2977        is retained. You may override this configuration at time of push by
2978        specifying '--recurse-submodules=check|on-demand|no'.
2979
2980include::rebase-config.txt[]
2981
2982receive.advertiseAtomic::
2983        By default, git-receive-pack will advertise the atomic push
2984        capability to its clients. If you don't want to advertise this
2985        capability, set this variable to false.
2986
2987receive.advertisePushOptions::
2988        When set to true, git-receive-pack will advertise the push options
2989        capability to its clients. False by default.
2990
2991receive.autogc::
2992        By default, git-receive-pack will run "git-gc --auto" after
2993        receiving data from git-push and updating refs.  You can stop
2994        it by setting this variable to false.
2995
2996receive.certNonceSeed::
2997        By setting this variable to a string, `git receive-pack`
2998        will accept a `git push --signed` and verifies it by using
2999        a "nonce" protected by HMAC using this string as a secret
3000        key.
3001
3002receive.certNonceSlop::
3003        When a `git push --signed` sent a push certificate with a
3004        "nonce" that was issued by a receive-pack serving the same
3005        repository within this many seconds, export the "nonce"
3006        found in the certificate to `GIT_PUSH_CERT_NONCE` to the
3007        hooks (instead of what the receive-pack asked the sending
3008        side to include).  This may allow writing checks in
3009        `pre-receive` and `post-receive` a bit easier.  Instead of
3010        checking `GIT_PUSH_CERT_NONCE_SLOP` environment variable
3011        that records by how many seconds the nonce is stale to
3012        decide if they want to accept the certificate, they only
3013        can check `GIT_PUSH_CERT_NONCE_STATUS` is `OK`.
3014
3015receive.fsckObjects::
3016        If it is set to true, git-receive-pack will check all received
3017        objects. See `transfer.fsckObjects` for what's checked.
3018        Defaults to false. If not set, the value of
3019        `transfer.fsckObjects` is used instead.
3020
3021receive.fsck.<msg-id>::
3022        Acts like `fsck.<msg-id>`, but is used by
3023        linkgit:git-receive-pack[1] instead of
3024        linkgit:git-fsck[1]. See the `fsck.<msg-id>` documentation for
3025        details.
3026
3027receive.fsck.skipList::
3028        Acts like `fsck.skipList`, but is used by
3029        linkgit:git-receive-pack[1] instead of
3030        linkgit:git-fsck[1]. See the `fsck.skipList` documentation for
3031        details.
3032
3033receive.keepAlive::
3034        After receiving the pack from the client, `receive-pack` may
3035        produce no output (if `--quiet` was specified) while processing
3036        the pack, causing some networks to drop the TCP connection.
3037        With this option set, if `receive-pack` does not transmit
3038        any data in this phase for `receive.keepAlive` seconds, it will
3039        send a short keepalive packet.  The default is 5 seconds; set
3040        to 0 to disable keepalives entirely.
3041
3042receive.unpackLimit::
3043        If the number of objects received in a push is below this
3044        limit then the objects will be unpacked into loose object
3045        files. However if the number of received objects equals or
3046        exceeds this limit then the received pack will be stored as
3047        a pack, after adding any missing delta bases.  Storing the
3048        pack from a push can make the push operation complete faster,
3049        especially on slow filesystems.  If not set, the value of
3050        `transfer.unpackLimit` is used instead.
3051
3052receive.maxInputSize::
3053        If the size of the incoming pack stream is larger than this
3054        limit, then git-receive-pack will error out, instead of
3055        accepting the pack file. If not set or set to 0, then the size
3056        is unlimited.
3057
3058receive.denyDeletes::
3059        If set to true, git-receive-pack will deny a ref update that deletes
3060        the ref. Use this to prevent such a ref deletion via a push.
3061
3062receive.denyDeleteCurrent::
3063        If set to true, git-receive-pack will deny a ref update that
3064        deletes the currently checked out branch of a non-bare repository.
3065
3066receive.denyCurrentBranch::
3067        If set to true or "refuse", git-receive-pack will deny a ref update
3068        to the currently checked out branch of a non-bare repository.
3069        Such a push is potentially dangerous because it brings the HEAD
3070        out of sync with the index and working tree. If set to "warn",
3071        print a warning of such a push to stderr, but allow the push to
3072        proceed. If set to false or "ignore", allow such pushes with no
3073        message. Defaults to "refuse".
3074+
3075Another option is "updateInstead" which will update the working
3076tree if pushing into the current branch.  This option is
3077intended for synchronizing working directories when one side is not easily
3078accessible via interactive ssh (e.g. a live web site, hence the requirement
3079that the working directory be clean). This mode also comes in handy when
3080developing inside a VM to test and fix code on different Operating Systems.
3081+
3082By default, "updateInstead" will refuse the push if the working tree or
3083the index have any difference from the HEAD, but the `push-to-checkout`
3084hook can be used to customize this.  See linkgit:githooks[5].
3085
3086receive.denyNonFastForwards::
3087        If set to true, git-receive-pack will deny a ref update which is
3088        not a fast-forward. Use this to prevent such an update via a push,
3089        even if that push is forced. This configuration variable is
3090        set when initializing a shared repository.
3091
3092receive.hideRefs::
3093        This variable is the same as `transfer.hideRefs`, but applies
3094        only to `receive-pack` (and so affects pushes, but not fetches).
3095        An attempt to update or delete a hidden ref by `git push` is
3096        rejected.
3097
3098receive.updateServerInfo::
3099        If set to true, git-receive-pack will run git-update-server-info
3100        after receiving data from git-push and updating refs.
3101
3102receive.shallowUpdate::
3103        If set to true, .git/shallow can be updated when new refs
3104        require new shallow roots. Otherwise those refs are rejected.
3105
3106remote.pushDefault::
3107        The remote to push to by default.  Overrides
3108        `branch.<name>.remote` for all branches, and is overridden by
3109        `branch.<name>.pushRemote` for specific branches.
3110
3111remote.<name>.url::
3112        The URL of a remote repository.  See linkgit:git-fetch[1] or
3113        linkgit:git-push[1].
3114
3115remote.<name>.pushurl::
3116        The push URL of a remote repository.  See linkgit:git-push[1].
3117
3118remote.<name>.proxy::
3119        For remotes that require curl (http, https and ftp), the URL to
3120        the proxy to use for that remote.  Set to the empty string to
3121        disable proxying for that remote.
3122
3123remote.<name>.proxyAuthMethod::
3124        For remotes that require curl (http, https and ftp), the method to use for
3125        authenticating against the proxy in use (probably set in
3126        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
3127
3128remote.<name>.fetch::
3129        The default set of "refspec" for linkgit:git-fetch[1]. See
3130        linkgit:git-fetch[1].
3131
3132remote.<name>.push::
3133        The default set of "refspec" for linkgit:git-push[1]. See
3134        linkgit:git-push[1].
3135
3136remote.<name>.mirror::
3137        If true, pushing to this remote will automatically behave
3138        as if the `--mirror` option was given on the command line.
3139
3140remote.<name>.skipDefaultUpdate::
3141        If true, this remote will be skipped by default when updating
3142        using linkgit:git-fetch[1] or the `update` subcommand of
3143        linkgit:git-remote[1].
3144
3145remote.<name>.skipFetchAll::
3146        If true, this remote will be skipped by default when updating
3147        using linkgit:git-fetch[1] or the `update` subcommand of
3148        linkgit:git-remote[1].
3149
3150remote.<name>.receivepack::
3151        The default program to execute on the remote side when pushing.  See
3152        option --receive-pack of linkgit:git-push[1].
3153
3154remote.<name>.uploadpack::
3155        The default program to execute on the remote side when fetching.  See
3156        option --upload-pack of linkgit:git-fetch-pack[1].
3157
3158remote.<name>.tagOpt::
3159        Setting this value to --no-tags disables automatic tag following when
3160        fetching from remote <name>. Setting it to --tags will fetch every
3161        tag from remote <name>, even if they are not reachable from remote
3162        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
3163        override this setting. See options --tags and --no-tags of
3164        linkgit:git-fetch[1].
3165
3166remote.<name>.vcs::
3167        Setting this to a value <vcs> will cause Git to interact with
3168        the remote with the git-remote-<vcs> helper.
3169
3170remote.<name>.prune::
3171        When set to true, fetching from this remote by default will also
3172        remove any remote-tracking references that no longer exist on the
3173        remote (as if the `--prune` option was given on the command line).
3174        Overrides `fetch.prune` settings, if any.
3175
3176remote.<name>.pruneTags::
3177        When set to true, fetching from this remote by default will also
3178        remove any local tags that no longer exist on the remote if pruning
3179        is activated in general via `remote.<name>.prune`, `fetch.prune` or
3180        `--prune`. Overrides `fetch.pruneTags` settings, if any.
3181+
3182See also `remote.<name>.prune` and the PRUNING section of
3183linkgit:git-fetch[1].
3184
3185remotes.<group>::
3186        The list of remotes which are fetched by "git remote update
3187        <group>".  See linkgit:git-remote[1].
3188
3189repack.useDeltaBaseOffset::
3190        By default, linkgit:git-repack[1] creates packs that use
3191        delta-base offset. If you need to share your repository with
3192        Git older than version 1.4.4, either directly or via a dumb
3193        protocol such as http, then you need to set this option to
3194        "false" and repack. Access from old Git versions over the
3195        native protocol are unaffected by this option.
3196
3197repack.packKeptObjects::
3198        If set to true, makes `git repack` act as if
3199        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
3200        details. Defaults to `false` normally, but `true` if a bitmap
3201        index is being written (either via `--write-bitmap-index` or
3202        `repack.writeBitmaps`).
3203
3204repack.writeBitmaps::
3205        When true, git will write a bitmap index when packing all
3206        objects to disk (e.g., when `git repack -a` is run).  This
3207        index can speed up the "counting objects" phase of subsequent
3208        packs created for clones and fetches, at the cost of some disk
3209        space and extra time spent on the initial repack.  This has
3210        no effect if multiple packfiles are created.
3211        Defaults to false.
3212
3213rerere.autoUpdate::
3214        When set to true, `git-rerere` updates the index with the
3215        resulting contents after it cleanly resolves conflicts using
3216        previously recorded resolution.  Defaults to false.
3217
3218rerere.enabled::
3219        Activate recording of resolved conflicts, so that identical
3220        conflict hunks can be resolved automatically, should they be
3221        encountered again.  By default, linkgit:git-rerere[1] is
3222        enabled if there is an `rr-cache` directory under the
3223        `$GIT_DIR`, e.g. if "rerere" was previously used in the
3224        repository.
3225
3226sendemail.identity::
3227        A configuration identity. When given, causes values in the
3228        'sendemail.<identity>' subsection to take precedence over
3229        values in the 'sendemail' section. The default identity is
3230        the value of `sendemail.identity`.
3231
3232sendemail.smtpEncryption::
3233        See linkgit:git-send-email[1] for description.  Note that this
3234        setting is not subject to the 'identity' mechanism.
3235
3236sendemail.smtpssl (deprecated)::
3237        Deprecated alias for 'sendemail.smtpEncryption = ssl'.
3238
3239sendemail.smtpsslcertpath::
3240        Path to ca-certificates (either a directory or a single file).
3241        Set it to an empty string to disable certificate verification.
3242
3243sendemail.<identity>.*::
3244        Identity-specific versions of the 'sendemail.*' parameters
3245        found below, taking precedence over those when this
3246        identity is selected, through either the command-line or
3247        `sendemail.identity`.
3248
3249sendemail.aliasesFile::
3250sendemail.aliasFileType::
3251sendemail.annotate::
3252sendemail.bcc::
3253sendemail.cc::
3254sendemail.ccCmd::
3255sendemail.chainReplyTo::
3256sendemail.confirm::
3257sendemail.envelopeSender::
3258sendemail.from::
3259sendemail.multiEdit::
3260sendemail.signedoffbycc::
3261sendemail.smtpPass::
3262sendemail.suppresscc::
3263sendemail.suppressFrom::
3264sendemail.to::
3265sendemail.tocmd::
3266sendemail.smtpDomain::
3267sendemail.smtpServer::
3268sendemail.smtpServerPort::
3269sendemail.smtpServerOption::
3270sendemail.smtpUser::
3271sendemail.thread::
3272sendemail.transferEncoding::
3273sendemail.validate::
3274sendemail.xmailer::
3275        See linkgit:git-send-email[1] for description.
3276
3277sendemail.signedoffcc (deprecated)::
3278        Deprecated alias for `sendemail.signedoffbycc`.
3279
3280sendemail.smtpBatchSize::
3281        Number of messages to be sent per connection, after that a relogin
3282        will happen.  If the value is 0 or undefined, send all messages in
3283        one connection.
3284        See also the `--batch-size` option of linkgit:git-send-email[1].
3285
3286sendemail.smtpReloginDelay::
3287        Seconds wait before reconnecting to smtp server.
3288        See also the `--relogin-delay` option of linkgit:git-send-email[1].
3289
3290showbranch.default::
3291        The default set of branches for linkgit:git-show-branch[1].
3292        See linkgit:git-show-branch[1].
3293
3294splitIndex.maxPercentChange::
3295        When the split index feature is used, this specifies the
3296        percent of entries the split index can contain compared to the
3297        total number of entries in both the split index and the shared
3298        index before a new shared index is written.
3299        The value should be between 0 and 100. If the value is 0 then
3300        a new shared index is always written, if it is 100 a new
3301        shared index is never written.
3302        By default the value is 20, so a new shared index is written
3303        if the number of entries in the split index would be greater
3304        than 20 percent of the total number of entries.
3305        See linkgit:git-update-index[1].
3306
3307splitIndex.sharedIndexExpire::
3308        When the split index feature is used, shared index files that
3309        were not modified since the time this variable specifies will
3310        be removed when a new shared index file is created. The value
3311        "now" expires all entries immediately, and "never" suppresses
3312        expiration altogether.
3313        The default value is "2.weeks.ago".
3314        Note that a shared index file is considered modified (for the
3315        purpose of expiration) each time a new split-index file is
3316        either created based on it or read from it.
3317        See linkgit:git-update-index[1].
3318
3319status.relativePaths::
3320        By default, linkgit:git-status[1] shows paths relative to the
3321        current directory. Setting this variable to `false` shows paths
3322        relative to the repository root (this was the default for Git
3323        prior to v1.5.4).
3324
3325status.short::
3326        Set to true to enable --short by default in linkgit:git-status[1].
3327        The option --no-short takes precedence over this variable.
3328
3329status.branch::
3330        Set to true to enable --branch by default in linkgit:git-status[1].
3331        The option --no-branch takes precedence over this variable.
3332
3333status.displayCommentPrefix::
3334        If set to true, linkgit:git-status[1] will insert a comment
3335        prefix before each output line (starting with
3336        `core.commentChar`, i.e. `#` by default). This was the
3337        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
3338        Defaults to false.
3339
3340status.renameLimit::
3341        The number of files to consider when performing rename detection
3342        in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
3343        the value of diff.renameLimit.
3344
3345status.renames::
3346        Whether and how Git detects renames in linkgit:git-status[1] and
3347        linkgit:git-commit[1] .  If set to "false", rename detection is
3348        disabled. If set to "true", basic rename detection is enabled.
3349        If set to "copies" or "copy", Git will detect copies, as well.
3350        Defaults to the value of diff.renames.
3351
3352status.showStash::
3353        If set to true, linkgit:git-status[1] will display the number of
3354        entries currently stashed away.
3355        Defaults to false.
3356
3357status.showUntrackedFiles::
3358        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
3359        files which are not currently tracked by Git. Directories which
3360        contain only untracked files, are shown with the directory name
3361        only. Showing untracked files means that Git needs to lstat() all
3362        the files in the whole repository, which might be slow on some
3363        systems. So, this variable controls how the commands displays
3364        the untracked files. Possible values are:
3365+
3366--
3367* `no` - Show no untracked files.
3368* `normal` - Show untracked files and directories.
3369* `all` - Show also individual files in untracked directories.
3370--
3371+
3372If this variable is not specified, it defaults to 'normal'.
3373This variable can be overridden with the -u|--untracked-files option
3374of linkgit:git-status[1] and linkgit:git-commit[1].
3375
3376status.submoduleSummary::
3377        Defaults to false.
3378        If this is set to a non zero number or true (identical to -1 or an
3379        unlimited number), the submodule summary will be enabled and a
3380        summary of commits for modified submodules will be shown (see
3381        --summary-limit option of linkgit:git-submodule[1]). Please note
3382        that the summary output command will be suppressed for all
3383        submodules when `diff.ignoreSubmodules` is set to 'all' or only
3384        for those submodules where `submodule.<name>.ignore=all`. The only
3385        exception to that rule is that status and commit will show staged
3386        submodule changes. To
3387        also view the summary for ignored submodules you can either use
3388        the --ignore-submodules=dirty command-line option or the 'git
3389        submodule summary' command, which shows a similar output but does
3390        not honor these settings.
3391
3392stash.showPatch::
3393        If this is set to true, the `git stash show` command without an
3394        option will show the stash entry in patch form.  Defaults to false.
3395        See description of 'show' command in linkgit:git-stash[1].
3396
3397stash.showStat::
3398        If this is set to true, the `git stash show` command without an
3399        option will show diffstat of the stash entry.  Defaults to true.
3400        See description of 'show' command in linkgit:git-stash[1].
3401
3402submodule.<name>.url::
3403        The URL for a submodule. This variable is copied from the .gitmodules
3404        file to the git config via 'git submodule init'. The user can change
3405        the configured URL before obtaining the submodule via 'git submodule
3406        update'. If neither submodule.<name>.active or submodule.active are
3407        set, the presence of this variable is used as a fallback to indicate
3408        whether the submodule is of interest to git commands.
3409        See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
3410
3411submodule.<name>.update::
3412        The method by which a submodule is updated by 'git submodule update',
3413        which is the only affected command, others such as
3414        'git checkout --recurse-submodules' are unaffected. It exists for
3415        historical reasons, when 'git submodule' was the only command to
3416        interact with submodules; settings like `submodule.active`
3417        and `pull.rebase` are more specific. It is populated by
3418        `git submodule init` from the linkgit:gitmodules[5] file.
3419        See description of 'update' command in linkgit:git-submodule[1].
3420
3421submodule.<name>.branch::
3422        The remote branch name for a submodule, used by `git submodule
3423        update --remote`.  Set this option to override the value found in
3424        the `.gitmodules` file.  See linkgit:git-submodule[1] and
3425        linkgit:gitmodules[5] for details.
3426
3427submodule.<name>.fetchRecurseSubmodules::
3428        This option can be used to control recursive fetching of this
3429        submodule. It can be overridden by using the --[no-]recurse-submodules
3430        command-line option to "git fetch" and "git pull".
3431        This setting will override that from in the linkgit:gitmodules[5]
3432        file.
3433
3434submodule.<name>.ignore::
3435        Defines under what circumstances "git status" and the diff family show
3436        a submodule as modified. When set to "all", it will never be considered
3437        modified (but it will nonetheless show up in the output of status and
3438        commit when it has been staged), "dirty" will ignore all changes
3439        to the submodules work tree and
3440        takes only differences between the HEAD of the submodule and the commit
3441        recorded in the superproject into account. "untracked" will additionally
3442        let submodules with modified tracked files in their work tree show up.
3443        Using "none" (the default when this option is not set) also shows
3444        submodules that have untracked files in their work tree as changed.
3445        This setting overrides any setting made in .gitmodules for this submodule,
3446        both settings can be overridden on the command line by using the
3447        "--ignore-submodules" option. The 'git submodule' commands are not
3448        affected by this setting.
3449
3450submodule.<name>.active::
3451        Boolean value indicating if the submodule is of interest to git
3452        commands.  This config option takes precedence over the
3453        submodule.active config option. See linkgit:gitsubmodules[7] for
3454        details.
3455
3456submodule.active::
3457        A repeated field which contains a pathspec used to match against a
3458        submodule's path to determine if the submodule is of interest to git
3459        commands. See linkgit:gitsubmodules[7] for details.
3460
3461submodule.recurse::
3462        Specifies if commands recurse into submodules by default. This
3463        applies to all commands that have a `--recurse-submodules` option,
3464        except `clone`.
3465        Defaults to false.
3466
3467submodule.fetchJobs::
3468        Specifies how many submodules are fetched/cloned at the same time.
3469        A positive integer allows up to that number of submodules fetched
3470        in parallel. A value of 0 will give some reasonable default.
3471        If unset, it defaults to 1.
3472
3473submodule.alternateLocation::
3474        Specifies how the submodules obtain alternates when submodules are
3475        cloned. Possible values are `no`, `superproject`.
3476        By default `no` is assumed, which doesn't add references. When the
3477        value is set to `superproject` the submodule to be cloned computes
3478        its alternates location relative to the superprojects alternate.
3479
3480submodule.alternateErrorStrategy::
3481        Specifies how to treat errors with the alternates for a submodule
3482        as computed via `submodule.alternateLocation`. Possible values are
3483        `ignore`, `info`, `die`. Default is `die`.
3484
3485tag.forceSignAnnotated::
3486        A boolean to specify whether annotated tags created should be GPG signed.
3487        If `--annotate` is specified on the command line, it takes
3488        precedence over this option.
3489
3490tag.sort::
3491        This variable controls the sort ordering of tags when displayed by
3492        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
3493        value of this variable will be used as the default.
3494
3495tar.umask::
3496        This variable can be used to restrict the permission bits of
3497        tar archive entries.  The default is 0002, which turns off the
3498        world write bit.  The special value "user" indicates that the
3499        archiving user's umask will be used instead.  See umask(2) and
3500        linkgit:git-archive[1].
3501
3502transfer.fsckObjects::
3503        When `fetch.fsckObjects` or `receive.fsckObjects` are
3504        not set, the value of this variable is used instead.
3505        Defaults to false.
3506+
3507When set, the fetch or receive will abort in the case of a malformed
3508object or a link to a nonexistent object. In addition, various other
3509issues are checked for, including legacy issues (see `fsck.<msg-id>`),
3510and potential security issues like the existence of a `.GIT` directory
3511or a malicious `.gitmodules` file (see the release notes for v2.2.1
3512and v2.17.1 for details). Other sanity and security checks may be
3513added in future releases.
3514+
3515On the receiving side, failing fsckObjects will make those objects
3516unreachable, see "QUARANTINE ENVIRONMENT" in
3517linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
3518instead be left unreferenced in the repository.
3519+
3520Due to the non-quarantine nature of the `fetch.fsckObjects`
3521implementation it can not be relied upon to leave the object store
3522clean like `receive.fsckObjects` can.
3523+
3524As objects are unpacked they're written to the object store, so there
3525can be cases where malicious objects get introduced even though the
3526"fetch" failed, only to have a subsequent "fetch" succeed because only
3527new incoming objects are checked, not those that have already been
3528written to the object store. That difference in behavior should not be
3529relied upon. In the future, such objects may be quarantined for
3530"fetch" as well.
3531+
3532For now, the paranoid need to find some way to emulate the quarantine
3533environment if they'd like the same protection as "push". E.g. in the
3534case of an internal mirror do the mirroring in two steps, one to fetch
3535the untrusted objects, and then do a second "push" (which will use the
3536quarantine) to another internal repo, and have internal clients
3537consume this pushed-to repository, or embargo internal fetches and
3538only allow them once a full "fsck" has run (and no new fetches have
3539happened in the meantime).
3540
3541transfer.hideRefs::
3542        String(s) `receive-pack` and `upload-pack` use to decide which
3543        refs to omit from their initial advertisements.  Use more than
3544        one definition to specify multiple prefix strings. A ref that is
3545        under the hierarchies listed in the value of this variable is
3546        excluded, and is hidden when responding to `git push` or `git
3547        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
3548        program-specific versions of this config.
3549+
3550You may also include a `!` in front of the ref name to negate the entry,
3551explicitly exposing it, even if an earlier entry marked it as hidden.
3552If you have multiple hideRefs values, later entries override earlier ones
3553(and entries in more-specific config files override less-specific ones).
3554+
3555If a namespace is in use, the namespace prefix is stripped from each
3556reference before it is matched against `transfer.hiderefs` patterns.
3557For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
3558the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
3559is omitted from the advertisements but `refs/heads/master` and
3560`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
3561"have" lines. In order to match refs before stripping, add a `^` in front of
3562the ref name. If you combine `!` and `^`, `!` must be specified first.
3563+
3564Even if you hide refs, a client may still be able to steal the target
3565objects via the techniques described in the "SECURITY" section of the
3566linkgit:gitnamespaces[7] man page; it's best to keep private data in a
3567separate repository.
3568
3569transfer.unpackLimit::
3570        When `fetch.unpackLimit` or `receive.unpackLimit` are
3571        not set, the value of this variable is used instead.
3572        The default value is 100.
3573
3574uploadarchive.allowUnreachable::
3575        If true, allow clients to use `git archive --remote` to request
3576        any tree, whether reachable from the ref tips or not. See the
3577        discussion in the "SECURITY" section of
3578        linkgit:git-upload-archive[1] for more details. Defaults to
3579        `false`.
3580
3581uploadpack.hideRefs::
3582        This variable is the same as `transfer.hideRefs`, but applies
3583        only to `upload-pack` (and so affects only fetches, not pushes).
3584        An attempt to fetch a hidden ref by `git fetch` will fail.  See
3585        also `uploadpack.allowTipSHA1InWant`.
3586
3587uploadpack.allowTipSHA1InWant::
3588        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
3589        to accept a fetch request that asks for an object at the tip
3590        of a hidden ref (by default, such a request is rejected).
3591        See also `uploadpack.hideRefs`.  Even if this is false, a client
3592        may be able to steal objects via the techniques described in the
3593        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
3594        best to keep private data in a separate repository.
3595
3596uploadpack.allowReachableSHA1InWant::
3597        Allow `upload-pack` to accept a fetch request that asks for an
3598        object that is reachable from any ref tip. However, note that
3599        calculating object reachability is computationally expensive.
3600        Defaults to `false`.  Even if this is false, a client may be able
3601        to steal objects via the techniques described in the "SECURITY"
3602        section of the linkgit:gitnamespaces[7] man page; it's best to
3603        keep private data in a separate repository.
3604
3605uploadpack.allowAnySHA1InWant::
3606        Allow `upload-pack` to accept a fetch request that asks for any
3607        object at all.
3608        Defaults to `false`.
3609
3610uploadpack.keepAlive::
3611        When `upload-pack` has started `pack-objects`, there may be a
3612        quiet period while `pack-objects` prepares the pack. Normally
3613        it would output progress information, but if `--quiet` was used
3614        for the fetch, `pack-objects` will output nothing at all until
3615        the pack data begins. Some clients and networks may consider
3616        the server to be hung and give up. Setting this option instructs
3617        `upload-pack` to send an empty keepalive packet every
3618        `uploadpack.keepAlive` seconds. Setting this option to 0
3619        disables keepalive packets entirely. The default is 5 seconds.
3620
3621uploadpack.packObjectsHook::
3622        If this option is set, when `upload-pack` would run
3623        `git pack-objects` to create a packfile for a client, it will
3624        run this shell command instead.  The `pack-objects` command and
3625        arguments it _would_ have run (including the `git pack-objects`
3626        at the beginning) are appended to the shell command. The stdin
3627        and stdout of the hook are treated as if `pack-objects` itself
3628        was run. I.e., `upload-pack` will feed input intended for
3629        `pack-objects` to the hook, and expects a completed packfile on
3630        stdout.
3631
3632uploadpack.allowFilter::
3633        If this option is set, `upload-pack` will support partial
3634        clone and partial fetch object filtering.
3635+
3636Note that this configuration variable is ignored if it is seen in the
3637repository-level config (this is a safety measure against fetching from
3638untrusted repositories).
3639
3640uploadpack.allowRefInWant::
3641        If this option is set, `upload-pack` will support the `ref-in-want`
3642        feature of the protocol version 2 `fetch` command.  This feature
3643        is intended for the benefit of load-balanced servers which may
3644        not have the same view of what OIDs their refs point to due to
3645        replication delay.
3646
3647url.<base>.insteadOf::
3648        Any URL that starts with this value will be rewritten to
3649        start, instead, with <base>. In cases where some site serves a
3650        large number of repositories, and serves them with multiple
3651        access methods, and some users need to use different access
3652        methods, this feature allows people to specify any of the
3653        equivalent URLs and have Git automatically rewrite the URL to
3654        the best alternative for the particular user, even for a
3655        never-before-seen repository on the site.  When more than one
3656        insteadOf strings match a given URL, the longest match is used.
3657+
3658Note that any protocol restrictions will be applied to the rewritten
3659URL. If the rewrite changes the URL to use a custom protocol or remote
3660helper, you may need to adjust the `protocol.*.allow` config to permit
3661the request.  In particular, protocols you expect to use for submodules
3662must be set to `always` rather than the default of `user`. See the
3663description of `protocol.allow` above.
3664
3665url.<base>.pushInsteadOf::
3666        Any URL that starts with this value will not be pushed to;
3667        instead, it will be rewritten to start with <base>, and the
3668        resulting URL will be pushed to. In cases where some site serves
3669        a large number of repositories, and serves them with multiple
3670        access methods, some of which do not allow push, this feature
3671        allows people to specify a pull-only URL and have Git
3672        automatically use an appropriate URL to push, even for a
3673        never-before-seen repository on the site.  When more than one
3674        pushInsteadOf strings match a given URL, the longest match is
3675        used.  If a remote has an explicit pushurl, Git will ignore this
3676        setting for that remote.
3677
3678user.email::
3679        Your email address to be recorded in any newly created commits.
3680        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3681        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
3682
3683user.name::
3684        Your full name to be recorded in any newly created commits.
3685        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3686        environment variables.  See linkgit:git-commit-tree[1].
3687
3688user.useConfigOnly::
3689        Instruct Git to avoid trying to guess defaults for `user.email`
3690        and `user.name`, and instead retrieve the values only from the
3691        configuration. For example, if you have multiple email addresses
3692        and would like to use a different one for each repository, then
3693        with this configuration option set to `true` in the global config
3694        along with a name, Git will prompt you to set up an email before
3695        making new commits in a newly cloned repository.
3696        Defaults to `false`.
3697
3698user.signingKey::
3699        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3700        key you want it to automatically when creating a signed tag or
3701        commit, you can override the default selection with this variable.
3702        This option is passed unchanged to gpg's --local-user parameter,
3703        so you may specify a key using any method that gpg supports.
3704
3705versionsort.prereleaseSuffix (deprecated)::
3706        Deprecated alias for `versionsort.suffix`.  Ignored if
3707        `versionsort.suffix` is set.
3708
3709versionsort.suffix::
3710        Even when version sort is used in linkgit:git-tag[1], tagnames
3711        with the same base version but different suffixes are still sorted
3712        lexicographically, resulting e.g. in prerelease tags appearing
3713        after the main release (e.g. "1.0-rc1" after "1.0").  This
3714        variable can be specified to determine the sorting order of tags
3715        with different suffixes.
3716+
3717By specifying a single suffix in this variable, any tagname containing
3718that suffix will appear before the corresponding main release.  E.g. if
3719the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3720"1.0".  If specified multiple times, once per suffix, then the order of
3721suffixes in the configuration will determine the sorting order of tagnames
3722with those suffixes.  E.g. if "-pre" appears before "-rc" in the
3723configuration, then all "1.0-preX" tags will be listed before any
3724"1.0-rcX" tags.  The placement of the main release tag relative to tags
3725with various suffixes can be determined by specifying the empty suffix
3726among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
3727"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3728are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3729"v4.8-bfsX".
3730+
3731If more than one suffixes match the same tagname, then that tagname will
3732be sorted according to the suffix which starts at the earliest position in
3733the tagname.  If more than one different matching suffixes start at
3734that earliest position, then that tagname will be sorted according to the
3735longest of those suffixes.
3736The sorting order between different suffixes is undefined if they are
3737in multiple config files.
3738
3739web.browser::
3740        Specify a web browser that may be used by some commands.
3741        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3742        may use it.
3743
3744worktree.guessRemote::
3745        With `add`, if no branch argument, and neither of `-b` nor
3746        `-B` nor `--detach` are given, the command defaults to
3747        creating a new branch from HEAD.  If `worktree.guessRemote` is
3748        set to true, `worktree add` tries to find a remote-tracking
3749        branch whose name uniquely matches the new branch name.  If
3750        such a branch exists, it is checked out and set as "upstream"
3751        for the new branch.  If no such match can be found, it falls
3752        back to creating a new branch from the current HEAD.