git.txt 24.1 KB
Newer Older
1
git(1)
2 3 4 5 6 7 8 9 10
======

NAME
----
git - the stupid content tracker


SYNOPSIS
--------
11
[verse]
12
'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
13
    [-p|--paginate|--no-pager] [--no-replace-objects]
14
    [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
15
    [-c name=value]
16
    [--help] COMMAND [ARGS]
17 18 19

DESCRIPTION
-----------
20 21 22 23
Git is a fast, scalable, distributed revision control system with an
unusually rich command set that provides both high-level operations
and full access to internals.

24
See linkgit:gittutorial[7] to get started, then see
25 26
link:everyday.html[Everyday Git] for a useful minimum set of commands, and
"man git-commandname" for documentation of each command.  CVS users may
27 28
also want to read linkgit:gitcvs-migration[7].  See
the link:user-manual.html[Git User's Manual] for a more in-depth
29
introduction.
30

P
Petr Baudis 已提交
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]).
P
Petr Baudis 已提交
33

34 35 36 37
Formatted and hyperlinked version of the latest git
documentation can be viewed at
`http://www.kernel.org/pub/software/scm/git/docs/`.

38 39 40 41
ifdef::stalenotes[]
[NOTE]
============

42 43 44 45
You are reading the documentation for the latest (possibly
unreleased) version of git, that is available from 'master'
branch of the `git.git` repository.
Documentation for older releases are available here:
46

J
Junio C Hamano 已提交
47
* link:v1.7.3.1/git.html[documentation for release 1.7.3.1]
J
Junio C Hamano 已提交
48 49

* release notes for
J
Junio C Hamano 已提交
50
  link:RelNotes/1.7.3.1.txt[1.7.3.1],
J
Junio C Hamano 已提交
51 52
  link:RelNotes/1.7.3.txt[1.7.3].

J
Junio C Hamano 已提交
53
* link:v1.7.2.3/git.html[documentation for release 1.7.2.3]
J
Junio C Hamano 已提交
54 55

* release notes for
56 57 58 59
  link:RelNotes/1.7.2.3.txt[1.7.2.3],
  link:RelNotes/1.7.2.2.txt[1.7.2.2],
  link:RelNotes/1.7.2.1.txt[1.7.2.1],
  link:RelNotes/1.7.2.txt[1.7.2].
J
Junio C Hamano 已提交
60

J
Junio C Hamano 已提交
61
* link:v1.7.1.2/git.html[documentation for release 1.7.1.2]
J
Junio C Hamano 已提交
62 63

* release notes for
64 65 66
  link:RelNotes/1.7.1.2.txt[1.7.1.2],
  link:RelNotes/1.7.1.1.txt[1.7.1.1],
  link:RelNotes/1.7.1.txt[1.7.1].
J
Junio C Hamano 已提交
67

J
Junio C Hamano 已提交
68
* link:v1.7.0.7/git.html[documentation for release 1.7.0.7]
J
Junio C Hamano 已提交
69 70

* release notes for
71 72 73 74 75 76 77 78
  link:RelNotes/1.7.0.7.txt[1.7.0.7],
  link:RelNotes/1.7.0.6.txt[1.7.0.6],
  link:RelNotes/1.7.0.5.txt[1.7.0.5],
  link:RelNotes/1.7.0.4.txt[1.7.0.4],
  link:RelNotes/1.7.0.3.txt[1.7.0.3],
  link:RelNotes/1.7.0.2.txt[1.7.0.2],
  link:RelNotes/1.7.0.1.txt[1.7.0.1],
  link:RelNotes/1.7.0.txt[1.7.0].
J
Junio C Hamano 已提交
79

J
Junio C Hamano 已提交
80
* link:v1.6.6.2/git.html[documentation for release 1.6.6.2]
J
Junio C Hamano 已提交
81 82

* release notes for
83 84 85
  link:RelNotes/1.6.6.2.txt[1.6.6.2],
  link:RelNotes/1.6.6.1.txt[1.6.6.1],
  link:RelNotes/1.6.6.txt[1.6.6].
