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