Documentation / git.txton commit add: make warn_pathless_add() a no-op after first call (16d41d4)
   1git(1)
   2======
   3
   4NAME
   5----
   6git - the stupid content tracker
   7
   8
   9SYNOPSIS
  10--------
  11[verse]
  12'git' [--version] [--help] [-c <name>=<value>]
  13    [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
  14    [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]
  15    [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
  16    <command> [<args>]
  17
  18DESCRIPTION
  19-----------
  20Git is a fast, scalable, distributed revision control system with an
  21unusually rich command set that provides both high-level operations
  22and full access to internals.
  23
  24See linkgit:gittutorial[7] to get started, then see
  25link:everyday.html[Everyday Git] for a useful minimum set of
  26commands.  The link:user-manual.html[Git User's Manual] has a more
  27in-depth introduction.
  28
  29After you mastered the basic concepts, you can come back to this
  30page to learn what commands Git offers.  You can learn more about
  31individual Git commands with "git help command".  linkgit:gitcli[7]
  32manual page gives you an overview of the command line command syntax.
  33
  34Formatted and hyperlinked version of the latest Git documentation
  35can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.
  36
  37ifdef::stalenotes[]
  38[NOTE]
  39============
  40
  41You are reading the documentation for the latest (possibly
  42unreleased) version of Git, that is available from 'master'
  43branch of the `git.git` repository.
  44Documentation for older releases are available here:
  45
  46* link:v1.8.1.5/git.html[documentation for release 1.8.1.5]
  47
  48* release notes for
  49  link:RelNotes/1.8.1.5.txt[1.8.1.5],
  50  link:RelNotes/1.8.1.4.txt[1.8.1.4],
  51  link:RelNotes/1.8.1.3.txt[1.8.1.3],
  52  link:RelNotes/1.8.1.2.txt[1.8.1.2],
  53  link:RelNotes/1.8.1.1.txt[1.8.1.1],
  54  link:RelNotes/1.8.1.txt[1.8.1].
  55
  56* link:v1.8.0.3/git.html[documentation for release 1.8.0.3]
  57
  58* release notes for
  59  link:RelNotes/1.8.0.3.txt[1.8.0.3],
  60  link:RelNotes/1.8.0.2.txt[1.8.0.2],
  61  link:RelNotes/1.8.0.1.txt[1.8.0.1],
  62  link:RelNotes/1.8.0.txt[1.8.0].
  63
  64* link:v1.7.12.4/git.html[documentation for release 1.7.12.4]
  65
  66* release notes for
  67  link:RelNotes/1.7.12.4.txt[1.7.12.4],
  68  link:RelNotes/1.7.12.3.txt[1.7.12.3],
  69  link:RelNotes/1.7.12.2.txt[1.7.12.2],
  70  link:RelNotes/1.7.12.1.txt[1.7.12.1],
  71  link:RelNotes/1.7.12.txt[1.7.12].
  72
  73* link:v1.7.11.7/git.html[documentation for release 1.7.11.7]
  74
  75* release notes for
  76  link:RelNotes/1.7.11.7.txt[1.7.11.7],
  77  link:RelNotes/1.7.11.6.txt[1.7.11.6],
  78  link:RelNotes/1.7.11.5.txt[1.7.11.5],
  79  link:RelNotes/1.7.11.4.txt[1.7.11.4],
  80  link:RelNotes/1.7.11.3.txt[1.7.11.3],
  81  link:RelNotes/1.7.11.2.txt[1.7.11.2],
  82  link:RelNotes/1.7.11.1.txt[1.7.11.1],
  83  link:RelNotes/1.7.11.txt[1.7.11].
  84
  85* link:v1.7.10.5/git.html[documentation for release 1.7.10.5]
  86
  87* release notes for
  88  link:RelNotes/1.7.10.5.txt[1.7.10.5],
  89  link:RelNotes/1.7.10.4.txt[1.7.10.4],
  90  link:RelNotes/1.7.10.3.txt[1.7.10.3],
  91  link:RelNotes/1.7.10.2.txt[1.7.10.2],
  92  link:RelNotes/1.7.10.1.txt[1.7.10.1],
  93  link:RelNotes/1.7.10.txt[1.7.10].
  94
  95* link:v1.7.9.7/git.html[documentation for release 1.7.9.7]
  96
  97* release notes for
  98  link:RelNotes/1.7.9.7.txt[1.7.9.7],
  99  link:RelNotes/1.7.9.6.txt[1.7.9.6],
 100  link:RelNotes/1.7.9.5.txt[1.7.9.5],
 101  link:RelNotes/1.7.9.4.txt[1.7.9.4],
 102  link:RelNotes/1.7.9.3.txt[1.7.9.3],
 103  link:RelNotes/1.7.9.2.txt[1.7.9.2],
 104  link:RelNotes/1.7.9.1.txt[1.7.9.1],
 105  link:RelNotes/1.7.9.txt[1.7.9].
 106
 107* link:v1.7.8.6/git.html[documentation for release 1.7.8.6]
 108
 109* release notes for
 110  link:RelNotes/1.7.8.6.txt[1.7.8.6],
 111  link:RelNotes/1.7.8.5.txt[1.7.8.5],
 112  link:RelNotes/1.7.8.4.txt[1.7.8.4],
 113  link:RelNotes/1.7.8.3.txt[1.7.8.3],
 114  link:RelNotes/1.7.8.2.txt[1.7.8.2],
 115  link:RelNotes/1.7.8.1.txt[1.7.8.1],
 116  link:RelNotes/1.7.8.txt[1.7.8].
 117
 118* link:v1.7.7.7/git.html[documentation for release 1.7.7.7]
 119
 120* release notes for
 121  link:RelNotes/1.7.7.7.txt[1.7.7.7],
 122  link:RelNotes/1.7.7.6.txt[1.7.7.6],
 123  link:RelNotes/1.7.7.5.txt[1.7.7.5],
 124  link:RelNotes/1.7.7.4.txt[1.7.7.4],
 125  link:RelNotes/1.7.7.3.txt[1.7.7.3],
 126  link:RelNotes/1.7.7.2.txt[1.7.7.2],
 127  link:RelNotes/1.7.7.1.txt[1.7.7.1],
 128  link:RelNotes/1.7.7.txt[1.7.7].
 129
 130* link:v1.7.6.6/git.html[documentation for release 1.7.6.6]
 131
 132* release notes for
 133  link:RelNotes/1.7.6.6.txt[1.7.6.6],
 134  link:RelNotes/1.7.6.5.txt[1.7.6.5],
 135  link:RelNotes/1.7.6.4.txt[1.7.6.4],
 136  link:RelNotes/1.7.6.3.txt[1.7.6.3],
 137  link:RelNotes/1.7.6.2.txt[1.7.6.2],
 138  link:RelNotes/1.7.6.1.txt[1.7.6.1],
 139  link:RelNotes/1.7.6.txt[1.7.6].
 140
 141* link:v1.7.5.4/git.html[documentation for release 1.7.5.4]
 142
 143* release notes for
 144  link:RelNotes/1.7.5.4.txt[1.7.5.4],
 145  link:RelNotes/1.7.5.3.txt[1.7.5.3],
 146  link:RelNotes/1.7.5.2.txt[1.7.5.2],
 147  link:RelNotes/1.7.5.1.txt[1.7.5.1],
 148  link:RelNotes/1.7.5.txt[1.7.5].
 149
 150* link:v1.7.4.5/git.html[documentation for release 1.7.4.5]
 151
 152* release notes for
 153  link:RelNotes/1.7.4.5.txt[1.7.4.5],
 154  link:RelNotes/1.7.4.4.txt[1.7.4.4],
 155  link:RelNotes/1.7.4.3.txt[1.7.4.3],
 156  link:RelNotes/1.7.4.2.txt[1.7.4.2],
 157  link:RelNotes/1.7.4.1.txt[1.7.4.1],
 158  link:RelNotes/1.7.4.txt[1.7.4].
 159
 160* link:v1.7.3.5/git.html[documentation for release 1.7.3.5]
 161
 162* release notes for
 163  link:RelNotes/1.7.3.5.txt[1.7.3.5],
 164  link:RelNotes/1.7.3.4.txt[1.7.3.4],
 165  link:RelNotes/1.7.3.3.txt[1.7.3.3],
 166  link:RelNotes/1.7.3.2.txt[1.7.3.2],
 167  link:RelNotes/1.7.3.1.txt[1.7.3.1],
 168  link:RelNotes/1.7.3.txt[1.7.3].
 169
 170* link:v1.7.2.5/git.html[documentation for release 1.7.2.5]
 171
 172* release notes for
 173  link:RelNotes/1.7.2.5.txt[1.7.2.5],
 174  link:RelNotes/1.7.2.4.txt[1.7.2.4],
 175  link:RelNotes/1.7.2.3.txt[1.7.2.3],
 176  link:RelNotes/1.7.2.2.txt[1.7.2.2],
 177  link:RelNotes/1.7.2.1.txt[1.7.2.1],
 178  link:RelNotes/1.7.2.txt[1.7.2].
 179
 180* link:v1.7.1.4/git.html[documentation for release 1.7.1.4]
 181
 182* release notes for
 183  link:RelNotes/1.7.1.4.txt[1.7.1.4],
 184  link:RelNotes/1.7.1.3.txt[1.7.1.3],
 185  link:RelNotes/1.7.1.2.txt[1.7.1.2],
 186  link:RelNotes/1.7.1.1.txt[1.7.1.1],
 187  link:RelNotes/1.7.1.txt[1.7.1].
 188
 189* link:v1.7.0.9/git.html[documentation for release 1.7.0.9]
 190
 191* release notes for
 192  link:RelNotes/1.7.0.9.txt[1.7.0.9],
 193  link:RelNotes/1.7.0.8.txt[1.7.0.8],
 194  link:RelNotes/1.7.0.7.txt[1.7.0.7],
 195  link:RelNotes/1.7.0.6.txt[1.7.0.6],
 196  link:RelNotes/1.7.0.5.txt[1.7.0.5],
 197  link:RelNotes/1.7.0.4.txt[1.7.0.4],
 198  link:RelNotes/1.7.0.3.txt[1.7.0.3],
 199  link:RelNotes/1.7.0.2.txt[1.7.0.2],
 200  link:RelNotes/1.7.0.1.txt[1.7.0.1],
 201  link:RelNotes/1.7.0.txt[1.7.0].
 202
 203* link:v1.6.6.3/git.html[documentation for release 1.6.6.3]
 204
 205* release notes for
 206  link:RelNotes/1.6.6.3.txt[1.6.6.3],
 207  link:RelNotes/1.6.6.2.txt[1.6.6.2],
 208  link:RelNotes/1.6.6.1.txt[1.6.6.1],
 209  link:RelNotes/1.6.6.txt[1.6.6].
 210
 211* link:v1.6.5.9/git.html[documentation for release 1.6.5.9]
 212
 213* release notes for
 214  link:RelNotes/1.6.5.9.txt[1.6.5.9],
 215  link:RelNotes/1.6.5.8.txt[1.6.5.8],
 216  link:RelNotes/1.6.5.7.txt[1.6.5.7],
 217  link:RelNotes/1.6.5.6.txt[1.6.5.6],
 218  link:RelNotes/1.6.5.5.txt[1.6.5.5],
 219  link:RelNotes/1.6.5.4.txt[1.6.5.4],
 220  link:RelNotes/1.6.5.3.txt[1.6.5.3],
 221  link:RelNotes/1.6.5.2.txt[1.6.5.2],
 222  link:RelNotes/1.6.5.1.txt[1.6.5.1],
 223  link:RelNotes/1.6.5.txt[1.6.5].
 224
 225* link:v1.6.4.5/git.html[documentation for release 1.6.4.5]
 226
 227* release notes for
 228  link:RelNotes/1.6.4.5.txt[1.6.4.5],
 229  link:RelNotes/1.6.4.4.txt[1.6.4.4],
 230  link:RelNotes/1.6.4.3.txt[1.6.4.3],
 231  link:RelNotes/1.6.4.2.txt[1.6.4.2],
 232  link:RelNotes/1.6.4.1.txt[1.6.4.1],
 233  link:RelNotes/1.6.4.txt[1.6.4].
 234
 235* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
 236
 237* release notes for
 238  link:RelNotes/1.6.3.4.txt[1.6.3.4],
 239  link:RelNotes/1.6.3.3.txt[1.6.3.3],
 240  link:RelNotes/1.6.3.2.txt[1.6.3.2],
 241  link:RelNotes/1.6.3.1.txt[1.6.3.1],
 242  link:RelNotes/1.6.3.txt[1.6.3].
 243
 244* release notes for
 245  link:RelNotes/1.6.2.5.txt[1.6.2.5],
 246  link:RelNotes/1.6.2.4.txt[1.6.2.4],
 247  link:RelNotes/1.6.2.3.txt[1.6.2.3],
 248  link:RelNotes/1.6.2.2.txt[1.6.2.2],
 249  link:RelNotes/1.6.2.1.txt[1.6.2.1],
 250  link:RelNotes/1.6.2.txt[1.6.2].
 251
 252* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
 253
 254* release notes for
 255  link:RelNotes/1.6.1.3.txt[1.6.1.3],
 256  link:RelNotes/1.6.1.2.txt[1.6.1.2],
 257  link:RelNotes/1.6.1.1.txt[1.6.1.1],
 258  link:RelNotes/1.6.1.txt[1.6.1].
 259
 260* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
 261
 262* release notes for
 263  link:RelNotes/1.6.0.6.txt[1.6.0.6],
 264  link:RelNotes/1.6.0.5.txt[1.6.0.5],
 265  link:RelNotes/1.6.0.4.txt[1.6.0.4],
 266  link:RelNotes/1.6.0.3.txt[1.6.0.3],
 267  link:RelNotes/1.6.0.2.txt[1.6.0.2],
 268  link:RelNotes/1.6.0.1.txt[1.6.0.1],
 269  link:RelNotes/1.6.0.txt[1.6.0].
 270
 271* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
 272
 273* release notes for
 274  link:RelNotes/1.5.6.6.txt[1.5.6.6],
 275  link:RelNotes/1.5.6.5.txt[1.5.6.5],
 276  link:RelNotes/1.5.6.4.txt[1.5.6.4],
 277  link:RelNotes/1.5.6.3.txt[1.5.6.3],
 278  link:RelNotes/1.5.6.2.txt[1.5.6.2],
 279  link:RelNotes/1.5.6.1.txt[1.5.6.1],
 280  link:RelNotes/1.5.6.txt[1.5.6].
 281
 282* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
 283
 284* release notes for
 285  link:RelNotes/1.5.5.6.txt[1.5.5.6],
 286  link:RelNotes/1.5.5.5.txt[1.5.5.5],
 287  link:RelNotes/1.5.5.4.txt[1.5.5.4],
 288  link:RelNotes/1.5.5.3.txt[1.5.5.3],
 289  link:RelNotes/1.5.5.2.txt[1.5.5.2],
 290  link:RelNotes/1.5.5.1.txt[1.5.5.1],
 291  link:RelNotes/1.5.5.txt[1.5.5].
 292
 293* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
 294
 295* release notes for
 296  link:RelNotes/1.5.4.7.txt[1.5.4.7],
 297  link:RelNotes/1.5.4.6.txt[1.5.4.6],
 298  link:RelNotes/1.5.4.5.txt[1.5.4.5],
 299  link:RelNotes/1.5.4.4.txt[1.5.4.4],
 300  link:RelNotes/1.5.4.3.txt[1.5.4.3],
 301  link:RelNotes/1.5.4.2.txt[1.5.4.2],
 302  link:RelNotes/1.5.4.1.txt[1.5.4.1],
 303  link:RelNotes/1.5.4.txt[1.5.4].
 304
 305* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
 306
 307* release notes for
 308  link:RelNotes/1.5.3.8.txt[1.5.3.8],
 309  link:RelNotes/1.5.3.7.txt[1.5.3.7],
 310  link:RelNotes/1.5.3.6.txt[1.5.3.6],
 311  link:RelNotes/1.5.3.5.txt[1.5.3.5],
 312  link:RelNotes/1.5.3.4.txt[1.5.3.4],
 313  link:RelNotes/1.5.3.3.txt[1.5.3.3],
 314  link:RelNotes/1.5.3.2.txt[1.5.3.2],
 315  link:RelNotes/1.5.3.1.txt[1.5.3.1],
 316  link:RelNotes/1.5.3.txt[1.5.3].
 317
 318* link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
 319
 320* release notes for
 321  link:RelNotes/1.5.2.5.txt[1.5.2.5],
 322  link:RelNotes/1.5.2.4.txt[1.5.2.4],
 323  link:RelNotes/1.5.2.3.txt[1.5.2.3],
 324  link:RelNotes/1.5.2.2.txt[1.5.2.2],
 325  link:RelNotes/1.5.2.1.txt[1.5.2.1],
 326  link:RelNotes/1.5.2.txt[1.5.2].
 327
 328* link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
 329
 330* release notes for
 331  link:RelNotes/1.5.1.6.txt[1.5.1.6],
 332  link:RelNotes/1.5.1.5.txt[1.5.1.5],
 333  link:RelNotes/1.5.1.4.txt[1.5.1.4],
 334  link:RelNotes/1.5.1.3.txt[1.5.1.3],
 335  link:RelNotes/1.5.1.2.txt[1.5.1.2],
 336  link:RelNotes/1.5.1.1.txt[1.5.1.1],
 337  link:RelNotes/1.5.1.txt[1.5.1].
 338
 339* link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
 340
 341* release notes for
 342  link:RelNotes/1.5.0.7.txt[1.5.0.7],
 343  link:RelNotes/1.5.0.6.txt[1.5.0.6],
 344  link:RelNotes/1.5.0.5.txt[1.5.0.5],
 345  link:RelNotes/1.5.0.3.txt[1.5.0.3],
 346  link:RelNotes/1.5.0.2.txt[1.5.0.2],
 347  link:RelNotes/1.5.0.1.txt[1.5.0.1],
 348  link:RelNotes/1.5.0.txt[1.5.0].
 349
 350* documentation for release link:v1.4.4.4/git.html[1.4.4.4],
 351  link:v1.3.3/git.html[1.3.3],
 352  link:v1.2.6/git.html[1.2.6],
 353  link:v1.0.13/git.html[1.0.13].
 354
 355============
 356
 357endif::stalenotes[]
 358
 359OPTIONS
 360-------
 361--version::
 362        Prints the Git suite version that the 'git' program came from.
 363
 364--help::
 365        Prints the synopsis and a list of the most commonly used
 366        commands. If the option '--all' or '-a' is given then all
 367        available commands are printed. If a Git command is named this
 368        option will bring up the manual page for that command.
 369+
 370Other options are available to control how the manual page is
 371displayed. See linkgit:git-help[1] for more information,
 372because `git --help ...` is converted internally into `git
 373help ...`.
 374
 375-c <name>=<value>::
 376        Pass a configuration parameter to the command. The value
 377        given will override values from configuration files.
 378        The <name> is expected in the same format as listed by
 379        'git config' (subkeys separated by dots).
 380
 381--exec-path[=<path>]::
 382        Path to wherever your core Git programs are installed.
 383        This can also be controlled by setting the GIT_EXEC_PATH
 384        environment variable. If no path is given, 'git' will print
 385        the current setting and then exit.
 386
 387--html-path::
 388        Print the path, without trailing slash, where Git's HTML
 389        documentation is installed and exit.
 390
 391--man-path::
 392        Print the manpath (see `man(1)`) for the man pages for
 393        this version of Git and exit.
 394
 395--info-path::
 396        Print the path where the Info files documenting this
 397        version of Git are installed and exit.
 398
 399-p::
 400--paginate::
 401        Pipe all output into 'less' (or if set, $PAGER) if standard
 402        output is a terminal.  This overrides the `pager.<cmd>`
 403        configuration options (see the "Configuration Mechanism" section
 404        below).
 405
 406--no-pager::
 407        Do not pipe Git output into a pager.
 408
 409--git-dir=<path>::
 410        Set the path to the repository. This can also be controlled by
 411        setting the GIT_DIR environment variable. It can be an absolute
 412        path or relative path to current working directory.
 413
 414--work-tree=<path>::
 415        Set the path to the working tree. It can be an absolute path
 416        or a path relative to the current working directory.
 417        This can also be controlled by setting the GIT_WORK_TREE
 418        environment variable and the core.worktree configuration
 419        variable (see core.worktree in linkgit:git-config[1] for a
 420        more detailed discussion).
 421
 422--namespace=<path>::
 423        Set the Git namespace.  See linkgit:gitnamespaces[7] for more
 424        details.  Equivalent to setting the `GIT_NAMESPACE` environment
 425        variable.
 426
 427--bare::
 428        Treat the repository as a bare repository.  If GIT_DIR
 429        environment is not set, it is set to the current working
 430        directory.
 431
 432--no-replace-objects::
 433        Do not use replacement refs to replace Git objects. See
 434        linkgit:git-replace[1] for more information.
 435
 436--literal-pathspecs::
 437        Treat pathspecs literally, rather than as glob patterns. This is
 438        equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
 439        variable to `1`.
 440
 441
 442GIT COMMANDS
 443------------
 444
 445We divide Git into high level ("porcelain") commands and low level
 446("plumbing") commands.
 447
 448High-level commands (porcelain)
 449-------------------------------
 450
 451We separate the porcelain commands into the main commands and some
 452ancillary user utilities.
 453
 454Main porcelain commands
 455~~~~~~~~~~~~~~~~~~~~~~~
 456
 457include::cmds-mainporcelain.txt[]
 458
 459Ancillary Commands
 460~~~~~~~~~~~~~~~~~~
 461Manipulators:
 462
 463include::cmds-ancillarymanipulators.txt[]
 464
 465Interrogators:
 466
 467include::cmds-ancillaryinterrogators.txt[]
 468
 469
 470Interacting with Others
 471~~~~~~~~~~~~~~~~~~~~~~~
 472
 473These commands are to interact with foreign SCM and with other
 474people via patch over e-mail.
 475
 476include::cmds-foreignscminterface.txt[]
 477
 478
 479Low-level commands (plumbing)
 480-----------------------------
 481
 482Although Git includes its
 483own porcelain layer, its low-level commands are sufficient to support
 484development of alternative porcelains.  Developers of such porcelains
 485might start by reading about linkgit:git-update-index[1] and
 486linkgit:git-read-tree[1].
 487
 488The interface (input, output, set of options and the semantics)
 489to these low-level commands are meant to be a lot more stable
 490than Porcelain level commands, because these commands are
 491primarily for scripted use.  The interface to Porcelain commands
 492on the other hand are subject to change in order to improve the
 493end user experience.
 494
 495The following description divides
 496the low-level commands into commands that manipulate objects (in
 497the repository, index, and working tree), commands that interrogate and
 498compare objects, and commands that move objects and references between
 499repositories.
 500
 501
 502Manipulation commands
 503~~~~~~~~~~~~~~~~~~~~~
 504
 505include::cmds-plumbingmanipulators.txt[]
 506
 507
 508Interrogation commands
 509~~~~~~~~~~~~~~~~~~~~~~
 510
 511include::cmds-plumbinginterrogators.txt[]
 512
 513In general, the interrogate commands do not touch the files in
 514the working tree.
 515
 516
 517Synching repositories
 518~~~~~~~~~~~~~~~~~~~~~
 519
 520include::cmds-synchingrepositories.txt[]
 521
 522The following are helper commands used by the above; end users
 523typically do not use them directly.
 524
 525include::cmds-synchelpers.txt[]
 526
 527
 528Internal helper commands
 529~~~~~~~~~~~~~~~~~~~~~~~~
 530
 531These are internal helper commands used by other commands; end
 532users typically do not use them directly.
 533
 534include::cmds-purehelpers.txt[]
 535
 536
 537Configuration Mechanism
 538-----------------------
 539
 540Git uses a simple text format to store customizations that are per
 541repository and are per user.  Such a configuration file may look
 542like this:
 543
 544------------
 545#
 546# A '#' or ';' character indicates a comment.
 547#
 548
 549; core variables
 550[core]
 551        ; Don't trust file modes
 552        filemode = false
 553
 554; user identity
 555[user]
 556        name = "Junio C Hamano"
 557        email = "gitster@pobox.com"
 558
 559------------
 560
 561Various commands read from the configuration file and adjust
 562their operation accordingly.  See linkgit:git-config[1] for a
 563list and more details about the configuration mechanism.
 564
 565
 566Identifier Terminology
 567----------------------
 568<object>::
 569        Indicates the object name for any type of object.
 570
 571<blob>::
 572        Indicates a blob object name.
 573
 574<tree>::
 575        Indicates a tree object name.
 576
 577<commit>::
 578        Indicates a commit object name.
 579
 580<tree-ish>::
 581        Indicates a tree, commit or tag object name.  A
 582        command that takes a <tree-ish> argument ultimately wants to
 583        operate on a <tree> object but automatically dereferences
 584        <commit> and <tag> objects that point at a <tree>.
 585
 586<commit-ish>::
 587        Indicates a commit or tag object name.  A
 588        command that takes a <commit-ish> argument ultimately wants to
 589        operate on a <commit> object but automatically dereferences
 590        <tag> objects that point at a <commit>.
 591
 592<type>::
 593        Indicates that an object type is required.
 594        Currently one of: `blob`, `tree`, `commit`, or `tag`.
 595
 596<file>::
 597        Indicates a filename - almost always relative to the
 598        root of the tree structure `GIT_INDEX_FILE` describes.
 599
 600Symbolic Identifiers
 601--------------------
 602Any Git command accepting any <object> can also use the following
 603symbolic notation:
 604
 605HEAD::
 606        indicates the head of the current branch.
 607
 608<tag>::
 609        a valid tag 'name'
 610        (i.e. a `refs/tags/<tag>` reference).
 611
 612<head>::
 613        a valid head 'name'
 614        (i.e. a `refs/heads/<head>` reference).
 615
 616For a more complete list of ways to spell object names, see
 617"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
 618
 619
 620File/Directory Structure
 621------------------------
 622
 623Please see the linkgit:gitrepository-layout[5] document.
 624
 625Read linkgit:githooks[5] for more details about each hook.
 626
 627Higher level SCMs may provide and manage additional information in the
 628`$GIT_DIR`.
 629
 630
 631Terminology
 632-----------
 633Please see linkgit:gitglossary[7].
 634
 635
 636Environment Variables
 637---------------------
 638Various Git commands use the following environment variables:
 639
 640The Git Repository
 641~~~~~~~~~~~~~~~~~~
 642These environment variables apply to 'all' core Git commands. Nb: it
 643is worth noting that they may be used/overridden by SCMS sitting above
 644Git so take care if using Cogito etc.
 645
 646'GIT_INDEX_FILE'::
 647        This environment allows the specification of an alternate
 648        index file. If not specified, the default of `$GIT_DIR/index`
 649        is used.
 650
 651'GIT_OBJECT_DIRECTORY'::
 652        If the object storage directory is specified via this
 653        environment variable then the sha1 directories are created
 654        underneath - otherwise the default `$GIT_DIR/objects`
 655        directory is used.
 656
 657'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
 658        Due to the immutable nature of Git objects, old objects can be
 659        archived into shared, read-only directories. This variable
 660        specifies a ":" separated (on Windows ";" separated) list
 661        of Git object directories which can be used to search for Git
 662        objects. New objects will not be written to these directories.
 663
 664'GIT_DIR'::
 665        If the 'GIT_DIR' environment variable is set then it
 666        specifies a path to use instead of the default `.git`
 667        for the base of the repository.
 668        The '--git-dir' command-line option also sets this value.
 669
 670'GIT_WORK_TREE'::
 671        Set the path to the working tree.  The value will not be
 672        used in combination with repositories found automatically in
 673        a .git directory (i.e. $GIT_DIR is not set).
 674        This can also be controlled by the '--work-tree' command line
 675        option and the core.worktree configuration variable.
 676
 677'GIT_NAMESPACE'::
 678        Set the Git namespace; see linkgit:gitnamespaces[7] for details.
 679        The '--namespace' command-line option also sets this value.
 680
 681'GIT_CEILING_DIRECTORIES'::
 682        This should be a colon-separated list of absolute paths.  If
 683        set, it is a list of directories that Git should not chdir up
 684        into while looking for a repository directory (useful for
 685        excluding slow-loading network directories).  It will not
 686        exclude the current working directory or a GIT_DIR set on the
 687        command line or in the environment.  Normally, Git has to read
 688        the entries in this list and resolve any symlink that
 689        might be present in order to compare them with the current
 690        directory.  However, if even this access is slow, you
 691        can add an empty entry to the list to tell Git that the
 692        subsequent entries are not symlinks and needn't be resolved;
 693        e.g.,
 694        'GIT_CEILING_DIRECTORIES=/maybe/symlink::/very/slow/non/symlink'.
 695
 696'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
 697        When run in a directory that does not have ".git" repository
 698        directory, Git tries to find such a directory in the parent
 699        directories to find the top of the working tree, but by default it
 700        does not cross filesystem boundaries.  This environment variable
 701        can be set to true to tell Git not to stop at filesystem
 702        boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
 703        an explicit repository directory set via 'GIT_DIR' or on the
 704        command line.
 705
 706Git Commits
 707~~~~~~~~~~~
 708'GIT_AUTHOR_NAME'::
 709'GIT_AUTHOR_EMAIL'::
 710'GIT_AUTHOR_DATE'::
 711'GIT_COMMITTER_NAME'::
 712'GIT_COMMITTER_EMAIL'::
 713'GIT_COMMITTER_DATE'::
 714'EMAIL'::
 715        see linkgit:git-commit-tree[1]
 716
 717Git Diffs
 718~~~~~~~~~
 719'GIT_DIFF_OPTS'::
 720        Only valid setting is "--unified=??" or "-u??" to set the
 721        number of context lines shown when a unified diff is created.
 722        This takes precedence over any "-U" or "--unified" option
 723        value passed on the Git diff command line.
 724
 725'GIT_EXTERNAL_DIFF'::
 726        When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
 727        program named by it is called, instead of the diff invocation
 728        described above.  For a path that is added, removed, or modified,
 729        'GIT_EXTERNAL_DIFF' is called with 7 parameters:
 730
 731        path old-file old-hex old-mode new-file new-hex new-mode
 732+
 733where:
 734
 735        <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
 736                         contents of <old|new>,
 737        <old|new>-hex:: are the 40-hexdigit SHA1 hashes,
 738        <old|new>-mode:: are the octal representation of the file modes.
 739+
 740The file parameters can point at the user's working file
 741(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
 742when a new file is added), or a temporary file (e.g. `old-file` in the
 743index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
 744temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
 745+
 746For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
 747parameter, <path>.
 748
 749other
 750~~~~~
 751'GIT_MERGE_VERBOSITY'::
 752        A number controlling the amount of output shown by
 753        the recursive merge strategy.  Overrides merge.verbosity.
 754        See linkgit:git-merge[1]
 755
 756'GIT_PAGER'::
 757        This environment variable overrides `$PAGER`. If it is set
 758        to an empty string or to the value "cat", Git will not launch
 759        a pager.  See also the `core.pager` option in
 760        linkgit:git-config[1].
 761
 762'GIT_EDITOR'::
 763        This environment variable overrides `$EDITOR` and `$VISUAL`.
 764        It is used by several Git commands when, on interactive mode,
 765        an editor is to be launched. See also linkgit:git-var[1]
 766        and the `core.editor` option in linkgit:git-config[1].
 767
 768'GIT_SSH'::
 769        If this environment variable is set then 'git fetch'
 770        and 'git push' will use this command instead
 771        of 'ssh' when they need to connect to a remote system.
 772        The '$GIT_SSH' command will be given exactly two arguments:
 773        the 'username@host' (or just 'host') from the URL and the
 774        shell command to execute on that remote system.
 775+
 776To pass options to the program that you want to list in GIT_SSH
 777you will need to wrap the program and options into a shell script,
 778then set GIT_SSH to refer to the shell script.
 779+
 780Usually it is easier to configure any desired options through your
 781personal `.ssh/config` file.  Please consult your ssh documentation
 782for further details.
 783
 784'GIT_ASKPASS'::
 785        If this environment variable is set, then Git commands which need to
 786        acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
 787        will call this program with a suitable prompt as command line argument
 788        and read the password from its STDOUT. See also the 'core.askpass'
 789        option in linkgit:git-config[1].
 790
 791'GIT_CONFIG_NOSYSTEM'::
 792        Whether to skip reading settings from the system-wide
 793        `$(prefix)/etc/gitconfig` file.  This environment variable can
 794        be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
 795        predictable environment for a picky script, or you can set it
 796        temporarily to avoid using a buggy `/etc/gitconfig` file while
 797        waiting for someone with sufficient permissions to fix it.
 798
 799'GIT_FLUSH'::
 800        If this environment variable is set to "1", then commands such
 801        as 'git blame' (in incremental mode), 'git rev-list', 'git log',
 802        and 'git whatchanged' will force a flush of the output stream
 803        after each commit-oriented record have been flushed.   If this
 804        variable is set to "0", the output of these commands will be done
 805        using completely buffered I/O.   If this environment variable is
 806        not set, Git will choose buffered or record-oriented flushing
 807        based on whether stdout appears to be redirected to a file or not.
 808
 809'GIT_TRACE'::
 810        If this variable is set to "1", "2" or "true" (comparison
 811        is case insensitive), Git will print `trace:` messages on
 812        stderr telling about alias expansion, built-in command
 813        execution and external command execution.
 814        If this variable is set to an integer value greater than 1
 815        and lower than 10 (strictly) then Git will interpret this
 816        value as an open file descriptor and will try to write the
 817        trace messages into this file descriptor.
 818        Alternatively, if this variable is set to an absolute path
 819        (starting with a '/' character), Git will interpret this
 820        as a file path and will try to write the trace messages
 821        into it.
 822
 823GIT_LITERAL_PATHSPECS::
 824        Setting this variable to `1` will cause Git to treat all
 825        pathspecs literally, rather than as glob patterns. For example,
 826        running `GIT_LITERAL_PATHSPECS=1 git log -- '*.c'` will search
 827        for commits that touch the path `*.c`, not any paths that the
 828        glob `*.c` matches. You might want this if you are feeding
 829        literal paths to Git (e.g., paths previously given to you by
 830        `git ls-tree`, `--raw` diff output, etc).
 831
 832
 833Discussion[[Discussion]]
 834------------------------
 835
 836More detail on the following is available from the
 837link:user-manual.html#git-concepts[Git concepts chapter of the
 838user-manual] and linkgit:gitcore-tutorial[7].
 839
 840A Git project normally consists of a working directory with a ".git"
 841subdirectory at the top level.  The .git directory contains, among other
 842things, a compressed object database representing the complete history
 843of the project, an "index" file which links that history to the current
 844contents of the working tree, and named pointers into that history such
 845as tags and branch heads.
 846
 847The object database contains objects of three main types: blobs, which
 848hold file data; trees, which point to blobs and other trees to build up
 849directory hierarchies; and commits, which each reference a single tree
 850and some number of parent commits.
 851
 852The commit, equivalent to what other systems call a "changeset" or
 853"version", represents a step in the project's history, and each parent
 854represents an immediately preceding step.  Commits with more than one
 855parent represent merges of independent lines of development.
 856
 857All objects are named by the SHA1 hash of their contents, normally
 858written as a string of 40 hex digits.  Such names are globally unique.
 859The entire history leading up to a commit can be vouched for by signing
 860just that commit.  A fourth object type, the tag, is provided for this
 861purpose.
 862
 863When first created, objects are stored in individual files, but for
 864efficiency may later be compressed together into "pack files".
 865
 866Named pointers called refs mark interesting points in history.  A ref
 867may contain the SHA1 name of an object or the name of another ref.  Refs
 868with names beginning `ref/head/` contain the SHA1 name of the most
 869recent commit (or "head") of a branch under development.  SHA1 names of
 870tags of interest are stored under `ref/tags/`.  A special ref named
 871`HEAD` contains the name of the currently checked-out branch.
 872
 873The index file is initialized with a list of all paths and, for each
 874path, a blob object and a set of attributes.  The blob object represents
 875the contents of the file as of the head of the current branch.  The
 876attributes (last modified time, size, etc.) are taken from the
 877corresponding file in the working tree.  Subsequent changes to the
 878working tree can be found by comparing these attributes.  The index may
 879be updated with new content, and new commits may be created from the
 880content stored in the index.
 881
 882The index is also capable of storing multiple entries (called "stages")
 883for a given pathname.  These stages are used to hold the various
 884unmerged version of a file when a merge is in progress.
 885
 886FURTHER DOCUMENTATION
 887---------------------
 888
 889See the references in the "description" section to get started
 890using Git.  The following is probably more detail than necessary
 891for a first-time user.
 892
 893The link:user-manual.html#git-concepts[Git concepts chapter of the
 894user-manual] and linkgit:gitcore-tutorial[7] both provide
 895introductions to the underlying Git architecture.
 896
 897See linkgit:gitworkflows[7] for an overview of recommended workflows.
 898
 899See also the link:howto-index.html[howto] documents for some useful
 900examples.
 901
 902The internals are documented in the
 903link:technical/api-index.html[Git API documentation].
 904
 905Users migrating from CVS may also want to
 906read linkgit:gitcvs-migration[7].
 907
 908
 909Authors
 910-------
 911Git was started by Linus Torvalds, and is currently maintained by Junio
 912C Hamano. Numerous contributions have come from the Git mailing list
 913<git@vger.kernel.org>.  http://www.ohloh.net/p/git/contributors/summary
 914gives you a more complete list of contributors.
 915
 916If you have a clone of git.git itself, the
 917output of linkgit:git-shortlog[1] and linkgit:git-blame[1] can show you
 918the authors for specific parts of the project.
 919
 920Reporting Bugs
 921--------------
 922
 923Report bugs to the Git mailing list <git@vger.kernel.org> where the
 924development and maintenance is primarily done.  You do not have to be
 925subscribed to the list to send a message there.
 926
 927SEE ALSO
 928--------
 929linkgit:gittutorial[7], linkgit:gittutorial-2[7],
 930link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
 931linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
 932linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
 933linkgit:gitworkflows[7]
 934
 935GIT
 936---
 937Part of the linkgit:git[1] suite