J
Junio C Hamano 已提交
86

J
Junio C Hamano 已提交
87
* link:v1.6.5.8/git.html[documentation for release 1.6.5.8]
J
Junio C Hamano 已提交
88 89

* release notes for
90 91 92 93 94 95 96 97 98
  link:RelNotes/1.6.5.8.txt[1.6.5.8],
  link:RelNotes/1.6.5.7.txt[1.6.5.7],
  link:RelNotes/1.6.5.6.txt[1.6.5.6],
  link:RelNotes/1.6.5.5.txt[1.6.5.5],
  link:RelNotes/1.6.5.4.txt[1.6.5.4],
  link:RelNotes/1.6.5.3.txt[1.6.5.3],
  link:RelNotes/1.6.5.2.txt[1.6.5.2],
  link:RelNotes/1.6.5.1.txt[1.6.5.1],
  link:RelNotes/1.6.5.txt[1.6.5].
J
Junio C Hamano 已提交
99

J
Junio C Hamano 已提交
100
* link:v1.6.4.4/git.html[documentation for release 1.6.4.4]
J
Junio C Hamano 已提交
101 102

* release notes for
103 104 105 106 107
  link:RelNotes/1.6.4.4.txt[1.6.4.4],
  link:RelNotes/1.6.4.3.txt[1.6.4.3],
  link:RelNotes/1.6.4.2.txt[1.6.4.2],
  link:RelNotes/1.6.4.1.txt[1.6.4.1],
  link:RelNotes/1.6.4.txt[1.6.4].
J
Junio C Hamano 已提交
108

J
Junio C Hamano 已提交
109
* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
110 111

* release notes for
112 113 114 115 116
  link:RelNotes/1.6.3.4.txt[1.6.3.4],
  link:RelNotes/1.6.3.3.txt[1.6.3.3],
  link:RelNotes/1.6.3.2.txt[1.6.3.2],
  link:RelNotes/1.6.3.1.txt[1.6.3.1],
  link:RelNotes/1.6.3.txt[1.6.3].
J
Junio C Hamano 已提交
117 118

* release notes for
119 120 121 122 123 124
  link:RelNotes/1.6.2.5.txt[1.6.2.5],
  link:RelNotes/1.6.2.4.txt[1.6.2.4],
  link:RelNotes/1.6.2.3.txt[1.6.2.3],
  link:RelNotes/1.6.2.2.txt[1.6.2.2],
  link:RelNotes/1.6.2.1.txt[1.6.2.1],
  link:RelNotes/1.6.2.txt[1.6.2].
J
Junio C Hamano 已提交
125

J
Junio C Hamano 已提交
126
* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
J
Junio C Hamano 已提交
127 128

* release notes for
129 130 131 132
  link:RelNotes/1.6.1.3.txt[1.6.1.3],
  link:RelNotes/1.6.1.2.txt[1.6.1.2],
  link:RelNotes/1.6.1.1.txt[1.6.1.1],
  link:RelNotes/1.6.1.txt[1.6.1].
J
Junio C Hamano 已提交
133

134
* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
J
Junio C Hamano 已提交
135 136

* release notes for
137 138 139 140 141 142 143
  link:RelNotes/1.6.0.6.txt[1.6.0.6],
  link:RelNotes/1.6.0.5.txt[1.6.0.5],
  link:RelNotes/1.6.0.4.txt[1.6.0.4],
  link:RelNotes/1.6.0.3.txt[1.6.0.3],
  link:RelNotes/1.6.0.2.txt[1.6.0.2],
  link:RelNotes/1.6.0.1.txt[1.6.0.1],
  link:RelNotes/1.6.0.txt[1.6.0].
J
Junio C Hamano 已提交
144

145
* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
J
Junio C Hamano 已提交
146 147

