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