Documentation / config.txton commit config.txt: move sequence.editor out of "core" part (8dc9d22)
   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
 835core.pager::
 836        Text viewer for use by Git commands (e.g., 'less').  The value
 837        is meant to be interpreted by the shell.  The order of preference
 838        is the `$GIT_PAGER` environment variable, then `core.pager`
 839        configuration, then `$PAGER`, and then the default chosen at
 840        compile time (usually 'less').
 841+
 842When the `LESS` environment variable is unset, Git sets it to `FRX`
 843(if `LESS` environment variable is set, Git does not change it at
 844all).  If you want to selectively override Git's default setting
 845for `LESS`, you can set `core.pager` to e.g. `less -S`.  This will
 846be passed to the shell by Git, which will translate the final
 847command to `LESS=FRX less -S`. The environment does not set the
 848`S` option but the command line does, instructing less to truncate
 849long lines. Similarly, setting `core.pager` to `less -+F` will
 850deactivate the `F` option specified by the environment from the
 851command-line, deactivating the "quit if one screen" behavior of
 852`less`.  One can specifically activate some flags for particular
 853commands: for example, setting `pager.blame` to `less -S` enables
 854line truncation only for `git blame`.
 855+
 856Likewise, when the `LV` environment variable is unset, Git sets it
 857to `-c`.  You can override this setting by exporting `LV` with
 858another value or setting `core.pager` to `lv +c`.
 859
 860core.whitespace::
 861        A comma separated list of common whitespace problems to
 862        notice.  'git diff' will use `color.diff.whitespace` to
 863        highlight them, and 'git apply --whitespace=error' will
 864        consider them as errors.  You can prefix `-` to disable
 865        any of them (e.g. `-trailing-space`):
 866+
 867* `blank-at-eol` treats trailing whitespaces at the end of the line
 868  as an error (enabled by default).
 869* `space-before-tab` treats a space character that appears immediately
 870  before a tab character in the initial indent part of the line as an
 871  error (enabled by default).
 872* `indent-with-non-tab` treats a line that is indented with space
 873  characters instead of the equivalent tabs as an error (not enabled by
 874  default).
 875* `tab-in-indent` treats a tab character in the initial indent part of
 876  the line as an error (not enabled by default).
 877* `blank-at-eof` treats blank lines added at the end of file as an error
 878  (enabled by default).
 879* `trailing-space` is a short-hand to cover both `blank-at-eol` and
 880  `blank-at-eof`.
 881* `cr-at-eol` treats a carriage-return at the end of line as
 882  part of the line terminator, i.e. with it, `trailing-space`
 883  does not trigger if the character before such a carriage-return
 884  is not a whitespace (not enabled by default).
 885* `tabwidth=<n>` tells how many character positions a tab occupies; this
 886  is relevant for `indent-with-non-tab` and when Git fixes `tab-in-indent`
 887  errors. The default tab width is 8. Allowed values are 1 to 63.
 888
 889core.fsyncObjectFiles::
 890        This boolean will enable 'fsync()' when writing object files.
 891+
 892This is a total waste of time and effort on a filesystem that orders
 893data writes properly, but can be useful for filesystems that do not use
 894journalling (traditional UNIX filesystems) or that only journal metadata
 895and not file contents (OS X's HFS+, or Linux ext3 with "data=writeback").
 896
 897core.preloadIndex::
 898        Enable parallel index preload for operations like 'git diff'
 899+
 900This can speed up operations like 'git diff' and 'git status' especially
 901on filesystems like NFS that have weak caching semantics and thus
 902relatively high IO latencies.  When enabled, Git will do the
 903index comparison to the filesystem data in parallel, allowing
 904overlapping IO's.  Defaults to true.
 905
 906core.createObject::
 907        You can set this to 'link', in which case a hardlink followed by
 908        a delete of the source are used to make sure that object creation
 909        will not overwrite existing objects.
 910+
 911On some file system/operating system combinations, this is unreliable.
 912Set this config setting to 'rename' there; However, This will remove the
 913check that makes sure that existing object files will not get overwritten.
 914
 915core.notesRef::
 916        When showing commit messages, also show notes which are stored in
 917        the given ref.  The ref must be fully qualified.  If the given
 918        ref does not exist, it is not an error but means that no
 919        notes should be printed.
 920+
 921This setting defaults to "refs/notes/commits", and it can be overridden by
 922the `GIT_NOTES_REF` environment variable.  See linkgit:git-notes[1].
 923
 924core.commitGraph::
 925        If true, then git will read the commit-graph file (if it exists)
 926        to parse the graph structure of commits. Defaults to false. See
 927        linkgit:git-commit-graph[1] for more information.
 928
 929core.useReplaceRefs::
 930        If set to `false`, behave as if the `--no-replace-objects`
 931        option was given on the command line. See linkgit:git[1] and
 932        linkgit:git-replace[1] for more information.
 933
 934core.sparseCheckout::
 935        Enable "sparse checkout" feature. See section "Sparse checkout" in
 936        linkgit:git-read-tree[1] for more information.
 937
 938core.abbrev::
 939        Set the length object names are abbreviated to.  If
 940        unspecified or set to "auto", an appropriate value is
 941        computed based on the approximate number of packed objects
 942        in your repository, which hopefully is enough for
 943        abbreviated object names to stay unique for some time.
 944        The minimum length is 4.
 945
 946add.ignoreErrors::
 947add.ignore-errors (deprecated)::
 948        Tells 'git add' to continue adding files when some files cannot be
 949        added due to indexing errors. Equivalent to the `--ignore-errors`
 950        option of linkgit:git-add[1].  `add.ignore-errors` is deprecated,
 951        as it does not follow the usual naming convention for configuration
 952        variables.
 953
 954alias.*::
 955        Command aliases for the linkgit:git[1] command wrapper - e.g.
 956        after defining "alias.last = cat-file commit HEAD", the invocation
 957        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 958        confusion and troubles with script usage, aliases that
 959        hide existing Git commands are ignored. Arguments are split by
 960        spaces, the usual shell quoting and escaping is supported.
 961        A quote pair or a backslash can be used to quote them.
 962+
 963If the alias expansion is prefixed with an exclamation point,
 964it will be treated as a shell command.  For example, defining
 965"alias.new = !gitk --all --not ORIG_HEAD", the invocation
 966"git new" is equivalent to running the shell command
 967"gitk --all --not ORIG_HEAD".  Note that shell commands will be
 968executed from the top-level directory of a repository, which may
 969not necessarily be the current directory.
 970`GIT_PREFIX` is set as returned by running 'git rev-parse --show-prefix'
 971from the original current directory. See linkgit:git-rev-parse[1].
 972
 973am.keepcr::
 974        If true, git-am will call git-mailsplit for patches in mbox format
 975        with parameter `--keep-cr`. In this case git-mailsplit will
 976        not remove `\r` from lines ending with `\r\n`. Can be overridden
 977        by giving `--no-keep-cr` from the command line.
 978        See linkgit:git-am[1], linkgit:git-mailsplit[1].
 979
 980am.threeWay::
 981        By default, `git am` will fail if the patch does not apply cleanly. When
 982        set to true, this setting tells `git am` to fall back on 3-way merge if
 983        the patch records the identity of blobs it is supposed to apply to and
 984        we have those blobs available locally (equivalent to giving the `--3way`
 985        option from the command line). Defaults to `false`.
 986        See linkgit:git-am[1].
 987
 988apply.ignoreWhitespace::
 989        When set to 'change', tells 'git apply' to ignore changes in
 990        whitespace, in the same way as the `--ignore-space-change`
 991        option.
 992        When set to one of: no, none, never, false tells 'git apply' to
 993        respect all whitespace differences.
 994        See linkgit:git-apply[1].
 995
 996apply.whitespace::
 997        Tells 'git apply' how to handle whitespaces, in the same way
 998        as the `--whitespace` option. See linkgit:git-apply[1].
 999
1000blame.blankBoundary::
1001        Show blank commit object name for boundary commits in
1002        linkgit:git-blame[1]. This option defaults to false.
1003
1004blame.coloring::
1005        This determines the coloring scheme to be applied to blame
1006        output. It can be 'repeatedLines', 'highlightRecent',
1007        or 'none' which is the default.
1008
1009blame.date::
1010        Specifies the format used to output dates in linkgit:git-blame[1].
1011        If unset the iso format is used. For supported values,
1012        see the discussion of the `--date` option at linkgit:git-log[1].
1013
1014blame.showEmail::
1015        Show the author email instead of author name in linkgit:git-blame[1].
1016        This option defaults to false.
1017
1018blame.showRoot::
1019        Do not treat root commits as boundaries in linkgit:git-blame[1].
1020        This option defaults to false.
1021
1022branch.autoSetupMerge::
1023        Tells 'git branch' and 'git checkout' to set up new branches
1024        so that linkgit:git-pull[1] will appropriately merge from the
1025        starting point branch. Note that even if this option is not set,
1026        this behavior can be chosen per-branch using the `--track`
1027        and `--no-track` options. The valid settings are: `false` -- no
1028        automatic setup is done; `true` -- automatic setup is done when the
1029        starting point is a remote-tracking branch; `always` --
1030        automatic setup is done when the starting point is either a
1031        local branch or remote-tracking
1032        branch. This option defaults to true.
1033
1034branch.autoSetupRebase::
1035        When a new branch is created with 'git branch' or 'git checkout'
1036        that tracks another branch, this variable tells Git to set
1037        up pull to rebase instead of merge (see "branch.<name>.rebase").
1038        When `never`, rebase is never automatically set to true.
1039        When `local`, rebase is set to true for tracked branches of
1040        other local branches.
1041        When `remote`, rebase is set to true for tracked branches of
1042        remote-tracking branches.
1043        When `always`, rebase will be set to true for all tracking
1044        branches.
1045        See "branch.autoSetupMerge" for details on how to set up a
1046        branch to track another branch.
1047        This option defaults to never.
1048
1049branch.sort::
1050        This variable controls the sort ordering of branches when displayed by
1051        linkgit:git-branch[1]. Without the "--sort=<value>" option provided, the
1052        value of this variable will be used as the default.
1053        See linkgit:git-for-each-ref[1] field names for valid values.
1054
1055branch.<name>.remote::
1056        When on branch <name>, it tells 'git fetch' and 'git push'
1057        which remote to fetch from/push to.  The remote to push to
1058        may be overridden with `remote.pushDefault` (for all branches).
1059        The remote to push to, for the current branch, may be further
1060        overridden by `branch.<name>.pushRemote`.  If no remote is
1061        configured, or if you are not on any branch, it defaults to
1062        `origin` for fetching and `remote.pushDefault` for pushing.
1063        Additionally, `.` (a period) is the current local repository
1064        (a dot-repository), see `branch.<name>.merge`'s final note below.
1065
1066branch.<name>.pushRemote::
1067        When on branch <name>, it overrides `branch.<name>.remote` for
1068        pushing.  It also overrides `remote.pushDefault` for pushing
1069        from branch <name>.  When you pull from one place (e.g. your
1070        upstream) and push to another place (e.g. your own publishing
1071        repository), you would want to set `remote.pushDefault` to
1072        specify the remote to push to for all branches, and use this
1073        option to override it for a specific branch.
1074
1075branch.<name>.merge::
1076        Defines, together with branch.<name>.remote, the upstream branch
1077        for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
1078        branch to merge and can also affect 'git push' (see push.default).
1079        When in branch <name>, it tells 'git fetch' the default
1080        refspec to be marked for merging in FETCH_HEAD. The value is
1081        handled like the remote part of a refspec, and must match a
1082        ref which is fetched from the remote given by
1083        "branch.<name>.remote".
1084        The merge information is used by 'git pull' (which at first calls
1085        'git fetch') to lookup the default branch for merging. Without
1086        this option, 'git pull' defaults to merge the first refspec fetched.
1087        Specify multiple values to get an octopus merge.
1088        If you wish to setup 'git pull' so that it merges into <name> from
1089        another branch in the local repository, you can point
1090        branch.<name>.merge to the desired branch, and use the relative path
1091        setting `.` (a period) for branch.<name>.remote.
1092
1093branch.<name>.mergeOptions::
1094        Sets default options for merging into branch <name>. The syntax and
1095        supported options are the same as those of linkgit:git-merge[1], but
1096        option values containing whitespace characters are currently not
1097        supported.
1098
1099branch.<name>.rebase::
1100        When true, rebase the branch <name> on top of the fetched branch,
1101        instead of merging the default branch from the default remote when
1102        "git pull" is run. See "pull.rebase" for doing this in a non
1103        branch-specific manner.
1104+
1105When `merges`, pass the `--rebase-merges` option to 'git rebase'
1106so that the local merge commits are included in the rebase (see
1107linkgit:git-rebase[1] for details).
1108+
1109When preserve, also pass `--preserve-merges` along to 'git rebase'
1110so that locally committed merge commits will not be flattened
1111by running 'git pull'.
1112+
1113When the value is `interactive`, the rebase is run in interactive mode.
1114+
1115*NOTE*: this is a possibly dangerous operation; do *not* use
1116it unless you understand the implications (see linkgit:git-rebase[1]
1117for details).
1118
1119branch.<name>.description::
1120        Branch description, can be edited with
1121        `git branch --edit-description`. Branch description is
1122        automatically added in the format-patch cover letter or
1123        request-pull summary.
1124
1125browser.<tool>.cmd::
1126        Specify the command to invoke the specified browser. The
1127        specified command is evaluated in shell with the URLs passed
1128        as arguments. (See linkgit:git-web{litdd}browse[1].)
1129
1130browser.<tool>.path::
1131        Override the path for the given tool that may be used to
1132        browse HTML help (see `-w` option in linkgit:git-help[1]) or a
1133        working repository in gitweb (see linkgit:git-instaweb[1]).
1134
1135checkout.defaultRemote::
1136        When you run 'git checkout <something>' and only have one
1137        remote, it may implicitly fall back on checking out and
1138        tracking e.g. 'origin/<something>'. This stops working as soon
1139        as you have more than one remote with a '<something>'
1140        reference. This setting allows for setting the name of a
1141        preferred remote that should always win when it comes to
1142        disambiguation. The typical use-case is to set this to
1143        `origin`.
1144+
1145Currently this is used by linkgit:git-checkout[1] when 'git checkout
1146<something>' will checkout the '<something>' branch on another remote,
1147and by linkgit:git-worktree[1] when 'git worktree add' refers to a
1148remote branch. This setting might be used for other checkout-like
1149commands or functionality in the future.
1150
1151clean.requireForce::
1152        A boolean to make git-clean do nothing unless given -f,
1153        -i or -n.   Defaults to true.
1154
1155color.advice::
1156        A boolean to enable/disable color in hints (e.g. when a push
1157        failed, see `advice.*` for a list).  May be set to `always`,
1158        `false` (or `never`) or `auto` (or `true`), in which case colors
1159        are used only when the error output goes to a terminal. If
1160        unset, then the value of `color.ui` is used (`auto` by default).
1161
1162color.advice.hint::
1163        Use customized color for hints.
1164
1165color.blame.highlightRecent::
1166        This can be used to color the metadata of a blame line depending
1167        on age of the line.
1168+
1169This setting should be set to a comma-separated list of color and date settings,
1170starting and ending with a color, the dates should be set from oldest to newest.
1171The metadata will be colored given the colors if the the line was introduced
1172before the given timestamp, overwriting older timestamped colors.
1173+
1174Instead of an absolute timestamp relative timestamps work as well, e.g.
11752.weeks.ago is valid to address anything older than 2 weeks.
1176+
1177It defaults to 'blue,12 month ago,white,1 month ago,red', which colors
1178everything older than one year blue, recent changes between one month and
1179one year old are kept white, and lines introduced within the last month are
1180colored red.
1181
1182color.blame.repeatedLines::
1183        Use the customized color for the part of git-blame output that
1184        is repeated meta information per line (such as commit id,
1185        author name, date and timezone). Defaults to cyan.
1186
1187color.branch::
1188        A boolean to enable/disable color in the output of
1189        linkgit:git-branch[1]. May be set to `always`,
1190        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1191        only when the output is to a terminal. If unset, then the
1192        value of `color.ui` is used (`auto` by default).
1193
1194color.branch.<slot>::
1195        Use customized color for branch coloration. `<slot>` is one of
1196        `current` (the current branch), `local` (a local branch),
1197        `remote` (a remote-tracking branch in refs/remotes/),
1198        `upstream` (upstream tracking branch), `plain` (other
1199        refs).
1200
1201color.diff::
1202        Whether to use ANSI escape sequences to add color to patches.
1203        If this is set to `always`, linkgit:git-diff[1],
1204        linkgit:git-log[1], and linkgit:git-show[1] will use color
1205        for all patches.  If it is set to `true` or `auto`, those
1206        commands will only use color when output is to the terminal.
1207        If unset, then the value of `color.ui` is used (`auto` by
1208        default).
1209+
1210This does not affect linkgit:git-format-patch[1] or the
1211'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
1212command line with the `--color[=<when>]` option.
1213
1214color.diff.<slot>::
1215        Use customized color for diff colorization.  `<slot>` specifies
1216        which part of the patch to use the specified color, and is one
1217        of `context` (context text - `plain` is a historical synonym),
1218        `meta` (metainformation), `frag`
1219        (hunk header), 'func' (function in hunk header), `old` (removed lines),
1220        `new` (added lines), `commit` (commit headers), `whitespace`
1221        (highlighting whitespace errors), `oldMoved` (deleted lines),
1222        `newMoved` (added lines), `oldMovedDimmed`, `oldMovedAlternative`,
1223        `oldMovedAlternativeDimmed`, `newMovedDimmed`, `newMovedAlternative`
1224        `newMovedAlternativeDimmed` (See the '<mode>'
1225        setting of '--color-moved' in linkgit:git-diff[1] for details),
1226        `contextDimmed`, `oldDimmed`, `newDimmed`, `contextBold`,
1227        `oldBold`, and `newBold` (see linkgit:git-range-diff[1] for details).
1228
1229color.decorate.<slot>::
1230        Use customized color for 'git log --decorate' output.  `<slot>` is one
1231        of `branch`, `remoteBranch`, `tag`, `stash` or `HEAD` for local
1232        branches, remote-tracking branches, tags, stash and HEAD, respectively
1233        and `grafted` for grafted commits.
1234
1235color.grep::
1236        When set to `always`, always highlight matches.  When `false` (or
1237        `never`), never.  When set to `true` or `auto`, use color only
1238        when the output is written to the terminal.  If unset, then the
1239        value of `color.ui` is used (`auto` by default).
1240
1241color.grep.<slot>::
1242        Use customized color for grep colorization.  `<slot>` specifies which
1243        part of the line to use the specified color, and is one of
1244+
1245--
1246`context`;;
1247        non-matching text in context lines (when using `-A`, `-B`, or `-C`)
1248`filename`;;
1249        filename prefix (when not using `-h`)
1250`function`;;
1251        function name lines (when using `-p`)
1252`lineNumber`;;
1253        line number prefix (when using `-n`)
1254`column`;;
1255        column number prefix (when using `--column`)
1256`match`;;
1257        matching text (same as setting `matchContext` and `matchSelected`)
1258`matchContext`;;
1259        matching text in context lines
1260`matchSelected`;;
1261        matching text in selected lines
1262`selected`;;
1263        non-matching text in selected lines
1264`separator`;;
1265        separators between fields on a line (`:`, `-`, and `=`)
1266        and between hunks (`--`)
1267--
1268
1269color.interactive::
1270        When set to `always`, always use colors for interactive prompts
1271        and displays (such as those used by "git-add --interactive" and
1272        "git-clean --interactive"). When false (or `never`), never.
1273        When set to `true` or `auto`, use colors only when the output is
1274        to the terminal. If unset, then the value of `color.ui` is
1275        used (`auto` by default).
1276
1277color.interactive.<slot>::
1278        Use customized color for 'git add --interactive' and 'git clean
1279        --interactive' output. `<slot>` may be `prompt`, `header`, `help`
1280        or `error`, for four distinct types of normal output from
1281        interactive commands.
1282
1283color.pager::
1284        A boolean to enable/disable colored output when the pager is in
1285        use (default is true).
1286
1287color.push::
1288        A boolean to enable/disable color in push errors. May be set to
1289        `always`, `false` (or `never`) or `auto` (or `true`), in which
1290        case colors are used only when the error output goes to a terminal.
1291        If unset, then the value of `color.ui` is used (`auto` by default).
1292
1293color.push.error::
1294        Use customized color for push errors.
1295
1296color.remote::
1297        If set, keywords at the start of the line are highlighted. The
1298        keywords are "error", "warning", "hint" and "success", and are
1299        matched case-insensitively. May be set to `always`, `false` (or
1300        `never`) or `auto` (or `true`). If unset, then the value of
1301        `color.ui` is used (`auto` by default).
1302
1303color.remote.<slot>::
1304        Use customized color for each remote keyword. `<slot>` may be
1305        `hint`, `warning`, `success` or `error` which match the
1306        corresponding keyword.
1307
1308color.showBranch::
1309        A boolean to enable/disable color in the output of
1310        linkgit:git-show-branch[1]. May be set to `always`,
1311        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1312        only when the output is to a terminal. If unset, then the
1313        value of `color.ui` is used (`auto` by default).
1314
1315color.status::
1316        A boolean to enable/disable color in the output of
1317        linkgit:git-status[1]. May be set to `always`,
1318        `false` (or `never`) or `auto` (or `true`), in which case colors are used
1319        only when the output is to a terminal. If unset, then the
1320        value of `color.ui` is used (`auto` by default).
1321
1322color.status.<slot>::
1323        Use customized color for status colorization. `<slot>` is
1324        one of `header` (the header text of the status message),
1325        `added` or `updated` (files which are added but not committed),
1326        `changed` (files which are changed but not added in the index),
1327        `untracked` (files which are not tracked by Git),
1328        `branch` (the current branch),
1329        `nobranch` (the color the 'no branch' warning is shown in, defaulting
1330        to red),
1331        `localBranch` or `remoteBranch` (the local and remote branch names,
1332        respectively, when branch and tracking information is displayed in the
1333        status short-format), or
1334        `unmerged` (files which have unmerged changes).
1335
1336color.transport::
1337        A boolean to enable/disable color when pushes are rejected. May be
1338        set to `always`, `false` (or `never`) or `auto` (or `true`), in which
1339        case colors are used only when the error output goes to a terminal.
1340        If unset, then the value of `color.ui` is used (`auto` by default).
1341
1342color.transport.rejected::
1343        Use customized color when a push was rejected.
1344
1345color.ui::
1346        This variable determines the default value for variables such
1347        as `color.diff` and `color.grep` that control the use of color
1348        per command family. Its scope will expand as more commands learn
1349        configuration to set a default for the `--color` option.  Set it
1350        to `false` or `never` if you prefer Git commands not to use
1351        color unless enabled explicitly with some other configuration
1352        or the `--color` option. Set it to `always` if you want all
1353        output not intended for machine consumption to use color, to
1354        `true` or `auto` (this is the default since Git 1.8.4) if you
1355        want such output to use color when written to the terminal.
1356
1357column.ui::
1358        Specify whether supported commands should output in columns.
1359        This variable consists of a list of tokens separated by spaces
1360        or commas:
1361+
1362These options control when the feature should be enabled
1363(defaults to 'never'):
1364+
1365--
1366`always`;;
1367        always show in columns
1368`never`;;
1369        never show in columns
1370`auto`;;
1371        show in columns if the output is to the terminal
1372--
1373+
1374These options control layout (defaults to 'column').  Setting any
1375of these implies 'always' if none of 'always', 'never', or 'auto' are
1376specified.
1377+
1378--
1379`column`;;
1380        fill columns before rows
1381`row`;;
1382        fill rows before columns
1383`plain`;;
1384        show in one column
1385--
1386+
1387Finally, these options can be combined with a layout option (defaults
1388to 'nodense'):
1389+
1390--
1391`dense`;;
1392        make unequal size columns to utilize more space
1393`nodense`;;
1394        make equal size columns
1395--
1396
1397column.branch::
1398        Specify whether to output branch listing in `git branch` in columns.
1399        See `column.ui` for details.
1400
1401column.clean::
1402        Specify the layout when list items in `git clean -i`, which always
1403        shows files and directories in columns. See `column.ui` for details.
1404
1405column.status::
1406        Specify whether to output untracked files in `git status` in columns.
1407        See `column.ui` for details.
1408
1409column.tag::
1410        Specify whether to output tag listing in `git tag` in columns.
1411        See `column.ui` for details.
1412
1413commit.cleanup::
1414        This setting overrides the default of the `--cleanup` option in
1415        `git commit`. See linkgit:git-commit[1] for details. Changing the
1416        default can be useful when you always want to keep lines that begin
1417        with comment character `#` in your log message, in which case you
1418        would do `git config commit.cleanup whitespace` (note that you will
1419        have to remove the help lines that begin with `#` in the commit log
1420        template yourself, if you do this).
1421
1422commit.gpgSign::
1423
1424        A boolean to specify whether all commits should be GPG signed.
1425        Use of this option when doing operations such as rebase can
1426        result in a large number of commits being signed. It may be
1427        convenient to use an agent to avoid typing your GPG passphrase
1428        several times.
1429
1430commit.status::
1431        A boolean to enable/disable inclusion of status information in the
1432        commit message template when using an editor to prepare the commit
1433        message.  Defaults to true.
1434
1435commit.template::
1436        Specify the pathname of a file to use as the template for
1437        new commit messages.
1438
1439commit.verbose::
1440        A boolean or int to specify the level of verbose with `git commit`.
1441        See linkgit:git-commit[1].
1442
1443credential.helper::
1444        Specify an external helper to be called when a username or
1445        password credential is needed; the helper may consult external
1446        storage to avoid prompting the user for the credentials. Note
1447        that multiple helpers may be defined. See linkgit:gitcredentials[7]
1448        for details.
1449
1450credential.useHttpPath::
1451        When acquiring credentials, consider the "path" component of an http
1452        or https URL to be important. Defaults to false. See
1453        linkgit:gitcredentials[7] for more information.
1454
1455credential.username::
1456        If no username is set for a network authentication, use this username
1457        by default. See credential.<context>.* below, and
1458        linkgit:gitcredentials[7].
1459
1460credential.<url>.*::
1461        Any of the credential.* options above can be applied selectively to
1462        some credentials. For example "credential.https://example.com.username"
1463        would set the default username only for https connections to
1464        example.com. See linkgit:gitcredentials[7] for details on how URLs are
1465        matched.
1466
1467credentialCache.ignoreSIGHUP::
1468        Tell git-credential-cache--daemon to ignore SIGHUP, instead of quitting.
1469
1470completion.commands::
1471        This is only used by git-completion.bash to add or remove
1472        commands from the list of completed commands. Normally only
1473        porcelain commands and a few select others are completed. You
1474        can add more commands, separated by space, in this
1475        variable. Prefixing the command with '-' will remove it from
1476        the existing list.
1477
1478include::diff-config.txt[]
1479
1480difftool.<tool>.path::
1481        Override the path for the given tool.  This is useful in case
1482        your tool is not in the PATH.
1483
1484difftool.<tool>.cmd::
1485        Specify the command to invoke the specified diff tool.
1486        The specified command is evaluated in shell with the following
1487        variables available:  'LOCAL' is set to the name of the temporary
1488        file containing the contents of the diff pre-image and 'REMOTE'
1489        is set to the name of the temporary file containing the contents
1490        of the diff post-image.
1491
1492difftool.prompt::
1493        Prompt before each invocation of the diff tool.
1494
1495fastimport.unpackLimit::
1496        If the number of objects imported by linkgit:git-fast-import[1]
1497        is below this limit, then the objects will be unpacked into
1498        loose object files.  However if the number of imported objects
1499        equals or exceeds this limit then the pack will be stored as a
1500        pack.  Storing the pack from a fast-import can make the import
1501        operation complete faster, especially on slow filesystems.  If
1502        not set, the value of `transfer.unpackLimit` is used instead.
1503
1504include::fetch-config.txt[]
1505
1506include::format-config.txt[]
1507
1508filter.<driver>.clean::
1509        The command which is used to convert the content of a worktree
1510        file to a blob upon checkin.  See linkgit:gitattributes[5] for
1511        details.
1512
1513filter.<driver>.smudge::
1514        The command which is used to convert the content of a blob
1515        object to a worktree file upon checkout.  See
1516        linkgit:gitattributes[5] for details.
1517
1518fsck.<msg-id>::
1519        During fsck git may find issues with legacy data which
1520        wouldn't be generated by current versions of git, and which
1521        wouldn't be sent over the wire if `transfer.fsckObjects` was
1522        set. This feature is intended to support working with legacy
1523        repositories containing such data.
1524+
1525Setting `fsck.<msg-id>` will be picked up by linkgit:git-fsck[1], but
1526to accept pushes of such data set `receive.fsck.<msg-id>` instead, or
1527to clone or fetch it set `fetch.fsck.<msg-id>`.
1528+
1529The rest of the documentation discusses `fsck.*` for brevity, but the
1530same applies for the corresponding `receive.fsck.*` and
1531`fetch.<msg-id>.*`. variables.
1532+
1533Unlike variables like `color.ui` and `core.editor` the
1534`receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>` variables will not
1535fall back on the `fsck.<msg-id>` configuration if they aren't set. To
1536uniformly configure the same fsck settings in different circumstances
1537all three of them they must all set to the same values.
1538+
1539When `fsck.<msg-id>` is set, errors can be switched to warnings and
1540vice versa by configuring the `fsck.<msg-id>` setting where the
1541`<msg-id>` is the fsck message ID and the value is one of `error`,
1542`warn` or `ignore`. For convenience, fsck prefixes the error/warning
1543with the message ID, e.g. "missingEmail: invalid author/committer line
1544- missing email" means that setting `fsck.missingEmail = ignore` will
1545hide that issue.
1546+
1547In general, it is better to enumerate existing objects with problems
1548with `fsck.skipList`, instead of listing the kind of breakages these
1549problematic objects share to be ignored, as doing the latter will
1550allow new instances of the same breakages go unnoticed.
1551+
1552Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
1553doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
1554will only cause git to warn.
1555
1556fsck.skipList::
1557        The path to a sorted list of object names (i.e. one SHA-1 per
1558        line) that are known to be broken in a non-fatal way and should
1559        be ignored. This feature is useful when an established project
1560        should be accepted despite early commits containing errors that
1561        can be safely ignored such as invalid committer email addresses.
1562        Note: corrupt objects cannot be skipped with this setting.
1563+
1564Like `fsck.<msg-id>` this variable has corresponding
1565`receive.fsck.skipList` and `fetch.fsck.skipList` variants.
1566+
1567Unlike variables like `color.ui` and `core.editor` the
1568`receive.fsck.skipList` and `fetch.fsck.skipList` variables will not
1569fall back on the `fsck.skipList` configuration if they aren't set. To
1570uniformly configure the same fsck settings in different circumstances
1571all three of them they must all set to the same values.
1572
1573gc.aggressiveDepth::
1574        The depth parameter used in the delta compression
1575        algorithm used by 'git gc --aggressive'.  This defaults
1576        to 50.
1577
1578gc.aggressiveWindow::
1579        The window size parameter used in the delta compression
1580        algorithm used by 'git gc --aggressive'.  This defaults
1581        to 250.
1582
1583gc.auto::
1584        When there are approximately more than this many loose
1585        objects in the repository, `git gc --auto` will pack them.
1586        Some Porcelain commands use this command to perform a
1587        light-weight garbage collection from time to time.  The
1588        default value is 6700.  Setting this to 0 disables it.
1589
1590gc.autoPackLimit::
1591        When there are more than this many packs that are not
1592        marked with `*.keep` file in the repository, `git gc
1593        --auto` consolidates them into one larger pack.  The
1594        default value is 50.  Setting this to 0 disables it.
1595
1596gc.autoDetach::
1597        Make `git gc --auto` return immediately and run in background
1598        if the system supports it. Default is true.
1599
1600gc.bigPackThreshold::
1601        If non-zero, all packs larger than this limit are kept when
1602        `git gc` is run. This is very similar to `--keep-base-pack`
1603        except that all packs that meet the threshold are kept, not
1604        just the base pack. Defaults to zero. Common unit suffixes of
1605        'k', 'm', or 'g' are supported.
1606+
1607Note that if the number of kept packs is more than gc.autoPackLimit,
1608this configuration variable is ignored, all packs except the base pack
1609will be repacked. After this the number of packs should go below
1610gc.autoPackLimit and gc.bigPackThreshold should be respected again.
1611
1612gc.writeCommitGraph::
1613        If true, then gc will rewrite the commit-graph file when
1614        linkgit:git-gc[1] is run. When using linkgit:git-gc[1]
1615        '--auto' the commit-graph will be updated if housekeeping is
1616        required. Default is false. See linkgit:git-commit-graph[1]
1617        for details.
1618
1619gc.logExpiry::
1620        If the file gc.log exists, then `git gc --auto` won't run
1621        unless that file is more than 'gc.logExpiry' old.  Default is
1622        "1.day".  See `gc.pruneExpire` for more ways to specify its
1623        value.
1624
1625gc.packRefs::
1626        Running `git pack-refs` in a repository renders it
1627        unclonable by Git versions prior to 1.5.1.2 over dumb
1628        transports such as HTTP.  This variable determines whether
1629        'git gc' runs `git pack-refs`. This can be set to `notbare`
1630        to enable it within all non-bare repos or it can be set to a
1631        boolean value.  The default is `true`.
1632
1633gc.pruneExpire::
1634        When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'.
1635        Override the grace period with this config variable.  The value
1636        "now" may be used to disable this grace period and always prune
1637        unreachable objects immediately, or "never" may be used to
1638        suppress pruning.  This feature helps prevent corruption when
1639        'git gc' runs concurrently with another process writing to the
1640        repository; see the "NOTES" section of linkgit:git-gc[1].
1641
1642gc.worktreePruneExpire::
1643        When 'git gc' is run, it calls
1644        'git worktree prune --expire 3.months.ago'.
1645        This config variable can be used to set a different grace
1646        period. The value "now" may be used to disable the grace
1647        period and prune `$GIT_DIR/worktrees` immediately, or "never"
1648        may be used to suppress pruning.
1649
1650gc.reflogExpire::
1651gc.<pattern>.reflogExpire::
1652        'git reflog expire' removes reflog entries older than
1653        this time; defaults to 90 days. The value "now" expires all
1654        entries immediately, and "never" suppresses expiration
1655        altogether. With "<pattern>" (e.g.
1656        "refs/stash") in the middle the setting applies only to
1657        the refs that match the <pattern>.
1658
1659gc.reflogExpireUnreachable::
1660gc.<pattern>.reflogExpireUnreachable::
1661        'git reflog expire' removes reflog entries older than
1662        this time and are not reachable from the current tip;
1663        defaults to 30 days. The value "now" expires all entries
1664        immediately, and "never" suppresses expiration altogether.
1665        With "<pattern>" (e.g. "refs/stash")
1666        in the middle, the setting applies only to the refs that
1667        match the <pattern>.
1668
1669gc.rerereResolved::
1670        Records of conflicted merge you resolved earlier are
1671        kept for this many days when 'git rerere gc' is run.
1672        You can also use more human-readable "1.month.ago", etc.
1673        The default is 60 days.  See linkgit:git-rerere[1].
1674
1675gc.rerereUnresolved::
1676        Records of conflicted merge you have not resolved are
1677        kept for this many days when 'git rerere gc' is run.
1678        You can also use more human-readable "1.month.ago", etc.
1679        The default is 15 days.  See linkgit:git-rerere[1].
1680
1681include::gitcvs-config.txt[]
1682
1683gitweb.category::
1684gitweb.description::
1685gitweb.owner::
1686gitweb.url::
1687        See linkgit:gitweb[1] for description.
1688
1689gitweb.avatar::
1690gitweb.blame::
1691gitweb.grep::
1692gitweb.highlight::
1693gitweb.patches::
1694gitweb.pickaxe::
1695gitweb.remote_heads::
1696gitweb.showSizes::
1697gitweb.snapshot::
1698        See linkgit:gitweb.conf[5] for description.
1699
1700grep.lineNumber::
1701        If set to true, enable `-n` option by default.
1702
1703grep.column::
1704        If set to true, enable the `--column` option by default.
1705
1706grep.patternType::
1707        Set the default matching behavior. Using a value of 'basic', 'extended',
1708        'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
1709        `--fixed-strings`, or `--perl-regexp` option accordingly, while the
1710        value 'default' will return to the default matching behavior.
1711
1712grep.extendedRegexp::
1713        If set to true, enable `--extended-regexp` option by default. This
1714        option is ignored when the `grep.patternType` option is set to a value
1715        other than 'default'.
1716
1717grep.threads::
1718        Number of grep worker threads to use.
1719        See `grep.threads` in linkgit:git-grep[1] for more information.
1720
1721grep.fallbackToNoIndex::
1722        If set to true, fall back to git grep --no-index if git grep
1723        is executed outside of a git repository.  Defaults to false.
1724
1725gpg.program::
1726        Use this custom program instead of "`gpg`" found on `$PATH` when
1727        making or verifying a PGP signature. The program must support the
1728        same command-line interface as GPG, namely, to verify a detached
1729        signature, "`gpg --verify $file - <$signature`" is run, and the
1730        program is expected to signal a good signature by exiting with
1731        code 0, and to generate an ASCII-armored detached signature, the
1732        standard input of "`gpg -bsau $key`" is fed with the contents to be
1733        signed, and the program is expected to send the result to its
1734        standard output.
1735
1736gpg.format::
1737        Specifies which key format to use when signing with `--gpg-sign`.
1738        Default is "openpgp" and another possible value is "x509".
1739
1740gpg.<format>.program::
1741        Use this to customize the program used for the signing format you
1742        chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still
1743        be used as a legacy synonym for `gpg.openpgp.program`. The default
1744        value for `gpg.x509.program` is "gpgsm".
1745
1746include::gui-config.txt[]
1747
1748guitool.<name>.cmd::
1749        Specifies the shell command line to execute when the corresponding item
1750        of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
1751        mandatory for every tool. The command is executed from the root of
1752        the working directory, and in the environment it receives the name of
1753        the tool as `GIT_GUITOOL`, the name of the currently selected file as
1754        'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
1755        the head is detached, 'CUR_BRANCH' is empty).
1756
1757guitool.<name>.needsFile::
1758        Run the tool only if a diff is selected in the GUI. It guarantees
1759        that 'FILENAME' is not empty.
1760
1761guitool.<name>.noConsole::
1762        Run the command silently, without creating a window to display its
1763        output.
1764
1765guitool.<name>.noRescan::
1766        Don't rescan the working directory for changes after the tool
1767        finishes execution.
1768
1769guitool.<name>.confirm::
1770        Show a confirmation dialog before actually running the tool.
1771
1772guitool.<name>.argPrompt::
1773        Request a string argument from the user, and pass it to the tool
1774        through the `ARGS` environment variable. Since requesting an
1775        argument implies confirmation, the 'confirm' option has no effect
1776        if this is enabled. If the option is set to 'true', 'yes', or '1',
1777        the dialog uses a built-in generic prompt; otherwise the exact
1778        value of the variable is used.
1779
1780guitool.<name>.revPrompt::
1781        Request a single valid revision from the user, and set the
1782        `REVISION` environment variable. In other aspects this option
1783        is similar to 'argPrompt', and can be used together with it.
1784
1785guitool.<name>.revUnmerged::
1786        Show only unmerged branches in the 'revPrompt' subdialog.
1787        This is useful for tools similar to merge or rebase, but not
1788        for things like checkout or reset.
1789
1790guitool.<name>.title::
1791        Specifies the title to use for the prompt dialog. The default
1792        is the tool name.
1793
1794guitool.<name>.prompt::
1795        Specifies the general prompt string to display at the top of
1796        the dialog, before subsections for 'argPrompt' and 'revPrompt'.
1797        The default value includes the actual command.
1798
1799help.browser::
1800        Specify the browser that will be used to display help in the
1801        'web' format. See linkgit:git-help[1].
1802
1803help.format::
1804        Override the default help format used by linkgit:git-help[1].
1805        Values 'man', 'info', 'web' and 'html' are supported. 'man' is
1806        the default. 'web' and 'html' are the same.
1807
1808help.autoCorrect::
1809        Automatically correct and execute mistyped commands after
1810        waiting for the given number of deciseconds (0.1 sec). If more
1811        than one command can be deduced from the entered text, nothing
1812        will be executed.  If the value of this option is negative,
1813        the corrected command will be executed immediately. If the
1814        value is 0 - the command will be just shown but not executed.
1815        This is the default.
1816
1817help.htmlPath::
1818        Specify the path where the HTML documentation resides. File system paths
1819        and URLs are supported. HTML pages will be prefixed with this path when
1820        help is displayed in the 'web' format. This defaults to the documentation
1821        path of your Git installation.
1822
1823http.proxy::
1824        Override the HTTP proxy, normally configured using the 'http_proxy',
1825        'https_proxy', and 'all_proxy' environment variables (see `curl(1)`). In
1826        addition to the syntax understood by curl, it is possible to specify a
1827        proxy string with a user name but no password, in which case git will
1828        attempt to acquire one in the same way it does for other credentials. See
1829        linkgit:gitcredentials[7] for more information. The syntax thus is
1830        '[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
1831        on a per-remote basis; see remote.<name>.proxy
1832
1833http.proxyAuthMethod::
1834        Set the method with which to authenticate against the HTTP proxy. This
1835        only takes effect if the configured proxy string contains a user name part
1836        (i.e. is of the form 'user@host' or 'user@host:port'). This can be
1837        overridden on a per-remote basis; see `remote.<name>.proxyAuthMethod`.
1838        Both can be overridden by the `GIT_HTTP_PROXY_AUTHMETHOD` environment
1839        variable.  Possible values are:
1840+
1841--
1842* `anyauth` - Automatically pick a suitable authentication method. It is
1843  assumed that the proxy answers an unauthenticated request with a 407
1844  status code and one or more Proxy-authenticate headers with supported
1845  authentication methods. This is the default.
1846* `basic` - HTTP Basic authentication
1847* `digest` - HTTP Digest authentication; this prevents the password from being
1848  transmitted to the proxy in clear text
1849* `negotiate` - GSS-Negotiate authentication (compare the --negotiate option
1850  of `curl(1)`)
1851* `ntlm` - NTLM authentication (compare the --ntlm option of `curl(1)`)
1852--
1853
1854http.emptyAuth::
1855        Attempt authentication without seeking a username or password.  This
1856        can be used to attempt GSS-Negotiate authentication without specifying
1857        a username in the URL, as libcurl normally requires a username for
1858        authentication.
1859
1860http.delegation::
1861        Control GSSAPI credential delegation. The delegation is disabled
1862        by default in libcurl since version 7.21.7. Set parameter to tell
1863        the server what it is allowed to delegate when it comes to user
1864        credentials. Used with GSS/kerberos. Possible values are:
1865+
1866--
1867* `none` - Don't allow any delegation.
1868* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
1869  Kerberos service ticket, which is a matter of realm policy.
1870* `always` - Unconditionally allow the server to delegate.
1871--
1872
1873
1874http.extraHeader::
1875        Pass an additional HTTP header when communicating with a server.  If
1876        more than one such entry exists, all of them are added as extra
1877        headers.  To allow overriding the settings inherited from the system
1878        config, an empty value will reset the extra headers to the empty list.
1879
1880http.cookieFile::
1881        The pathname of a file containing previously stored cookie lines,
1882        which should be used
1883        in the Git http session, if they match the server. The file format
1884        of the file to read cookies from should be plain HTTP headers or
1885        the Netscape/Mozilla cookie file format (see `curl(1)`).
1886        NOTE that the file specified with http.cookieFile is used only as
1887        input unless http.saveCookies is set.
1888
1889http.saveCookies::
1890        If set, store cookies received during requests to the file specified by
1891        http.cookieFile. Has no effect if http.cookieFile is unset.
1892
1893http.sslVersion::
1894        The SSL version to use when negotiating an SSL connection, if you
1895        want to force the default.  The available and default version
1896        depend on whether libcurl was built against NSS or OpenSSL and the
1897        particular configuration of the crypto library in use. Internally
1898        this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl
1899        documentation for more details on the format of this option and
1900        for the ssl version supported. Actually the possible values of
1901        this option are:
1902
1903        - sslv2
1904        - sslv3
1905        - tlsv1
1906        - tlsv1.0
1907        - tlsv1.1
1908        - tlsv1.2
1909        - tlsv1.3
1910
1911+
1912Can be overridden by the `GIT_SSL_VERSION` environment variable.
1913To force git to use libcurl's default ssl version and ignore any
1914explicit http.sslversion option, set `GIT_SSL_VERSION` to the
1915empty string.
1916
1917http.sslCipherList::
1918  A list of SSL ciphers to use when negotiating an SSL connection.
1919  The available ciphers depend on whether libcurl was built against
1920  NSS or OpenSSL and the particular configuration of the crypto
1921  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
1922  option; see the libcurl documentation for more details on the format
1923  of this list.
1924+
1925Can be overridden by the `GIT_SSL_CIPHER_LIST` environment variable.
1926To force git to use libcurl's default cipher list and ignore any
1927explicit http.sslCipherList option, set `GIT_SSL_CIPHER_LIST` to the
1928empty string.
1929
1930http.sslVerify::
1931        Whether to verify the SSL certificate when fetching or pushing
1932        over HTTPS. Defaults to true. Can be overridden by the
1933        `GIT_SSL_NO_VERIFY` environment variable.
1934
1935http.sslCert::
1936        File containing the SSL certificate when fetching or pushing
1937        over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
1938        variable.
1939
1940http.sslKey::
1941        File containing the SSL private key when fetching or pushing
1942        over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
1943        variable.
1944
1945http.sslCertPasswordProtected::
1946        Enable Git's password prompt for the SSL certificate.  Otherwise
1947        OpenSSL will prompt the user, possibly many times, if the
1948        certificate or private key is encrypted.  Can be overridden by the
1949        `GIT_SSL_CERT_PASSWORD_PROTECTED` environment variable.
1950
1951http.sslCAInfo::
1952        File containing the certificates to verify the peer with when
1953        fetching or pushing over HTTPS. Can be overridden by the
1954        `GIT_SSL_CAINFO` environment variable.
1955
1956http.sslCAPath::
1957        Path containing files with the CA certificates to verify the peer
1958        with when fetching or pushing over HTTPS. Can be overridden
1959        by the `GIT_SSL_CAPATH` environment variable.
1960
1961http.pinnedpubkey::
1962        Public key of the https service. It may either be the filename of
1963        a PEM or DER encoded public key file or a string starting with
1964        'sha256//' followed by the base64 encoded sha256 hash of the
1965        public key. See also libcurl 'CURLOPT_PINNEDPUBLICKEY'. git will
1966        exit with an error if this option is set but not supported by
1967        cURL.
1968
1969http.sslTry::
1970        Attempt to use AUTH SSL/TLS and encrypted data transfers
1971        when connecting via regular FTP protocol. This might be needed
1972        if the FTP server requires it for security reasons or you wish
1973        to connect securely whenever remote FTP server supports it.
1974        Default is false since it might trigger certificate verification
1975        errors on misconfigured servers.
1976
1977http.maxRequests::
1978        How many HTTP requests to launch in parallel. Can be overridden
1979        by the `GIT_HTTP_MAX_REQUESTS` environment variable. Default is 5.
1980
1981http.minSessions::
1982        The number of curl sessions (counted across slots) to be kept across
1983        requests. They will not be ended with curl_easy_cleanup() until
1984        http_cleanup() is invoked. If USE_CURL_MULTI is not defined, this
1985        value will be capped at 1. Defaults to 1.
1986
1987http.postBuffer::
1988        Maximum size in bytes of the buffer used by smart HTTP
1989        transports when POSTing data to the remote system.
1990        For requests larger than this buffer size, HTTP/1.1 and
1991        Transfer-Encoding: chunked is used to avoid creating a
1992        massive pack file locally.  Default is 1 MiB, which is
1993        sufficient for most requests.
1994
1995http.lowSpeedLimit, http.lowSpeedTime::
1996        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
1997        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
1998        Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and
1999        `GIT_HTTP_LOW_SPEED_TIME` environment variables.
2000
2001http.noEPSV::
2002        A boolean which disables using of EPSV ftp command by curl.
2003        This can helpful with some "poor" ftp servers which don't
2004        support EPSV mode. Can be overridden by the `GIT_CURL_FTP_NO_EPSV`
2005        environment variable. Default is false (curl will use EPSV).
2006
2007http.userAgent::
2008        The HTTP USER_AGENT string presented to an HTTP server.  The default
2009        value represents the version of the client Git such as git/1.7.1.
2010        This option allows you to override this value to a more common value
2011        such as Mozilla/4.0.  This may be necessary, for instance, if
2012        connecting through a firewall that restricts HTTP connections to a set
2013        of common USER_AGENT strings (but not including those like git/1.7.1).
2014        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
2015
2016http.followRedirects::
2017        Whether git should follow HTTP redirects. If set to `true`, git
2018        will transparently follow any redirect issued by a server it
2019        encounters. If set to `false`, git will treat all redirects as
2020        errors. If set to `initial`, git will follow redirects only for
2021        the initial request to a remote, but not for subsequent
2022        follow-up HTTP requests. Since git uses the redirected URL as
2023        the base for the follow-up requests, this is generally
2024        sufficient. The default is `initial`.
2025
2026http.<url>.*::
2027        Any of the http.* options above can be applied selectively to some URLs.
2028        For a config key to match a URL, each element of the config key is
2029        compared to that of the URL, in the following order:
2030+
2031--
2032. Scheme (e.g., `https` in `https://example.com/`). This field
2033  must match exactly between the config key and the URL.
2034
2035. Host/domain name (e.g., `example.com` in `https://example.com/`).
2036  This field must match between the config key and the URL. It is
2037  possible to specify a `*` as part of the host name to match all subdomains
2038  at this level. `https://*.example.com/` for example would match
2039  `https://foo.example.com/`, but not `https://foo.bar.example.com/`.
2040
2041. Port number (e.g., `8080` in `http://example.com:8080/`).
2042  This field must match exactly between the config key and the URL.
2043  Omitted port numbers are automatically converted to the correct
2044  default for the scheme before matching.
2045
2046. Path (e.g., `repo.git` in `https://example.com/repo.git`). The
2047  path field of the config key must match the path field of the URL
2048  either exactly or as a prefix of slash-delimited path elements.  This means
2049  a config key with path `foo/` matches URL path `foo/bar`.  A prefix can only
2050  match on a slash (`/`) boundary.  Longer matches take precedence (so a config
2051  key with path `foo/bar` is a better match to URL path `foo/bar` than a config
2052  key with just path `foo/`).
2053
2054. User name (e.g., `user` in `https://user@example.com/repo.git`). If
2055  the config key has a user name it must match the user name in the
2056  URL exactly. If the config key does not have a user name, that
2057  config key will match a URL with any user name (including none),
2058  but at a lower precedence than a config key with a user name.
2059--
2060+
2061The list above is ordered by decreasing precedence; a URL that matches
2062a config key's path is preferred to one that matches its user name. For example,
2063if the URL is `https://user@example.com/foo/bar` a config key match of
2064`https://example.com/foo` will be preferred over a config key match of
2065`https://user@example.com`.
2066+
2067All URLs are normalized before attempting any matching (the password part,
2068if embedded in the URL, is always ignored for matching purposes) so that
2069equivalent URLs that are simply spelled differently will match properly.
2070Environment variable settings always override any matches.  The URLs that are
2071matched against are those given directly to Git commands.  This means any URLs
2072visited as a result of a redirection do not participate in matching.
2073
2074ssh.variant::
2075        By default, Git determines the command line arguments to use
2076        based on the basename of the configured SSH command (configured
2077        using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
2078        the config setting `core.sshCommand`). If the basename is
2079        unrecognized, Git will attempt to detect support of OpenSSH
2080        options by first invoking the configured SSH command with the
2081        `-G` (print configuration) option and will subsequently use
2082        OpenSSH options (if that is successful) or no options besides
2083        the host and remote command (if it fails).
2084+
2085The config variable `ssh.variant` can be set to override this detection.
2086Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
2087`tortoiseplink`, `simple` (no options except the host and remote command).
2088The default auto-detection can be explicitly requested using the value
2089`auto`.  Any other value is treated as `ssh`.  This setting can also be
2090overridden via the environment variable `GIT_SSH_VARIANT`.
2091+
2092The current command-line parameters used for each variant are as
2093follows:
2094+
2095--
2096
2097* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
2098
2099* `simple` - [username@]host command
2100
2101* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
2102
2103* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
2104
2105--
2106+
2107Except for the `simple` variant, command-line parameters are likely to
2108change as git gains new features.
2109
2110i18n.commitEncoding::
2111        Character encoding the commit messages are stored in; Git itself
2112        does not care per se, but this information is necessary e.g. when
2113        importing commits from emails or in the gitk graphical history
2114        browser (and possibly at other places in the future or in other
2115        porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'.
2116
2117i18n.logOutputEncoding::
2118        Character encoding the commit messages are converted to when
2119        running 'git log' and friends.
2120
2121imap::
2122        The configuration variables in the 'imap' section are described
2123        in linkgit:git-imap-send[1].
2124
2125index.version::
2126        Specify the version with which new index files should be
2127        initialized.  This does not affect existing repositories.
2128
2129init.templateDir::
2130        Specify the directory from which templates will be copied.
2131        (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
2132
2133instaweb.browser::
2134        Specify the program that will be used to browse your working
2135        repository in gitweb. See linkgit:git-instaweb[1].
2136
2137instaweb.httpd::
2138        The HTTP daemon command-line to start gitweb on your working
2139        repository. See linkgit:git-instaweb[1].
2140
2141instaweb.local::
2142        If true the web server started by linkgit:git-instaweb[1] will
2143        be bound to the local IP (127.0.0.1).
2144
2145instaweb.modulePath::
2146        The default module path for linkgit:git-instaweb[1] to use
2147        instead of /usr/lib/apache2/modules.  Only used if httpd
2148        is Apache.
2149
2150instaweb.port::
2151        The port number to bind the gitweb httpd to. See
2152        linkgit:git-instaweb[1].
2153
2154interactive.singleKey::
2155        In interactive commands, allow the user to provide one-letter
2156        input with a single key (i.e., without hitting enter).
2157        Currently this is used by the `--patch` mode of
2158        linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
2159        linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
2160        setting is silently ignored if portable keystroke input
2161        is not available; requires the Perl module Term::ReadKey.
2162
2163interactive.diffFilter::
2164        When an interactive command (such as `git add --patch`) shows
2165        a colorized diff, git will pipe the diff through the shell
2166        command defined by this configuration variable. The command may
2167        mark up the diff further for human consumption, provided that it
2168        retains a one-to-one correspondence with the lines in the
2169        original diff. Defaults to disabled (no filtering).
2170
2171log.abbrevCommit::
2172        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2173        linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
2174        override this option with `--no-abbrev-commit`.
2175
2176log.date::
2177        Set the default date-time mode for the 'log' command.
2178        Setting a value for log.date is similar to using 'git log''s
2179        `--date` option.  See linkgit:git-log[1] for details.
2180
2181log.decorate::
2182        Print out the ref names of any commits that are shown by the log
2183        command. If 'short' is specified, the ref name prefixes 'refs/heads/',
2184        'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
2185        specified, the full ref name (including prefix) will be printed.
2186        If 'auto' is specified, then if the output is going to a terminal,
2187        the ref names are shown as if 'short' were given, otherwise no ref
2188        names are shown. This is the same as the `--decorate` option
2189        of the `git log`.
2190
2191log.follow::
2192        If `true`, `git log` will act as if the `--follow` option was used when
2193        a single <path> is given.  This has the same limitations as `--follow`,
2194        i.e. it cannot be used to follow multiple files and does not work well
2195        on non-linear history.
2196
2197log.graphColors::
2198        A list of colors, separated by commas, that can be used to draw
2199        history lines in `git log --graph`.
2200
2201log.showRoot::
2202        If true, the initial commit will be shown as a big creation event.
2203        This is equivalent to a diff against an empty tree.
2204        Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which
2205        normally hide the root commit will now show it. True by default.
2206
2207log.showSignature::
2208        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2209        linkgit:git-whatchanged[1] assume `--show-signature`.
2210
2211log.mailmap::
2212        If true, makes linkgit:git-log[1], linkgit:git-show[1], and
2213        linkgit:git-whatchanged[1] assume `--use-mailmap`.
2214
2215mailinfo.scissors::
2216        If true, makes linkgit:git-mailinfo[1] (and therefore
2217        linkgit:git-am[1]) act by default as if the --scissors option
2218        was provided on the command-line. When active, this features
2219        removes everything from the message body before a scissors
2220        line (i.e. consisting mainly of ">8", "8<" and "-").
2221
2222mailmap.file::
2223        The location of an augmenting mailmap file. The default
2224        mailmap, located in the root of the repository, is loaded
2225        first, then the mailmap file pointed to by this variable.
2226        The location of the mailmap file may be in a repository
2227        subdirectory, or somewhere outside of the repository itself.
2228        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
2229
2230mailmap.blob::
2231        Like `mailmap.file`, but consider the value as a reference to a
2232        blob in the repository. If both `mailmap.file` and
2233        `mailmap.blob` are given, both are parsed, with entries from
2234        `mailmap.file` taking precedence. In a bare repository, this
2235        defaults to `HEAD:.mailmap`. In a non-bare repository, it
2236        defaults to empty.
2237
2238man.viewer::
2239        Specify the programs that may be used to display help in the
2240        'man' format. See linkgit:git-help[1].
2241
2242man.<tool>.cmd::
2243        Specify the command to invoke the specified man viewer. The
2244        specified command is evaluated in shell with the man page
2245        passed as argument. (See linkgit:git-help[1].)
2246
2247man.<tool>.path::
2248        Override the path for the given tool that may be used to
2249        display help in the 'man' format. See linkgit:git-help[1].
2250
2251include::merge-config.txt[]
2252
2253mergetool.<tool>.path::
2254        Override the path for the given tool.  This is useful in case
2255        your tool is not in the PATH.
2256
2257mergetool.<tool>.cmd::
2258        Specify the command to invoke the specified merge tool.  The
2259        specified command is evaluated in shell with the following
2260        variables available: 'BASE' is the name of a temporary file
2261        containing the common base of the files to be merged, if available;
2262        'LOCAL' is the name of a temporary file containing the contents of
2263        the file on the current branch; 'REMOTE' is the name of a temporary
2264        file containing the contents of the file from the branch being
2265        merged; 'MERGED' contains the name of the file to which the merge
2266        tool should write the results of a successful merge.
2267
2268mergetool.<tool>.trustExitCode::
2269        For a custom merge command, specify whether the exit code of
2270        the merge command can be used to determine whether the merge was
2271        successful.  If this is not set to true then the merge target file
2272        timestamp is checked and the merge assumed to have been successful
2273        if the file has been updated, otherwise the user is prompted to
2274        indicate the success of the merge.
2275
2276mergetool.meld.hasOutput::
2277        Older versions of `meld` do not support the `--output` option.
2278        Git will attempt to detect whether `meld` supports `--output`
2279        by inspecting the output of `meld --help`.  Configuring
2280        `mergetool.meld.hasOutput` will make Git skip these checks and
2281        use the configured value instead.  Setting `mergetool.meld.hasOutput`
2282        to `true` tells Git to unconditionally use the `--output` option,
2283        and `false` avoids using `--output`.
2284
2285mergetool.keepBackup::
2286        After performing a merge, the original file with conflict markers
2287        can be saved as a file with a `.orig` extension.  If this variable
2288        is set to `false` then this file is not preserved.  Defaults to
2289        `true` (i.e. keep the backup files).
2290
2291mergetool.keepTemporaries::
2292        When invoking a custom merge tool, Git uses a set of temporary
2293        files to pass to the tool. If the tool returns an error and this
2294        variable is set to `true`, then these temporary files will be
2295        preserved, otherwise they will be removed after the tool has
2296        exited. Defaults to `false`.
2297
2298mergetool.writeToTemp::
2299        Git writes temporary 'BASE', 'LOCAL', and 'REMOTE' versions of
2300        conflicting files in the worktree by default.  Git will attempt
2301        to use a temporary directory for these files when set `true`.
2302        Defaults to `false`.
2303
2304mergetool.prompt::
2305        Prompt before each invocation of the merge resolution program.
2306
2307notes.mergeStrategy::
2308        Which merge strategy to choose by default when resolving notes
2309        conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
2310        `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
2311        section of linkgit:git-notes[1] for more information on each strategy.
2312
2313notes.<name>.mergeStrategy::
2314        Which merge strategy to choose when doing a notes merge into
2315        refs/notes/<name>.  This overrides the more general
2316        "notes.mergeStrategy".  See the "NOTES MERGE STRATEGIES" section in
2317        linkgit:git-notes[1] for more information on the available strategies.
2318
2319notes.displayRef::
2320        The (fully qualified) refname from which to show notes when
2321        showing commit messages.  The value of this variable can be set
2322        to a glob, in which case notes from all matching refs will be
2323        shown.  You may also specify this configuration variable
2324        several times.  A warning will be issued for refs that do not
2325        exist, but a glob that does not match any refs is silently
2326        ignored.
2327+
2328This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
2329environment variable, which must be a colon separated list of refs or
2330globs.
2331+
2332The effective value of "core.notesRef" (possibly overridden by
2333GIT_NOTES_REF) is also implicitly added to the list of refs to be
2334displayed.
2335
2336notes.rewrite.<command>::
2337        When rewriting commits with <command> (currently `amend` or
2338        `rebase`) and this variable is set to `true`, Git
2339        automatically copies your notes from the original to the
2340        rewritten commit.  Defaults to `true`, but see
2341        "notes.rewriteRef" below.
2342
2343notes.rewriteMode::
2344        When copying notes during a rewrite (see the
2345        "notes.rewrite.<command>" option), determines what to do if
2346        the target commit already has a note.  Must be one of
2347        `overwrite`, `concatenate`, `cat_sort_uniq`, or `ignore`.
2348        Defaults to `concatenate`.
2349+
2350This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
2351environment variable.
2352
2353notes.rewriteRef::
2354        When copying notes during a rewrite, specifies the (fully
2355        qualified) ref whose notes should be copied.  The ref may be a
2356        glob, in which case notes in all matching refs will be copied.
2357        You may also specify this configuration several times.
2358+
2359Does not have a default value; you must configure this variable to
2360enable note rewriting.  Set it to `refs/notes/commits` to enable
2361rewriting for the default commit notes.
2362+
2363This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
2364environment variable, which must be a colon separated list of refs or
2365globs.
2366
2367pack.window::
2368        The size of the window used by linkgit:git-pack-objects[1] when no
2369        window size is given on the command line. Defaults to 10.
2370
2371pack.depth::
2372        The maximum delta depth used by linkgit:git-pack-objects[1] when no
2373        maximum depth is given on the command line. Defaults to 50.
2374        Maximum value is 4095.
2375
2376pack.windowMemory::
2377        The maximum size of memory that is consumed by each thread
2378        in linkgit:git-pack-objects[1] for pack window memory when
2379        no limit is given on the command line.  The value can be
2380        suffixed with "k", "m", or "g".  When left unconfigured (or
2381        set explicitly to 0), there will be no limit.
2382
2383pack.compression::
2384        An integer -1..9, indicating the compression level for objects
2385        in a pack file. -1 is the zlib default. 0 means no
2386        compression, and 1..9 are various speed/size tradeoffs, 9 being
2387        slowest.  If not set,  defaults to core.compression.  If that is
2388        not set,  defaults to -1, the zlib default, which is "a default
2389        compromise between speed and compression (currently equivalent
2390        to level 6)."
2391+
2392Note that changing the compression level will not automatically recompress
2393all existing objects. You can force recompression by passing the -F option
2394to linkgit:git-repack[1].
2395
2396pack.deltaCacheSize::
2397        The maximum memory in bytes used for caching deltas in
2398        linkgit:git-pack-objects[1] before writing them out to a pack.
2399        This cache is used to speed up the writing object phase by not
2400        having to recompute the final delta result once the best match
2401        for all objects is found.  Repacking large repositories on machines
2402        which are tight with memory might be badly impacted by this though,
2403        especially if this cache pushes the system into swapping.
2404        A value of 0 means no limit. The smallest size of 1 byte may be
2405        used to virtually disable this cache. Defaults to 256 MiB.
2406
2407pack.deltaCacheLimit::
2408        The maximum size of a delta, that is cached in
2409        linkgit:git-pack-objects[1]. This cache is used to speed up the
2410        writing object phase by not having to recompute the final delta
2411        result once the best match for all objects is found.
2412        Defaults to 1000. Maximum value is 65535.
2413
2414pack.threads::
2415        Specifies the number of threads to spawn when searching for best
2416        delta matches.  This requires that linkgit:git-pack-objects[1]
2417        be compiled with pthreads otherwise this option is ignored with a
2418        warning. This is meant to reduce packing time on multiprocessor
2419        machines. The required amount of memory for the delta search window
2420        is however multiplied by the number of threads.
2421        Specifying 0 will cause Git to auto-detect the number of CPU's
2422        and set the number of threads accordingly.
2423
2424pack.indexVersion::
2425        Specify the default pack index version.  Valid values are 1 for
2426        legacy pack index used by Git versions prior to 1.5.2, and 2 for
2427        the new pack index with capabilities for packs larger than 4 GB
2428        as well as proper protection against the repacking of corrupted
2429        packs.  Version 2 is the default.  Note that version 2 is enforced
2430        and this config option ignored whenever the corresponding pack is
2431        larger than 2 GB.
2432+
2433If you have an old Git that does not understand the version 2 `*.idx` file,
2434cloning or fetching over a non native protocol (e.g. "http")
2435that will copy both `*.pack` file and corresponding `*.idx` file from the
2436other side may give you a repository that cannot be accessed with your
2437older version of Git. If the `*.pack` file is smaller than 2 GB, however,
2438you can use linkgit:git-index-pack[1] on the *.pack file to regenerate
2439the `*.idx` file.
2440
2441pack.packSizeLimit::
2442        The maximum size of a pack.  This setting only affects
2443        packing to a file when repacking, i.e. the git:// protocol
2444        is unaffected.  It can be overridden by the `--max-pack-size`
2445        option of linkgit:git-repack[1].  Reaching this limit results
2446        in the creation of multiple packfiles; which in turn prevents
2447        bitmaps from being created.
2448        The minimum size allowed is limited to 1 MiB.
2449        The default is unlimited.
2450        Common unit suffixes of 'k', 'm', or 'g' are
2451        supported.
2452
2453pack.useBitmaps::
2454        When true, git will use pack bitmaps (if available) when packing
2455        to stdout (e.g., during the server side of a fetch). Defaults to
2456        true. You should not generally need to turn this off unless
2457        you are debugging pack bitmaps.
2458
2459pack.writeBitmaps (deprecated)::
2460        This is a deprecated synonym for `repack.writeBitmaps`.
2461
2462pack.writeBitmapHashCache::
2463        When true, git will include a "hash cache" section in the bitmap
2464        index (if one is written). This cache can be used to feed git's
2465        delta heuristics, potentially leading to better deltas between
2466        bitmapped and non-bitmapped objects (e.g., when serving a fetch
2467        between an older, bitmapped pack and objects that have been
2468        pushed since the last gc). The downside is that it consumes 4
2469        bytes per object of disk space, and that JGit's bitmap
2470        implementation does not understand it, causing it to complain if
2471        Git and JGit are used on the same repository. Defaults to false.
2472
2473pager.<cmd>::
2474        If the value is boolean, turns on or off pagination of the
2475        output of a particular Git subcommand when writing to a tty.
2476        Otherwise, turns on pagination for the subcommand using the
2477        pager specified by the value of `pager.<cmd>`.  If `--paginate`
2478        or `--no-pager` is specified on the command line, it takes
2479        precedence over this option.  To disable pagination for all
2480        commands, set `core.pager` or `GIT_PAGER` to `cat`.
2481
2482pretty.<name>::
2483        Alias for a --pretty= format string, as specified in
2484        linkgit:git-log[1]. Any aliases defined here can be used just
2485        as the built-in pretty formats could. For example,
2486        running `git config pretty.changelog "format:* %H %s"`
2487        would cause the invocation `git log --pretty=changelog`
2488        to be equivalent to running `git log "--pretty=format:* %H %s"`.
2489        Note that an alias with the same name as a built-in format
2490        will be silently ignored.
2491
2492protocol.allow::
2493        If set, provide a user defined default policy for all protocols which
2494        don't explicitly have a policy (`protocol.<name>.allow`).  By default,
2495        if unset, known-safe protocols (http, https, git, ssh, file) have a
2496        default policy of `always`, known-dangerous protocols (ext) have a
2497        default policy of `never`, and all other protocols have a default
2498        policy of `user`.  Supported policies:
2499+
2500--
2501
2502* `always` - protocol is always able to be used.
2503
2504* `never` - protocol is never able to be used.
2505
2506* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
2507  either unset or has a value of 1.  This policy should be used when you want a
2508  protocol to be directly usable by the user but don't want it used by commands which
2509  execute clone/fetch/push commands without user input, e.g. recursive
2510  submodule initialization.
2511
2512--
2513
2514protocol.<name>.allow::
2515        Set a policy to be used by protocol `<name>` with clone/fetch/push
2516        commands. See `protocol.allow` above for the available policies.
2517+
2518The protocol names currently used by git are:
2519+
2520--
2521  - `file`: any local file-based path (including `file://` URLs,
2522    or local paths)
2523
2524  - `git`: the anonymous git protocol over a direct TCP
2525    connection (or proxy, if configured)
2526
2527  - `ssh`: git over ssh (including `host:path` syntax,
2528    `ssh://`, etc).
2529
2530  - `http`: git over http, both "smart http" and "dumb http".
2531    Note that this does _not_ include `https`; if you want to configure
2532    both, you must do so individually.
2533
2534  - any external helpers are named by their protocol (e.g., use
2535    `hg` to allow the `git-remote-hg` helper)
2536--
2537
2538protocol.version::
2539        Experimental. If set, clients will attempt to communicate with a
2540        server using the specified protocol version.  If unset, no
2541        attempt will be made by the client to communicate using a
2542        particular protocol version, this results in protocol version 0
2543        being used.
2544        Supported versions:
2545+
2546--
2547
2548* `0` - the original wire protocol.
2549
2550* `1` - the original wire protocol with the addition of a version string
2551  in the initial response from the server.
2552
2553--
2554
2555include::pull-config.txt[]
2556
2557include::push-config.txt[]
2558
2559include::rebase-config.txt[]
2560
2561include::receive-config.txt[]
2562
2563remote.pushDefault::
2564        The remote to push to by default.  Overrides
2565        `branch.<name>.remote` for all branches, and is overridden by
2566        `branch.<name>.pushRemote` for specific branches.
2567
2568remote.<name>.url::
2569        The URL of a remote repository.  See linkgit:git-fetch[1] or
2570        linkgit:git-push[1].
2571
2572remote.<name>.pushurl::
2573        The push URL of a remote repository.  See linkgit:git-push[1].
2574
2575remote.<name>.proxy::
2576        For remotes that require curl (http, https and ftp), the URL to
2577        the proxy to use for that remote.  Set to the empty string to
2578        disable proxying for that remote.
2579
2580remote.<name>.proxyAuthMethod::
2581        For remotes that require curl (http, https and ftp), the method to use for
2582        authenticating against the proxy in use (probably set in
2583        `remote.<name>.proxy`). See `http.proxyAuthMethod`.
2584
2585remote.<name>.fetch::
2586        The default set of "refspec" for linkgit:git-fetch[1]. See
2587        linkgit:git-fetch[1].
2588
2589remote.<name>.push::
2590        The default set of "refspec" for linkgit:git-push[1]. See
2591        linkgit:git-push[1].
2592
2593remote.<name>.mirror::
2594        If true, pushing to this remote will automatically behave
2595        as if the `--mirror` option was given on the command line.
2596
2597remote.<name>.skipDefaultUpdate::
2598        If true, this remote will be skipped by default when updating
2599        using linkgit:git-fetch[1] or the `update` subcommand of
2600        linkgit:git-remote[1].
2601
2602remote.<name>.skipFetchAll::
2603        If true, this remote will be skipped by default when updating
2604        using linkgit:git-fetch[1] or the `update` subcommand of
2605        linkgit:git-remote[1].
2606
2607remote.<name>.receivepack::
2608        The default program to execute on the remote side when pushing.  See
2609        option --receive-pack of linkgit:git-push[1].
2610
2611remote.<name>.uploadpack::
2612        The default program to execute on the remote side when fetching.  See
2613        option --upload-pack of linkgit:git-fetch-pack[1].
2614
2615remote.<name>.tagOpt::
2616        Setting this value to --no-tags disables automatic tag following when
2617        fetching from remote <name>. Setting it to --tags will fetch every
2618        tag from remote <name>, even if they are not reachable from remote
2619        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2620        override this setting. See options --tags and --no-tags of
2621        linkgit:git-fetch[1].
2622
2623remote.<name>.vcs::
2624        Setting this to a value <vcs> will cause Git to interact with
2625        the remote with the git-remote-<vcs> helper.
2626
2627remote.<name>.prune::
2628        When set to true, fetching from this remote by default will also
2629        remove any remote-tracking references that no longer exist on the
2630        remote (as if the `--prune` option was given on the command line).
2631        Overrides `fetch.prune` settings, if any.
2632
2633remote.<name>.pruneTags::
2634        When set to true, fetching from this remote by default will also
2635        remove any local tags that no longer exist on the remote if pruning
2636        is activated in general via `remote.<name>.prune`, `fetch.prune` or
2637        `--prune`. Overrides `fetch.pruneTags` settings, if any.
2638+
2639See also `remote.<name>.prune` and the PRUNING section of
2640linkgit:git-fetch[1].
2641
2642remotes.<group>::
2643        The list of remotes which are fetched by "git remote update
2644        <group>".  See linkgit:git-remote[1].
2645
2646repack.useDeltaBaseOffset::
2647        By default, linkgit:git-repack[1] creates packs that use
2648        delta-base offset. If you need to share your repository with
2649        Git older than version 1.4.4, either directly or via a dumb
2650        protocol such as http, then you need to set this option to
2651        "false" and repack. Access from old Git versions over the
2652        native protocol are unaffected by this option.
2653
2654repack.packKeptObjects::
2655        If set to true, makes `git repack` act as if
2656        `--pack-kept-objects` was passed. See linkgit:git-repack[1] for
2657        details. Defaults to `false` normally, but `true` if a bitmap
2658        index is being written (either via `--write-bitmap-index` or
2659        `repack.writeBitmaps`).
2660
2661repack.writeBitmaps::
2662        When true, git will write a bitmap index when packing all
2663        objects to disk (e.g., when `git repack -a` is run).  This
2664        index can speed up the "counting objects" phase of subsequent
2665        packs created for clones and fetches, at the cost of some disk
2666        space and extra time spent on the initial repack.  This has
2667        no effect if multiple packfiles are created.
2668        Defaults to false.
2669
2670rerere.autoUpdate::
2671        When set to true, `git-rerere` updates the index with the
2672        resulting contents after it cleanly resolves conflicts using
2673        previously recorded resolution.  Defaults to false.
2674
2675rerere.enabled::
2676        Activate recording of resolved conflicts, so that identical
2677        conflict hunks can be resolved automatically, should they be
2678        encountered again.  By default, linkgit:git-rerere[1] is
2679        enabled if there is an `rr-cache` directory under the
2680        `$GIT_DIR`, e.g. if "rerere" was previously used in the
2681        repository.
2682
2683include::sendemail-config.txt[]
2684
2685sequence.editor::
2686        Text editor used by `git rebase -i` for editing the rebase instruction file.
2687        The value is meant to be interpreted by the shell when it is used.
2688        It can be overridden by the `GIT_SEQUENCE_EDITOR` environment variable.
2689        When not configured the default commit message editor is used instead.
2690
2691showBranch.default::
2692        The default set of branches for linkgit:git-show-branch[1].
2693        See linkgit:git-show-branch[1].
2694
2695splitIndex.maxPercentChange::
2696        When the split index feature is used, this specifies the
2697        percent of entries the split index can contain compared to the
2698        total number of entries in both the split index and the shared
2699        index before a new shared index is written.
2700        The value should be between 0 and 100. If the value is 0 then
2701        a new shared index is always written, if it is 100 a new
2702        shared index is never written.
2703        By default the value is 20, so a new shared index is written
2704        if the number of entries in the split index would be greater
2705        than 20 percent of the total number of entries.
2706        See linkgit:git-update-index[1].
2707
2708splitIndex.sharedIndexExpire::
2709        When the split index feature is used, shared index files that
2710        were not modified since the time this variable specifies will
2711        be removed when a new shared index file is created. The value
2712        "now" expires all entries immediately, and "never" suppresses
2713        expiration altogether.
2714        The default value is "2.weeks.ago".
2715        Note that a shared index file is considered modified (for the
2716        purpose of expiration) each time a new split-index file is
2717        either created based on it or read from it.
2718        See linkgit:git-update-index[1].
2719
2720status.relativePaths::
2721        By default, linkgit:git-status[1] shows paths relative to the
2722        current directory. Setting this variable to `false` shows paths
2723        relative to the repository root (this was the default for Git
2724        prior to v1.5.4).
2725
2726status.short::
2727        Set to true to enable --short by default in linkgit:git-status[1].
2728        The option --no-short takes precedence over this variable.
2729
2730status.branch::
2731        Set to true to enable --branch by default in linkgit:git-status[1].
2732        The option --no-branch takes precedence over this variable.
2733
2734status.displayCommentPrefix::
2735        If set to true, linkgit:git-status[1] will insert a comment
2736        prefix before each output line (starting with
2737        `core.commentChar`, i.e. `#` by default). This was the
2738        behavior of linkgit:git-status[1] in Git 1.8.4 and previous.
2739        Defaults to false.
2740
2741status.renameLimit::
2742        The number of files to consider when performing rename detection
2743        in linkgit:git-status[1] and linkgit:git-commit[1]. Defaults to
2744        the value of diff.renameLimit.
2745
2746status.renames::
2747        Whether and how Git detects renames in linkgit:git-status[1] and
2748        linkgit:git-commit[1] .  If set to "false", rename detection is
2749        disabled. If set to "true", basic rename detection is enabled.
2750        If set to "copies" or "copy", Git will detect copies, as well.
2751        Defaults to the value of diff.renames.
2752
2753status.showStash::
2754        If set to true, linkgit:git-status[1] will display the number of
2755        entries currently stashed away.
2756        Defaults to false.
2757
2758status.showUntrackedFiles::
2759        By default, linkgit:git-status[1] and linkgit:git-commit[1] show
2760        files which are not currently tracked by Git. Directories which
2761        contain only untracked files, are shown with the directory name
2762        only. Showing untracked files means that Git needs to lstat() all
2763        the files in the whole repository, which might be slow on some
2764        systems. So, this variable controls how the commands displays
2765        the untracked files. Possible values are:
2766+
2767--
2768* `no` - Show no untracked files.
2769* `normal` - Show untracked files and directories.
2770* `all` - Show also individual files in untracked directories.
2771--
2772+
2773If this variable is not specified, it defaults to 'normal'.
2774This variable can be overridden with the -u|--untracked-files option
2775of linkgit:git-status[1] and linkgit:git-commit[1].
2776
2777status.submoduleSummary::
2778        Defaults to false.
2779        If this is set to a non zero number or true (identical to -1 or an
2780        unlimited number), the submodule summary will be enabled and a
2781        summary of commits for modified submodules will be shown (see
2782        --summary-limit option of linkgit:git-submodule[1]). Please note
2783        that the summary output command will be suppressed for all
2784        submodules when `diff.ignoreSubmodules` is set to 'all' or only
2785        for those submodules where `submodule.<name>.ignore=all`. The only
2786        exception to that rule is that status and commit will show staged
2787        submodule changes. To
2788        also view the summary for ignored submodules you can either use
2789        the --ignore-submodules=dirty command-line option or the 'git
2790        submodule summary' command, which shows a similar output but does
2791        not honor these settings.
2792
2793stash.showPatch::
2794        If this is set to true, the `git stash show` command without an
2795        option will show the stash entry in patch form.  Defaults to false.
2796        See description of 'show' command in linkgit:git-stash[1].
2797
2798stash.showStat::
2799        If this is set to true, the `git stash show` command without an
2800        option will show diffstat of the stash entry.  Defaults to true.
2801        See description of 'show' command in linkgit:git-stash[1].
2802
2803submodule.<name>.url::
2804        The URL for a submodule. This variable is copied from the .gitmodules
2805        file to the git config via 'git submodule init'. The user can change
2806        the configured URL before obtaining the submodule via 'git submodule
2807        update'. If neither submodule.<name>.active or submodule.active are
2808        set, the presence of this variable is used as a fallback to indicate
2809        whether the submodule is of interest to git commands.
2810        See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
2811
2812submodule.<name>.update::
2813        The method by which a submodule is updated by 'git submodule update',
2814        which is the only affected command, others such as
2815        'git checkout --recurse-submodules' are unaffected. It exists for
2816        historical reasons, when 'git submodule' was the only command to
2817        interact with submodules; settings like `submodule.active`
2818        and `pull.rebase` are more specific. It is populated by
2819        `git submodule init` from the linkgit:gitmodules[5] file.
2820        See description of 'update' command in linkgit:git-submodule[1].
2821
2822submodule.<name>.branch::
2823        The remote branch name for a submodule, used by `git submodule
2824        update --remote`.  Set this option to override the value found in
2825        the `.gitmodules` file.  See linkgit:git-submodule[1] and
2826        linkgit:gitmodules[5] for details.
2827
2828submodule.<name>.fetchRecurseSubmodules::
2829        This option can be used to control recursive fetching of this
2830        submodule. It can be overridden by using the --[no-]recurse-submodules
2831        command-line option to "git fetch" and "git pull".
2832        This setting will override that from in the linkgit:gitmodules[5]
2833        file.
2834
2835submodule.<name>.ignore::
2836        Defines under what circumstances "git status" and the diff family show
2837        a submodule as modified. When set to "all", it will never be considered
2838        modified (but it will nonetheless show up in the output of status and
2839        commit when it has been staged), "dirty" will ignore all changes
2840        to the submodules work tree and
2841        takes only differences between the HEAD of the submodule and the commit
2842        recorded in the superproject into account. "untracked" will additionally
2843        let submodules with modified tracked files in their work tree show up.
2844        Using "none" (the default when this option is not set) also shows
2845        submodules that have untracked files in their work tree as changed.
2846        This setting overrides any setting made in .gitmodules for this submodule,
2847        both settings can be overridden on the command line by using the
2848        "--ignore-submodules" option. The 'git submodule' commands are not
2849        affected by this setting.
2850
2851submodule.<name>.active::
2852        Boolean value indicating if the submodule is of interest to git
2853        commands.  This config option takes precedence over the
2854        submodule.active config option. See linkgit:gitsubmodules[7] for
2855        details.
2856
2857submodule.active::
2858        A repeated field which contains a pathspec used to match against a
2859        submodule's path to determine if the submodule is of interest to git
2860        commands. See linkgit:gitsubmodules[7] for details.
2861
2862submodule.recurse::
2863        Specifies if commands recurse into submodules by default. This
2864        applies to all commands that have a `--recurse-submodules` option,
2865        except `clone`.
2866        Defaults to false.
2867
2868submodule.fetchJobs::
2869        Specifies how many submodules are fetched/cloned at the same time.
2870        A positive integer allows up to that number of submodules fetched
2871        in parallel. A value of 0 will give some reasonable default.
2872        If unset, it defaults to 1.
2873
2874submodule.alternateLocation::
2875        Specifies how the submodules obtain alternates when submodules are
2876        cloned. Possible values are `no`, `superproject`.
2877        By default `no` is assumed, which doesn't add references. When the
2878        value is set to `superproject` the submodule to be cloned computes
2879        its alternates location relative to the superprojects alternate.
2880
2881submodule.alternateErrorStrategy::
2882        Specifies how to treat errors with the alternates for a submodule
2883        as computed via `submodule.alternateLocation`. Possible values are
2884        `ignore`, `info`, `die`. Default is `die`.
2885
2886tag.forceSignAnnotated::
2887        A boolean to specify whether annotated tags created should be GPG signed.
2888        If `--annotate` is specified on the command line, it takes
2889        precedence over this option.
2890
2891tag.sort::
2892        This variable controls the sort ordering of tags when displayed by
2893        linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
2894        value of this variable will be used as the default.
2895
2896tar.umask::
2897        This variable can be used to restrict the permission bits of
2898        tar archive entries.  The default is 0002, which turns off the
2899        world write bit.  The special value "user" indicates that the
2900        archiving user's umask will be used instead.  See umask(2) and
2901        linkgit:git-archive[1].
2902
2903transfer.fsckObjects::
2904        When `fetch.fsckObjects` or `receive.fsckObjects` are
2905        not set, the value of this variable is used instead.
2906        Defaults to false.
2907+
2908When set, the fetch or receive will abort in the case of a malformed
2909object or a link to a nonexistent object. In addition, various other
2910issues are checked for, including legacy issues (see `fsck.<msg-id>`),
2911and potential security issues like the existence of a `.GIT` directory
2912or a malicious `.gitmodules` file (see the release notes for v2.2.1
2913and v2.17.1 for details). Other sanity and security checks may be
2914added in future releases.
2915+
2916On the receiving side, failing fsckObjects will make those objects
2917unreachable, see "QUARANTINE ENVIRONMENT" in
2918linkgit:git-receive-pack[1]. On the fetch side, malformed objects will
2919instead be left unreferenced in the repository.
2920+
2921Due to the non-quarantine nature of the `fetch.fsckObjects`
2922implementation it can not be relied upon to leave the object store
2923clean like `receive.fsckObjects` can.
2924+
2925As objects are unpacked they're written to the object store, so there
2926can be cases where malicious objects get introduced even though the
2927"fetch" failed, only to have a subsequent "fetch" succeed because only
2928new incoming objects are checked, not those that have already been
2929written to the object store. That difference in behavior should not be
2930relied upon. In the future, such objects may be quarantined for
2931"fetch" as well.
2932+
2933For now, the paranoid need to find some way to emulate the quarantine
2934environment if they'd like the same protection as "push". E.g. in the
2935case of an internal mirror do the mirroring in two steps, one to fetch
2936the untrusted objects, and then do a second "push" (which will use the
2937quarantine) to another internal repo, and have internal clients
2938consume this pushed-to repository, or embargo internal fetches and
2939only allow them once a full "fsck" has run (and no new fetches have
2940happened in the meantime).
2941
2942transfer.hideRefs::
2943        String(s) `receive-pack` and `upload-pack` use to decide which
2944        refs to omit from their initial advertisements.  Use more than
2945        one definition to specify multiple prefix strings. A ref that is
2946        under the hierarchies listed in the value of this variable is
2947        excluded, and is hidden when responding to `git push` or `git
2948        fetch`.  See `receive.hideRefs` and `uploadpack.hideRefs` for
2949        program-specific versions of this config.
2950+
2951You may also include a `!` in front of the ref name to negate the entry,
2952explicitly exposing it, even if an earlier entry marked it as hidden.
2953If you have multiple hideRefs values, later entries override earlier ones
2954(and entries in more-specific config files override less-specific ones).
2955+
2956If a namespace is in use, the namespace prefix is stripped from each
2957reference before it is matched against `transfer.hiderefs` patterns.
2958For example, if `refs/heads/master` is specified in `transfer.hideRefs` and
2959the current namespace is `foo`, then `refs/namespaces/foo/refs/heads/master`
2960is omitted from the advertisements but `refs/heads/master` and
2961`refs/namespaces/bar/refs/heads/master` are still advertised as so-called
2962"have" lines. In order to match refs before stripping, add a `^` in front of
2963the ref name. If you combine `!` and `^`, `!` must be specified first.
2964+
2965Even if you hide refs, a client may still be able to steal the target
2966objects via the techniques described in the "SECURITY" section of the
2967linkgit:gitnamespaces[7] man page; it's best to keep private data in a
2968separate repository.
2969
2970transfer.unpackLimit::
2971        When `fetch.unpackLimit` or `receive.unpackLimit` are
2972        not set, the value of this variable is used instead.
2973        The default value is 100.
2974
2975uploadarchive.allowUnreachable::
2976        If true, allow clients to use `git archive --remote` to request
2977        any tree, whether reachable from the ref tips or not. See the
2978        discussion in the "SECURITY" section of
2979        linkgit:git-upload-archive[1] for more details. Defaults to
2980        `false`.
2981
2982uploadpack.hideRefs::
2983        This variable is the same as `transfer.hideRefs`, but applies
2984        only to `upload-pack` (and so affects only fetches, not pushes).
2985        An attempt to fetch a hidden ref by `git fetch` will fail.  See
2986        also `uploadpack.allowTipSHA1InWant`.
2987
2988uploadpack.allowTipSHA1InWant::
2989        When `uploadpack.hideRefs` is in effect, allow `upload-pack`
2990        to accept a fetch request that asks for an object at the tip
2991        of a hidden ref (by default, such a request is rejected).
2992        See also `uploadpack.hideRefs`.  Even if this is false, a client
2993        may be able to steal objects via the techniques described in the
2994        "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
2995        best to keep private data in a separate repository.
2996
2997uploadpack.allowReachableSHA1InWant::
2998        Allow `upload-pack` to accept a fetch request that asks for an
2999        object that is reachable from any ref tip. However, note that
3000        calculating object reachability is computationally expensive.
3001        Defaults to `false`.  Even if this is false, a client may be able
3002        to steal objects via the techniques described in the "SECURITY"
3003        section of the linkgit:gitnamespaces[7] man page; it's best to
3004        keep private data in a separate repository.
3005
3006uploadpack.allowAnySHA1InWant::
3007        Allow `upload-pack` to accept a fetch request that asks for any
3008        object at all.
3009        Defaults to `false`.
3010
3011uploadpack.keepAlive::
3012        When `upload-pack` has started `pack-objects`, there may be a
3013        quiet period while `pack-objects` prepares the pack. Normally
3014        it would output progress information, but if `--quiet` was used
3015        for the fetch, `pack-objects` will output nothing at all until
3016        the pack data begins. Some clients and networks may consider
3017        the server to be hung and give up. Setting this option instructs
3018        `upload-pack` to send an empty keepalive packet every
3019        `uploadpack.keepAlive` seconds. Setting this option to 0
3020        disables keepalive packets entirely. The default is 5 seconds.
3021
3022uploadpack.packObjectsHook::
3023        If this option is set, when `upload-pack` would run
3024        `git pack-objects` to create a packfile for a client, it will
3025        run this shell command instead.  The `pack-objects` command and
3026        arguments it _would_ have run (including the `git pack-objects`
3027        at the beginning) are appended to the shell command. The stdin
3028        and stdout of the hook are treated as if `pack-objects` itself
3029        was run. I.e., `upload-pack` will feed input intended for
3030        `pack-objects` to the hook, and expects a completed packfile on
3031        stdout.
3032
3033uploadpack.allowFilter::
3034        If this option is set, `upload-pack` will support partial
3035        clone and partial fetch object filtering.
3036+
3037Note that this configuration variable is ignored if it is seen in the
3038repository-level config (this is a safety measure against fetching from
3039untrusted repositories).
3040
3041uploadpack.allowRefInWant::
3042        If this option is set, `upload-pack` will support the `ref-in-want`
3043        feature of the protocol version 2 `fetch` command.  This feature
3044        is intended for the benefit of load-balanced servers which may
3045        not have the same view of what OIDs their refs point to due to
3046        replication delay.
3047
3048url.<base>.insteadOf::
3049        Any URL that starts with this value will be rewritten to
3050        start, instead, with <base>. In cases where some site serves a
3051        large number of repositories, and serves them with multiple
3052        access methods, and some users need to use different access
3053        methods, this feature allows people to specify any of the
3054        equivalent URLs and have Git automatically rewrite the URL to
3055        the best alternative for the particular user, even for a
3056        never-before-seen repository on the site.  When more than one
3057        insteadOf strings match a given URL, the longest match is used.
3058+
3059Note that any protocol restrictions will be applied to the rewritten
3060URL. If the rewrite changes the URL to use a custom protocol or remote
3061helper, you may need to adjust the `protocol.*.allow` config to permit
3062the request.  In particular, protocols you expect to use for submodules
3063must be set to `always` rather than the default of `user`. See the
3064description of `protocol.allow` above.
3065
3066url.<base>.pushInsteadOf::
3067        Any URL that starts with this value will not be pushed to;
3068        instead, it will be rewritten to start with <base>, and the
3069        resulting URL will be pushed to. In cases where some site serves
3070        a large number of repositories, and serves them with multiple
3071        access methods, some of which do not allow push, this feature
3072        allows people to specify a pull-only URL and have Git
3073        automatically use an appropriate URL to push, even for a
3074        never-before-seen repository on the site.  When more than one
3075        pushInsteadOf strings match a given URL, the longest match is
3076        used.  If a remote has an explicit pushurl, Git will ignore this
3077        setting for that remote.
3078
3079user.email::
3080        Your email address to be recorded in any newly created commits.
3081        Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
3082        `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
3083
3084user.name::
3085        Your full name to be recorded in any newly created commits.
3086        Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
3087        environment variables.  See linkgit:git-commit-tree[1].
3088
3089user.useConfigOnly::
3090        Instruct Git to avoid trying to guess defaults for `user.email`
3091        and `user.name`, and instead retrieve the values only from the
3092        configuration. For example, if you have multiple email addresses
3093        and would like to use a different one for each repository, then
3094        with this configuration option set to `true` in the global config
3095        along with a name, Git will prompt you to set up an email before
3096        making new commits in a newly cloned repository.
3097        Defaults to `false`.
3098
3099user.signingKey::
3100        If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
3101        key you want it to automatically when creating a signed tag or
3102        commit, you can override the default selection with this variable.
3103        This option is passed unchanged to gpg's --local-user parameter,
3104        so you may specify a key using any method that gpg supports.
3105
3106versionsort.prereleaseSuffix (deprecated)::
3107        Deprecated alias for `versionsort.suffix`.  Ignored if
3108        `versionsort.suffix` is set.
3109
3110versionsort.suffix::
3111        Even when version sort is used in linkgit:git-tag[1], tagnames
3112        with the same base version but different suffixes are still sorted
3113        lexicographically, resulting e.g. in prerelease tags appearing
3114        after the main release (e.g. "1.0-rc1" after "1.0").  This
3115        variable can be specified to determine the sorting order of tags
3116        with different suffixes.
3117+
3118By specifying a single suffix in this variable, any tagname containing
3119that suffix will appear before the corresponding main release.  E.g. if
3120the variable is set to "-rc", then all "1.0-rcX" tags will appear before
3121"1.0".  If specified multiple times, once per suffix, then the order of
3122suffixes in the configuration will determine the sorting order of tagnames
3123with those suffixes.  E.g. if "-pre" appears before "-rc" in the
3124configuration, then all "1.0-preX" tags will be listed before any
3125"1.0-rcX" tags.  The placement of the main release tag relative to tags
3126with various suffixes can be determined by specifying the empty suffix
3127among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
3128"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
3129are listed first, followed by "v4.8", then "v4.8-ckX" and finally
3130"v4.8-bfsX".
3131+
3132If more than one suffixes match the same tagname, then that tagname will
3133be sorted according to the suffix which starts at the earliest position in
3134the tagname.  If more than one different matching suffixes start at
3135that earliest position, then that tagname will be sorted according to the
3136longest of those suffixes.
3137The sorting order between different suffixes is undefined if they are
3138in multiple config files.
3139
3140web.browser::
3141        Specify a web browser that may be used by some commands.
3142        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]
3143        may use it.
3144
3145worktree.guessRemote::
3146        With `add`, if no branch argument, and neither of `-b` nor
3147        `-B` nor `--detach` are given, the command defaults to
3148        creating a new branch from HEAD.  If `worktree.guessRemote` is
3149        set to true, `worktree add` tries to find a remote-tracking
3150        branch whose name uniquely matches the new branch name.  If
3151        such a branch exists, it is checked out and set as "upstream"
3152        for the new branch.  If no such match can be found, it falls
3153        back to creating a new branch from the current HEAD.