* release notes for
148 149 150 151 152 153 154
  link:RelNotes/1.5.6.6.txt[1.5.6.6],
  link:RelNotes/1.5.6.5.txt[1.5.6.5],
  link:RelNotes/1.5.6.4.txt[1.5.6.4],
  link:RelNotes/1.5.6.3.txt[1.5.6.3],
  link:RelNotes/1.5.6.2.txt[1.5.6.2],
  link:RelNotes/1.5.6.1.txt[1.5.6.1],
  link:RelNotes/1.5.6.txt[1.5.6].
J
Junio C Hamano 已提交
155

156
* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
J
Junio C Hamano 已提交
157 158

* release notes for
159 160 161 162 163 164 165
  link:RelNotes/1.5.5.6.txt[1.5.5.6],
  link:RelNotes/1.5.5.5.txt[1.5.5.5],
  link:RelNotes/1.5.5.4.txt[1.5.5.4],
  link:RelNotes/1.5.5.3.txt[1.5.5.3],
  link:RelNotes/1.5.5.2.txt[1.5.5.2],
  link:RelNotes/1.5.5.1.txt[1.5.5.1],
  link:RelNotes/1.5.5.txt[1.5.5].
J
Junio C Hamano 已提交
166

167
* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
168 169

* release notes for
170 171 172 173 174 175 176 177
  link:RelNotes/1.5.4.7.txt[1.5.4.7],
  link:RelNotes/1.5.4.6.txt[1.5.4.6],
  link:RelNotes/1.5.4.5.txt[1.5.4.5],
  link:RelNotes/1.5.4.4.txt[1.5.4.4],
  link:RelNotes/1.5.4.3.txt[1.5.4.3],
  link:RelNotes/1.5.4.2.txt[1.5.4.2],
  link:RelNotes/1.5.4.1.txt[1.5.4.1],
  link:RelNotes/1.5.4.txt[1.5.4].
178

J
Junio C Hamano 已提交
179
* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
180 181

* release notes for
182 183 184 185 186 187 188 189 190
  link:RelNotes/1.5.3.8.txt[1.5.3.8],
  link:RelNotes/1.5.3.7.txt[1.5.3.7],
  link:RelNotes/1.5.3.6.txt[1.5.3.6],
  link:RelNotes/1.5.3.5.txt[1.5.3.5],
  link:RelNotes/1.5.3.4.txt[1.5.3.4],
  link:RelNotes/1.5.3.3.txt[1.5.3.3],
  link:RelNotes/1.5.3.2.txt[1.5.3.2],
  link:RelNotes/1.5.3.1.txt[1.5.3.1],
  link:RelNotes/1.5.3.txt[1.5.3].
191

J
Junio C Hamano 已提交
192 193
* link:v1.5.2.5/git.html[documentation for release 1.5.2.5]

J
Junio C Hamano 已提交
194
* release notes for
195 196 197 198 199 200
  link:RelNotes/1.5.2.5.txt[1.5.2.5],
  link:RelNotes/1.5.2.4.txt[1.5.2.4],
  link:RelNotes/1.5.2.3.txt[1.5.2.3],
  link:RelNotes/1.5.2.2.txt[1.5.2.2],
  link:RelNotes/1.5.2.1.txt[1.5.2.1],
  link:RelNotes/1.5.2.txt[1.5.2].
J
Junio C Hamano 已提交
201 202 203 204

* link:v1.5.1.6/git.html[documentation for release 1.5.1.6]

* release notes for
205 206 207 208 209 210 211
  link:RelNotes/1.5.1.6.txt[1.5.1.6],
  link:RelNotes/1.5.1.5.txt[1.5.1.5],
  link:RelNotes/1.5.1.4.txt[1.5.1.4],
  link:RelNotes/1.5.1.3.txt[1.5.1.3],
  link:RelNotes/1.5.1.2.txt[1.5.1.2],
  link:RelNotes/1.5.1.1.txt[1.5.1.1],
  link:RelNotes/1.5.1.txt[1.5.1].
212 213 214

* link:v1.5.0.7/git.html[documentation for release 1.5.0.7]

