Documentation/git.txt

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