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