J
Junio C Hamano 已提交
215
* release notes for
216 217 218 219 220 221 222
  link:RelNotes/1.5.0.7.txt[1.5.0.7],
  link:RelNotes/1.5.0.6.txt[1.5.0.6],
  link:RelNotes/1.5.0.5.txt[1.5.0.5],
  link:RelNotes/1.5.0.3.txt[1.5.0.3],
  link:RelNotes/1.5.0.2.txt[1.5.0.2],
  link:RelNotes/1.5.0.1.txt[1.5.0.1],
  link:RelNotes/1.5.0.txt[1.5.0].
223 224 225 226 227

* documentation for release link:v1.4.4.4/git.html[1.4.4.4],
  link:v1.3.3/git.html[1.3.3],
  link:v1.2.6/git.html[1.2.6],
  link:v1.0.13/git.html[1.0.13].
228 229 230 231 232

============

endif::stalenotes[]

233 234 235
OPTIONS
-------
--version::
F
Fredrik Kuivinen 已提交
236
	Prints the git suite version that the 'git' program came from.
237 238

--help::
F
Fredrik Kuivinen 已提交
239
	Prints the synopsis and a list of the most commonly used
240 241 242
	commands. If the option '--all' or '-a' is given then all
	available commands are printed. If a git command is named this
	option will bring up the manual page for that command.
243 244
+
Other options are available to control how the manual page is
245
displayed. See linkgit:git-help[1] for more information,
246 247
because `git --help ...` is converted internally into `git
help ...`.
248

249 250 251 252 253 254
-c <name>=<value>::
	Pass a configuration parameter to the command. The value
	given will override values from configuration files.
	The <name> is expected in the same format as listed by
	'git config' (subkeys separated by dots).

255
--exec-path::
F
Fredrik Kuivinen 已提交
256
	Path to wherever your core git programs are installed.
257
	This can also be controlled by setting the GIT_EXEC_PATH
J
Jonathan Nieder 已提交
258
	environment variable. If no path is given, 'git' will print
259 260
	the current setting and then exit.

261 262 263 264
--html-path::
	Print the path to wherever your git HTML documentation is installed
	and exit.

265 266
-p::
--paginate::
267 268 269 270
	Pipe all output into 'less' (or if set, $PAGER) if standard
	output is a terminal.  This overrides the `pager.<cmd>`
	configuration options (see the "Configuration Mechanism" section
	below).
271

272 273 274
--no-pager::
	Do not pipe git output into a pager.

275 276
--git-dir=<path>::
	Set the path to the repository. This can also be controlled by
277 278
	setting the GIT_DIR environment variable. It can be an absolute
	path or relative path to current working directory.
279

280 281 282 283 284 285
--work-tree=<path>::
	Set the path to the working tree.  The value will not be
	used in combination with repositories found automatically in
	a .git directory (i.e. $GIT_DIR is not set).
	This can also be controlled by setting the GIT_WORK_TREE
	environment variable and the core.worktree configuration
286 287 288 289 290 291
	variable. It can be an absolute path or relative path to
	the directory specified by --git-dir or GIT_DIR.
	Note: If --git-dir or GIT_DIR are specified but none of
	--work-tree, GIT_WORK_TREE and core.worktree is specified,
	the current working directory is regarded as the top directory
	of your working tree.
292

293
--bare::
294 295 296 297
	Treat the repository as a bare repository.  If GIT_DIR
	environment is not set, it is set to the current working
	directory.

298 299 300 301
--no-replace-objects::
	Do not use replacement refs to replace git objects. See
	linkgit:git-replace[1] for more information.

302

303 304
FURTHER DOCUMENTATION
---------------------
305

306 307
See the references above to get started using git.  The following is
probably more detail than necessary for a first-time user.
J
Junio C Hamano 已提交
308

309
The link:user-manual.html#git-concepts[git concepts chapter of the
310
user-manual] and linkgit:gitcore-tutorial[7] both provide
311
introductions to the underlying git architecture.
312

313 314
See linkgit:gitworkflows[7] for an overview of recommended workflows.

