Documentation / config.txton commit git-add: remove conflicting entry when adding. (c33ab0d)
   1CONFIGURATION FILE
   2------------------
   3
   4The git configuration file contains a number of variables that affect
   5the git command's behavior. They can be used by both the git plumbing
   6and the porcelains. The variables are divided into sections, where
   7in the fully qualified variable name the variable itself is the last
   8dot-separated segment and the section name is everything before the last
   9dot. The variable names are case-insensitive and only alphanumeric
  10characters are allowed. Some variables may appear multiple times.
  11
  12The syntax is fairly flexible and permissive; whitespaces are mostly
  13ignored. The '#' and ';' characters begin comments to the end of line,
  14blank lines are ignored, lines containing strings enclosed in square
  15brackets start sections and all the other lines are recognized
  16as setting variables, in the form 'name = value'. If there is no equal
  17sign on the line, the entire line is taken as 'name' and the variable
  18is recognized as boolean "true". String values may be entirely or partially
  19enclosed in double quotes; some variables may require special value format.
  20
  21Example
  22~~~~~~~
  23
  24        # Core variables
  25        [core]
  26                ; Don't trust file modes
  27                filemode = false
  28
  29        # Our diff algorithm
  30        [diff]
  31                external = "/usr/local/bin/gnu-diff -u"
  32                renames = true
  33
  34Variables
  35~~~~~~~~~
  36
  37Note that this list is non-comprehensive and not necessarily complete.
  38For command-specific variables, you will find a more detailed description
  39in the appropriate manual page. You will find a description of non-core
  40porcelain configuration variables in the respective porcelain documentation.
  41
  42core.fileMode::
  43        If false, the executable bit differences between the index and
  44        the working copy are ignored; useful on broken filesystems like FAT.
  45        See gitlink:git-update-index[1]. True by default.
  46
  47core.gitProxy::
  48        A "proxy command" to execute (as 'command host port') instead
  49        of establishing direct connection to the remote server when
  50        using the git protocol for fetching. If the variable value is
  51        in the "COMMAND for DOMAIN" format, the command is applied only
  52        on hostnames ending with the specified domain string. This variable
  53        may be set multiple times and is matched in the given order;
  54        the first match wins.
  55+
  56Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
  57(which always applies universally, without the special "for"
  58handling).
  59
  60core.ignoreStat::
  61        The working copy files are assumed to stay unchanged until you
  62        mark them otherwise manually - Git will not detect the file changes
  63        by lstat() calls. This is useful on systems where those are very
  64        slow, such as Microsoft Windows.  See gitlink:git-update-index[1].
  65        False by default.
  66
  67core.preferSymlinkRefs::
  68        Instead of the default "symref" format for HEAD
  69        and other symbolic reference files, use symbolic links.
  70        This is sometimes needed to work with old scripts that
  71        expect HEAD to be a symbolic link.
  72
  73core.logAllRefUpdates::
  74        Updates to a ref <ref> is logged to the file
  75        "$GIT_DIR/logs/<ref>", by appending the new and old
  76        SHA1, the date/time and the reason of the update, but
  77        only when the file exists.  If this configuration
  78        variable is set to true, missing "$GIT_DIR/logs/<ref>"
  79        file is automatically created for branch heads.
  80
  81        This information can be used to determine what commit
  82        was the tip of a branch "2 days ago".
  83
  84        This value is true by default in a repository that has
  85        a working directory associated with it, and false by
  86        default in a bare repository.
  87
  88core.repositoryFormatVersion::
  89        Internal variable identifying the repository format and layout
  90        version.
  91
  92core.sharedRepository::
  93        When 'group' (or 'true'), the repository is made shareable between
  94        several users in a group (making sure all the files and objects are
  95        group-writable). When 'all' (or 'world' or 'everybody'), the
  96        repository will be readable by all users, additionally to being
  97        group-shareable. When 'umask' (or 'false'), git will use permissions
  98        reported by umask(2). See gitlink:git-init-db[1]. False by default.
  99
 100core.warnAmbiguousRefs::
 101        If true, git will warn you if the ref name you passed it is ambiguous
 102        and might match multiple refs in the .git/refs/ tree. True by default.
 103
 104core.compression::
 105        An integer -1..9, indicating the compression level for objects that
 106        are not in a pack file. -1 is the zlib and git default. 0 means no
 107        compression, and 1..9 are various speed/size tradeoffs, 9 being
 108        slowest.
 109
 110core.legacyheaders::
 111        A boolean which enables the legacy object header format in case
 112        you want to interoperate with old clients accessing the object
 113        database directly (where the "http://" and "rsync://" protocols
 114        count as direct access).
 115
 116alias.*::
 117        Command aliases for the gitlink:git[1] command wrapper - e.g.
 118        after defining "alias.last = cat-file commit HEAD", the invocation
 119        "git last" is equivalent to "git cat-file commit HEAD". To avoid
 120        confusion and troubles with script usage, aliases that
 121        hide existing git commands are ignored. Arguments are split by
 122        spaces, the usual shell quoting and escaping is supported.
 123        quote pair and a backslash can be used to quote them.
 124
 125apply.whitespace::
 126        Tells `git-apply` how to handle whitespaces, in the same way
 127        as the '--whitespace' option. See gitlink:git-apply[1].
 128
 129branch.<name>.remote::
 130        When in branch <name>, it tells `git fetch` which remote to fetch.
 131        If this option is not given, `git fetch` defaults to remote "origin".
 132
 133branch.<name>.merge::
 134        When in branch <name>, it tells `git fetch` the default refspec to
 135        be marked for merging in FETCH_HEAD. The value has exactly to match
 136        a remote part of one of the refspecs which are fetched from the remote
 137        given by "branch.<name>.remote".
 138        The merge information is used by `git pull` (which at first calls
 139        `git fetch`) to lookup the default branch for merging. Without
 140        this option, `git pull` defaults to merge the first refspec fetched.
 141        Specify multiple values to get an octopus merge.
 142
 143color.diff::
 144        When true (or `always`), always use colors in patch.
 145        When false (or `never`), never.  When set to `auto`, use
 146        colors only when the output is to the terminal.
 147
 148color.diff.<slot>::
 149        Use customized color for diff colorization.  `<slot>`
 150        specifies which part of the patch to use the specified
 151        color, and is one of `plain` (context text), `meta`
 152        (metainformation), `frag` (hunk header), `old` (removed
 153        lines), or `new` (added lines).  The value for these
 154        configuration variables can be one of: `normal`, `bold`,
 155        `dim`, `ul`, `blink`, `reverse`, `reset`, `black`,
 156        `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, or
 157        `white`.
 158
 159color.pager::
 160        A boolean to enable/disable colored output when the pager is in
 161        use (default is true).
 162
 163color.status::
 164        A boolean to enable/disable color in the output of
 165        gitlink:git-status[1]. May be set to `true` (or `always`),
 166        `false` (or `never`) or `auto`, in which case colors are used
 167        only when the output is to a terminal. Defaults to false.
 168
 169color.status.<slot>::
 170        Use customized color for status colorization. `<slot>` is
 171        one of `header` (the header text of the status message),
 172        `added` or `updated` (files which are added but not committed),
 173        `changed` (files which are changed but not added in the index),
 174        or `untracked` (files which are not tracked by git). The values of
 175        these variables may be specified as in color.diff.<slot>.
 176
 177diff.renameLimit::
 178        The number of files to consider when performing the copy/rename
 179        detection; equivalent to the git diff option '-l'.
 180
 181diff.renames::
 182        Tells git to detect renames.  If set to any boolean value, it
 183        will enable basic rename detection.  If set to "copies" or
 184        "copy", it will detect copies, as well.
 185
 186format.headers::
 187        Additional email headers to include in a patch to be submitted
 188        by mail.  See gitlink:git-format-patch[1].
 189
 190gitcvs.enabled::
 191        Whether the cvs pserver interface is enabled for this repository.
 192        See gitlink:git-cvsserver[1].
 193
 194gitcvs.logfile::
 195        Path to a log file where the cvs pserver interface well... logs
 196        various stuff. See gitlink:git-cvsserver[1].
 197
 198http.sslVerify::
 199        Whether to verify the SSL certificate when fetching or pushing
 200        over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
 201        variable.
 202
 203http.sslCert::
 204        File containing the SSL certificate when fetching or pushing
 205        over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
 206        variable.
 207
 208http.sslKey::
 209        File containing the SSL private key when fetching or pushing
 210        over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
 211        variable.
 212
 213http.sslCAInfo::
 214        File containing the certificates to verify the peer with when
 215        fetching or pushing over HTTPS. Can be overridden by the
 216        'GIT_SSL_CAINFO' environment variable.
 217
 218http.sslCAPath::
 219        Path containing files with the CA certificates to verify the peer
 220        with when fetching or pushing over HTTPS. Can be overridden
 221        by the 'GIT_SSL_CAPATH' environment variable.
 222
 223http.maxRequests::
 224        How many HTTP requests to launch in parallel. Can be overridden
 225        by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
 226
 227http.lowSpeedLimit, http.lowSpeedTime::
 228        If the HTTP transfer speed is less than 'http.lowSpeedLimit'
 229        for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
 230        Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
 231        'GIT_HTTP_LOW_SPEED_TIME' environment variables.
 232
 233http.noEPSV::
 234        A boolean which disables using of EPSV ftp command by curl.
 235        This can helpful with some "poor" ftp servers which doesn't
 236        support EPSV mode. Can be overridden by the 'GIT_CURL_FTP_NO_EPSV'
 237        environment variable. Default is false (curl will use EPSV).
 238
 239i18n.commitEncoding::
 240        Character encoding the commit messages are stored in; git itself
 241        does not care per se, but this information is necessary e.g. when
 242        importing commits from emails or in the gitk graphical history
 243        browser (and possibly at other places in the future or in other
 244        porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
 245
 246log.showroot::
 247        If true, the initial commit will be shown as a big creation event.
 248        This is equivalent to a diff against an empty tree.
 249        Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which
 250        normally hide the root commit will now show it. True by default.
 251
 252merge.summary::
 253        Whether to include summaries of merged commits in newly created
 254        merge commit messages. False by default.
 255
 256pack.window::
 257        The size of the window used by gitlink:git-pack-objects[1] when no
 258        window size is given on the command line. Defaults to 10.
 259
 260pull.octopus::
 261        The default merge strategy to use when pulling multiple branches
 262        at once.
 263
 264pull.twohead::
 265        The default merge strategy to use when pulling a single branch.
 266
 267remote.<name>.url::
 268        The URL of a remote repository.  See gitlink:git-fetch[1] or
 269        gitlink:git-push[1].
 270
 271remote.<name>.fetch::
 272        The default set of "refspec" for gitlink:git-fetch[1]. See
 273        gitlink:git-fetch[1].
 274
 275remote.<name>.push::
 276        The default set of "refspec" for gitlink:git-push[1]. See
 277        gitlink:git-push[1].
 278
 279repack.usedeltabaseoffset::
 280        Allow gitlink:git-repack[1] to create packs that uses
 281        delta-base offset.  Defaults to false.
 282
 283show.difftree::
 284        The default gitlink:git-diff-tree[1] arguments to be used
 285        for gitlink:git-show[1].
 286
 287showbranch.default::
 288        The default set of branches for gitlink:git-show-branch[1].
 289        See gitlink:git-show-branch[1].
 290
 291tar.umask::
 292        By default, gitlink:git-tar-tree[1] sets file and directories modes
 293        to 0666 or 0777. While this is both useful and acceptable for projects
 294        such as the Linux Kernel, it might be excessive for other projects.
 295        With this variable, it becomes possible to tell
 296        gitlink:git-tar-tree[1] to apply a specific umask to the modes above.
 297        The special value "user" indicates that the user's current umask will
 298        be used. This should be enough for most projects, as it will lead to
 299        the same permissions as gitlink:git-checkout[1] would use. The default
 300        value remains 0, which means world read-write.
 301
 302user.email::
 303        Your email address to be recorded in any newly created commits.
 304        Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL'
 305        environment variables.  See gitlink:git-commit-tree[1].
 306
 307user.name::
 308        Your full name to be recorded in any newly created commits.
 309        Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
 310        environment variables.  See gitlink:git-commit-tree[1].
 311
 312whatchanged.difftree::
 313        The default gitlink:git-diff-tree[1] arguments to be used
 314        for gitlink:git-whatchanged[1].
 315
 316imap::
 317        The configuration variables in the 'imap' section are described
 318        in gitlink:git-imap-send[1].
 319
 320receive.unpackLimit::
 321        If the number of objects received in a push is below this
 322        limit then the objects will be unpacked into loose object
 323        files. However if the number of received objects equals or
 324        exceeds this limit then the received pack will be stored as
 325        a pack, after adding any missing delta bases.  Storing the
 326        pack from a push can make the push operation complete faster,
 327        especially on slow filesystems.
 328
 329receive.denyNonFastForwards::
 330        If set to true, git-receive-pack will deny a ref update which is
 331        not a fast forward. Use this to prevent such an update via a push,
 332        even if that push is forced. This configuration variable is
 333        set when initializing a shared repository.
 334