315 316
See also the link:howto-index.html[howto] documents for some useful
examples.
317

318 319
The internals are documented in the
link:technical/api-index.html[GIT API documentation].
320

321 322
GIT COMMANDS
------------
323

324 325
We divide git into high level ("porcelain") commands and low level
("plumbing") commands.
326

327 328 329 330 331 332 333 334
High-level commands (porcelain)
-------------------------------

We separate the porcelain commands into the main commands and some
ancillary user utilities.

Main porcelain commands
~~~~~~~~~~~~~~~~~~~~~~~
335

336
include::cmds-mainporcelain.txt[]
337

338
Ancillary Commands
339
~~~~~~~~~~~~~~~~~~
340 341
Manipulators:

342
include::cmds-ancillarymanipulators.txt[]
343

344
Interrogators:
345

346
include::cmds-ancillaryinterrogators.txt[]
347

348 349 350 351 352 353 354 355 356 357

Interacting with Others
~~~~~~~~~~~~~~~~~~~~~~~

These commands are to interact with foreign SCM and with other
people via patch over e-mail.

include::cmds-foreignscminterface.txt[]


358 359 360 361 362 363
Low-level commands (plumbing)
-----------------------------

Although git includes its
own porcelain layer, its low-level commands are sufficient to support
development of alternative porcelains.  Developers of such porcelains
364 365
might start by reading about linkgit:git-update-index[1] and
linkgit:git-read-tree[1].
366

367 368 369 370 371 372 373 374 375
The interface (input, output, set of options and the semantics)
to these low-level commands are meant to be a lot more stable
than Porcelain level commands, because these commands are
primarily for scripted use.  The interface to Porcelain commands
on the other hand are subject to change in order to improve the
end user experience.

The following description divides
the low-level commands into commands that manipulate objects (in
376 377 378 379
the repository, index, and working tree), commands that interrogate and
compare objects, and commands that move objects and references between
repositories.

380

381 382 383
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~

384
include::cmds-plumbingmanipulators.txt[]
385 386 387 388 389


Interrogation commands
~~~~~~~~~~~~~~~~~~~~~~

390
include::cmds-plumbinginterrogators.txt[]
391 392 393 394 395 396 397 398

In general, the interrogate commands do not touch the files in
the working tree.


Synching repositories
~~~~~~~~~~~~~~~~~~~~~

399
include::cmds-synchingrepositories.txt[]
400

401
The following are helper commands used by the above; end users
402 403 404 405 406 407 408 409 410 411 412 413 414
typically do not use them directly.

include::cmds-synchelpers.txt[]


Internal helper commands
~~~~~~~~~~~~~~~~~~~~~~~~

These are internal helper commands used by other commands; end
users typically do not use them directly.

include::cmds-purehelpers.txt[]

415

J
Junio C Hamano 已提交
416 417 418
Configuration Mechanism
-----------------------

J
Junio C Hamano 已提交
419
Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
J
Junio C Hamano 已提交
420
is used to hold per-repository configuration options.  It is a
P
Pavel Roskin 已提交
421
simple text file modeled after `.ini` format familiar to some
J
Junio C Hamano 已提交
422 423 424 425
people.  Here is an example:

------------
#
J
Junio C Hamano 已提交
426
# A '#' or ';' character indicates a comment.
J
Junio C Hamano 已提交
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
#

; core variables
[core]
	; Don't trust file modes
	filemode = false

; user identity
[user]
	name = "Junio C Hamano"
	email = "junkio@twinsun.com"

------------

Various commands read from the configuration file and adjust
442 443
their operation accordingly.  See linkgit:git-config[1] for a
list.
J
Junio C Hamano 已提交
444 445


446
Identifier Terminology
447 448
----------------------
<object>::
J
Junio C Hamano 已提交
449
	Indicates the object name for any type of object.
450 451

<blob>::
J
Junio C Hamano 已提交
452
	Indicates a blob object name.
453 454

<tree>::
J
Junio C Hamano 已提交
455
	Indicates a tree object name.
456 457

<commit>::
J
Junio C Hamano 已提交
458
	Indicates a commit object name.
459 460

<tree-ish>::
J
Junio C Hamano 已提交
461
	Indicates a tree, commit or tag object name.  A
462 463 464
	command that takes a <tree-ish> argument ultimately wants to
	operate on a <tree> object but automatically dereferences
	<commit> and <tag> objects that point at a <tree>.
465

466 467 468 469 470 471
<commit-ish>::
	Indicates a commit or tag object name.  A
	command that takes a <commit-ish> argument ultimately wants to
	operate on a <commit> object but automatically dereferences
	<tag> objects that point at a <commit>.

472 473
<type>::
	Indicates that an object type is required.
J
Junio C Hamano 已提交
474
	Currently one of: `blob`, `tree`, `commit`, or `tag`.
475 476

<file>::
J
Junio C Hamano 已提交
477 478
	Indicates a filename - almost always relative to the
	root of the tree structure `GIT_INDEX_FILE` describes.
479

480 481
Symbolic Identifiers
--------------------
482
Any git command accepting any <object> can also use the following
483
symbolic notation:
484 485

HEAD::
J
Junio C Hamano 已提交
486 487 488
	indicates the head of the current branch (i.e. the
	contents of `$GIT_DIR/HEAD`).

489
<tag>::
J
Junio C Hamano 已提交
490 491 492
	a valid tag 'name'
	(i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).

493
<head>::
J
Junio C Hamano 已提交
494 495 496
	a valid head 'name'
	(i.e. the contents of `$GIT_DIR/refs/heads/<head>`).

497
For a more complete list of ways to spell object names, see
498
"SPECIFYING REVISIONS" section in linkgit:gitrevisions[1].
499

500 501 502 503

File/Directory Structure
------------------------

504
Please see the linkgit:gitrepository-layout[5] document.
505

506
Read linkgit:githooks[5] for more details about each hook.
507

508
Higher level SCMs may provide and manage additional information in the
J
Junio C Hamano 已提交
509
`$GIT_DIR`.
510

J
Junio C Hamano 已提交
511

512 513
Terminology
-----------
514
Please see linkgit:gitglossary[7].
515 516 517 518 519 520


Environment Variables
---------------------
Various git commands use the following environment variables:

521 522 523 524
The git Repository
~~~~~~~~~~~~~~~~~~
These environment variables apply to 'all' core git commands. Nb: it
is worth noting that they may be used/overridden by SCMS sitting above
J
Junio C Hamano 已提交
525
git so take care if using Cogito etc.
526 527 528

'GIT_INDEX_FILE'::
	This environment allows the specification of an alternate
529 530
	index file. If not specified, the default of `$GIT_DIR/index`
	is used.
531 532 533 534 535 536 537 538 539 540

'GIT_OBJECT_DIRECTORY'::
	If the object storage directory is specified via this
	environment variable then the sha1 directories are created
	underneath - otherwise the default `$GIT_DIR/objects`
	directory is used.

'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
	Due to the immutable nature of git objects, old objects can be
	archived into shared, read-only directories. This variable
541 542 543
	specifies a ":" separated (on Windows ";" separated) list
	of git object directories which can be used to search for git
	objects. New objects will not be written to these directories.
544 545

'GIT_DIR'::
J
Junio C Hamano 已提交
546 547 548
	If the 'GIT_DIR' environment variable is set then it
	specifies a path to use instead of the default `.git`
	for the base of the repository.
549

550 551 552 553 554 555 556
'GIT_WORK_TREE'::
	Set the path to the working tree.  The value will not be
	used in combination with repositories found automatically in
	a .git directory (i.e. $GIT_DIR is not set).
	This can also be controlled by the '--work-tree' command line
	option and the core.worktree configuration variable.

557 558 559 560 561 562 563 564
'GIT_CEILING_DIRECTORIES'::
	This should be a colon-separated list of absolute paths.
	If set, it is a list of directories that git should not chdir
	up into while looking for a repository directory.
	It will not exclude the current working directory or
	a GIT_DIR set on the command line or in the environment.
	(Useful for excluding slow-loading network directories.)

565
'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
566 567 568 569
	When run in a directory that does not have ".git" repository
	directory, git tries to find such a directory in the parent
	directories to find the top of the working tree, but by default it
	does not cross filesystem boundaries.  This environment variable
570 571 572 573
	can be set to true to tell git not to stop at filesystem
	boundaries.  Like 'GIT_CEILING_DIRECTORIES', this will not affect
	an explicit repository directory set via 'GIT_DIR' or on the
	command line.
574

575 576 577 578 579 580 581
git Commits
~~~~~~~~~~~
'GIT_AUTHOR_NAME'::
'GIT_AUTHOR_EMAIL'::
'GIT_AUTHOR_DATE'::
'GIT_COMMITTER_NAME'::
'GIT_COMMITTER_EMAIL'::
582
'GIT_COMMITTER_DATE'::
583
'EMAIL'::
584
	see linkgit:git-commit-tree[1]
585 586 587

git Diffs
~~~~~~~~~
588
'GIT_DIFF_OPTS'::
589 590 591 592 593
	Only valid setting is "--unified=??" or "-u??" to set the
	number of context lines shown when a unified diff is created.
	This takes precedence over any "-U" or "--unified" option
	value passed on the git diff command line.

594
'GIT_EXTERNAL_DIFF'::
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
	When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
	program named by it is called, instead of the diff invocation
	described above.  For a path that is added, removed, or modified,
        'GIT_EXTERNAL_DIFF' is called with 7 parameters:

	path old-file old-hex old-mode new-file new-hex new-mode
+
where:

	<old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
                         contents of <old|new>,
	<old|new>-hex:: are the 40-hexdigit SHA1 hashes,
	<old|new>-mode:: are the octal representation of the file modes.

+
The file parameters can point at the user's working file
(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
when a new file is added), or a temporary file (e.g. `old-file` in the
index).  'GIT_EXTERNAL_DIFF' should not worry about unlinking the
temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
+
For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
parameter, <path>.
618

619 620
other
~~~~~
J
Jakub Narebski 已提交
621 622 623
'GIT_MERGE_VERBOSITY'::
	A number controlling the amount of output shown by
	the recursive merge strategy.  Overrides merge.verbosity.
624
	See linkgit:git-merge[1]
J
Jakub Narebski 已提交
625

626
'GIT_PAGER'::
627 628
	This environment variable overrides `$PAGER`. If it is set
	to an empty string or to the value "cat", git will not launch
629 630
	a pager.  See also the `core.pager` option in
	linkgit:git-config[1].
631

632
'GIT_SSH'::
633 634
	If this environment variable is set then 'git fetch'
	and 'git push' will use this command instead
635
	of 'ssh' when they need to connect to a remote system.
636
	The '$GIT_SSH' command will be given exactly two arguments:
637 638 639 640 641 642 643 644 645 646 647
	the 'username@host' (or just 'host') from the URL and the
	shell command to execute on that remote system.
+
To pass options to the program that you want to list in GIT_SSH
you will need to wrap the program and options into a shell script,
then set GIT_SSH to refer to the shell script.
+
Usually it is easier to configure any desired options through your
personal `.ssh/config` file.  Please consult your ssh documentation
for further details.

648 649 650 651 652 653 654
'GIT_ASKPASS'::
	If this environment variable is set, then git commands which need to
	acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
	will call this program with a suitable prompt as command line argument
	and read the password from its STDOUT. See also the 'core.askpass'
	option in linkgit:git-config[1].

655 656
'GIT_FLUSH'::
	If this environment variable is set to "1", then commands such
657 658
	as 'git blame' (in incremental mode), 'git rev-list', 'git log',
	and 'git whatchanged' will force a flush of the output stream
659 660 661 662 663 664
	after each commit-oriented record have been flushed.   If this
	variable is set to "0", the output of these commands will be done
	using completely buffered I/O.   If this environment variable is
	not set, git will choose buffered or record-oriented flushing
	based on whether stdout appears to be redirected to a file or not.

665
'GIT_TRACE'::
666 667
	If this variable is set to "1", "2" or "true" (comparison
	is case insensitive), git will print `trace:` messages on
668 669
	stderr telling about alias expansion, built-in command
	execution and external command execution.
670 671 672 673 674 675 676 677
	If this variable is set to an integer value greater than 1
	and lower than 10 (strictly) then git will interpret this
	value as an open file descriptor and will try to write the
	trace messages into this file descriptor.
	Alternatively, if this variable is set to an absolute path
	(starting with a '/' character), git will interpret this
	as a file path and will try to write the trace messages
	into it.
678

J
Junio C Hamano 已提交
679 680
Discussion[[Discussion]]
------------------------
681 682 683

More detail on the following is available from the
link:user-manual.html#git-concepts[git concepts chapter of the
684
user-manual] and linkgit:gitcore-tutorial[7].
685 686 687 688 689 690 691 692 693 694

A git project normally consists of a working directory with a ".git"
subdirectory at the top level.  The .git directory contains, among other
things, a compressed object database representing the complete history
of the project, an "index" file which links that history to the current
contents of the working tree, and named pointers into that history such
as tags and branch heads.

The object database contains objects of three main types: blobs, which
hold file data; trees, which point to blobs and other trees to build up
R
Ralf Wildenhues 已提交
695
directory hierarchies; and commits, which each reference a single tree
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
and some number of parent commits.

The commit, equivalent to what other systems call a "changeset" or
"version", represents a step in the project's history, and each parent
represents an immediately preceding step.  Commits with more than one
parent represent merges of independent lines of development.

All objects are named by the SHA1 hash of their contents, normally
written as a string of 40 hex digits.  Such names are globally unique.
The entire history leading up to a commit can be vouched for by signing
just that commit.  A fourth object type, the tag, is provided for this
purpose.

When first created, objects are stored in individual files, but for
efficiency may later be compressed together into "pack files".

Named pointers called refs mark interesting points in history.  A ref
may contain the SHA1 name of an object or the name of another ref.  Refs
with names beginning `ref/head/` contain the SHA1 name of the most
R
Ralf Wildenhues 已提交
715
recent commit (or "head") of a branch under development.  SHA1 names of
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
tags of interest are stored under `ref/tags/`.  A special ref named
`HEAD` contains the name of the currently checked-out branch.

The index file is initialized with a list of all paths and, for each
path, a blob object and a set of attributes.  The blob object represents
the contents of the file as of the head of the current branch.  The
attributes (last modified time, size, etc.) are taken from the
corresponding file in the working tree.  Subsequent changes to the
working tree can be found by comparing these attributes.  The index may
be updated with new content, and new commits may be created from the
content stored in the index.

The index is also capable of storing multiple entries (called "stages")
for a given pathname.  These stages are used to hold the various
unmerged version of a file when a merge is in progress.
731

732 733
Authors
-------
734
* git's founding father is Linus Torvalds <torvalds@osdl.org>.
735
* The current git nurse is Junio C Hamano <gitster@pobox.com>.
J
Junio C Hamano 已提交
736
* The git potty was written by Andreas Ericsson <ae@op5.se>.
737
* General upbringing is handled by the git-list <git@vger.kernel.org>.
738 739 740

Documentation
--------------
741 742 743
The documentation for git suite was started by David Greaves
<david@dgreaves.com>, and later enhanced greatly by the
contributors on the git-list <git@vger.kernel.org>.
744

J
Junio C Hamano 已提交
745 746 747 748 749 750 751
Reporting Bugs
--------------

Report bugs to the Git mailing list <git@vger.kernel.org> where the
development and maintenance is primarily done.  You do not have to be
subscribed to the list to send a message there.

752 753 754
SEE ALSO
--------
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
755
link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
756
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
757 758
linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
linkgit:gitworkflows[7]
759

760 761
GIT
---
762
Part of the linkgit:git[1] suite