git.txt 24.3 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[=<path>]] [--html-path]
13
    [-p|--paginate|--no-pager] [--no-replace-objects]
14 15 16
    [--bare] [--git-dir=<path>] [--work-tree=<path>]
    [-c <name>=<value>]
    [--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

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

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

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

55
* link:v1.7.2.4/git.html[documentation for release 1.7.2.4]
J
Junio C Hamano 已提交
56 57

* release notes for
58
  link:RelNotes/1.7.2.4.txt[1.7.2.4],
59 60 61 62
  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 已提交
63

64
* link:v1.7.1.3/git.html[documentation for release 1.7.1.3]
J
Junio C Hamano 已提交
65 66

* release notes for
67
  link:RelNotes/1.7.1.3.txt[1.7.1.3],
68 69 70
  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 已提交
71

72
* link:v1.7.0.8/git.html[documentation for release 1.7.0.8]
J
Junio C Hamano 已提交
73 74

* release notes for
75
  link:RelNotes/1.7.0.8.txt[1.7.0.8],
76 77 78 79 80 81 82 83
  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 已提交
84

J
Junio C Hamano 已提交
85
* link:v1.6.6.2/git.html[documentation for release 1.6.6.2]
J
Junio C Hamano 已提交
86 87

* release notes for
88 89 90
  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 已提交
91

J
Junio C Hamano 已提交
92
* link:v1.6.5.8/git.html[documentation for release 1.6.5.8]
J
Junio C Hamano 已提交
93 94

* release notes for
95 96 97 98 99 100 101 102 103
  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 已提交
104

J
Junio C Hamano 已提交
105
* link:v1.6.4.4/git.html[documentation for release 1.6.4.4]
J
Junio C Hamano 已提交
106 107

* release notes for
108 109 110 111 112
  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 已提交
113

J
Junio C Hamano 已提交
114
* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
115 116

* release notes for
117 118 119 120 121
  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 已提交
122 123

* release notes for
124 125 126 127 128 129
  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 已提交
130

J
Junio C Hamano 已提交
131
* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
J
Junio C Hamano 已提交
132 133

* release notes for
134 135 136 137
  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 已提交
138

139
* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
J
Junio C Hamano 已提交
140 141

* release notes for
142 143 144 145 146 147 148
  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 已提交
149

150
* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
J
Junio C Hamano 已提交
151 152

* release notes for
153 154 155 156 157 158 159
  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 已提交
160

161
* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
J
Junio C Hamano 已提交
162 163

* release notes for
164 165 166 167 168 169 170
  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 已提交
171

172
* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
173 174

* release notes for
175 176 177 178 179 180 181 182
  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].
183

J
Junio C Hamano 已提交
184
* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
185 186

* release notes for
187 188 189 190 191 192 193 194 195
  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].
196

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

J
Junio C Hamano 已提交
199
* release notes for
200 201 202 203 204 205
  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 已提交
206 207 208 209

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

* release notes for
210 211 212 213 214 215 216
  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].
217 218 219

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

J
Junio C Hamano 已提交
220
* release notes for
221 222 223 224 225 226 227
  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].
228 229 230 231 232

* 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].
233 234 235 236 237

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

endif::stalenotes[]

238 239 240
OPTIONS
-------
--version::
F
Fredrik Kuivinen 已提交
241
	Prints the git suite version that the 'git' program came from.
242 243

--help::
F
Fredrik Kuivinen 已提交
244
	Prints the synopsis and a list of the most commonly used
245 246 247
	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.
248 249
+
Other options are available to control how the manual page is
250
displayed. See linkgit:git-help[1] for more information,
251 252
because `git --help ...` is converted internally into `git
help ...`.
253

254 255 256 257 258 259
-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).

260
--exec-path[=<path>]::
F
Fredrik Kuivinen 已提交
261
	Path to wherever your core git programs are installed.
262
	This can also be controlled by setting the GIT_EXEC_PATH
J
Jonathan Nieder 已提交
263
	environment variable. If no path is given, 'git' will print
264 265
	the current setting and then exit.

266 267 268 269
--html-path::
	Print the path to wherever your git HTML documentation is installed
	and exit.

270 271
-p::
--paginate::
272 273 274 275
	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).
276

277 278 279
--no-pager::
	Do not pipe git output into a pager.

280 281
--git-dir=<path>::
	Set the path to the repository. This can also be controlled by
282 283
	setting the GIT_DIR environment variable. It can be an absolute
	path or relative path to current working directory.
284

285 286 287 288 289 290
--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
291 292 293 294 295 296
	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.
297

298
--bare::
299 300 301 302
	Treat the repository as a bare repository.  If GIT_DIR
	environment is not set, it is set to the current working
	directory.

303 304 305 306
--no-replace-objects::
	Do not use replacement refs to replace git objects. See
	linkgit:git-replace[1] for more information.

307

308 309
FURTHER DOCUMENTATION
---------------------
310

311 312
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 已提交
313

314
The link:user-manual.html#git-concepts[git concepts chapter of the
315
user-manual] and linkgit:gitcore-tutorial[7] both provide
316
introductions to the underlying git architecture.
317

318 319
See linkgit:gitworkflows[7] for an overview of recommended workflows.

320 321
See also the link:howto-index.html[howto] documents for some useful
examples.
322

323 324
The internals are documented in the
link:technical/api-index.html[GIT API documentation].
325

326 327
GIT COMMANDS
------------
328

329 330
We divide git into high level ("porcelain") commands and low level
("plumbing") commands.
331

332 333 334 335 336 337 338 339
High-level commands (porcelain)
-------------------------------

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

Main porcelain commands
~~~~~~~~~~~~~~~~~~~~~~~
340

341
include::cmds-mainporcelain.txt[]
342

343
Ancillary Commands
344
~~~~~~~~~~~~~~~~~~
345 346
Manipulators:

347
include::cmds-ancillarymanipulators.txt[]
348

349
Interrogators:
350

351
include::cmds-ancillaryinterrogators.txt[]
352

353 354 355 356 357 358 359 360 361 362

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

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

include::cmds-foreignscminterface.txt[]


363 364 365 366 367 368
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
369 370
might start by reading about linkgit:git-update-index[1] and
linkgit:git-read-tree[1].
371

372 373 374 375 376 377 378 379 380
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
381 382 383 384
the repository, index, and working tree), commands that interrogate and
compare objects, and commands that move objects and references between
repositories.

385

386 387 388
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~

389
include::cmds-plumbingmanipulators.txt[]
390 391 392 393 394


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

395
include::cmds-plumbinginterrogators.txt[]
396 397 398 399 400 401 402 403

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


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

404
include::cmds-synchingrepositories.txt[]
405

406
The following are helper commands used by the above; end users
407 408 409 410 411 412 413 414 415 416 417 418 419
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[]

420

J
Junio C Hamano 已提交
421 422 423
Configuration Mechanism
-----------------------

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

------------
#
J
Junio C Hamano 已提交
431
# A '#' or ';' character indicates a comment.
J
Junio C Hamano 已提交
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
#

; 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
447 448
their operation accordingly.  See linkgit:git-config[1] for a
list.
J
Junio C Hamano 已提交
449 450


451
Identifier Terminology
452 453
----------------------
<object>::
J
Junio C Hamano 已提交
454
	Indicates the object name for any type of object.
455 456

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

<tree>::
J
Junio C Hamano 已提交
460
	Indicates a tree object name.
461 462

<commit>::
J
Junio C Hamano 已提交
463
	Indicates a commit object name.
464 465

<tree-ish>::
J
Junio C Hamano 已提交
466
	Indicates a tree, commit or tag object name.  A
467 468 469
	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>.
470

471 472 473 474 475 476
<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>.

477 478
<type>::
	Indicates that an object type is required.
J
Junio C Hamano 已提交
479
	Currently one of: `blob`, `tree`, `commit`, or `tag`.
480 481

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

485 486
Symbolic Identifiers
--------------------
487
Any git command accepting any <object> can also use the following
488
symbolic notation:
489 490

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

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

498
<head>::
J
Junio C Hamano 已提交
499 500 501
	a valid head 'name'
	(i.e. the contents of `$GIT_DIR/refs/heads/<head>`).

502
For a more complete list of ways to spell object names, see
503
"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
504

505 506 507 508

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

509
Please see the linkgit:gitrepository-layout[5] document.
510

511
Read linkgit:githooks[5] for more details about each hook.
512

513
Higher level SCMs may provide and manage additional information in the
J
Junio C Hamano 已提交
514
`$GIT_DIR`.
515

J
Junio C Hamano 已提交
516

517 518
Terminology
-----------
519
Please see linkgit:gitglossary[7].
520 521 522 523 524 525


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

526 527 528 529
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 已提交
530
git so take care if using Cogito etc.
531 532 533

'GIT_INDEX_FILE'::
	This environment allows the specification of an alternate
534 535
	index file. If not specified, the default of `$GIT_DIR/index`
	is used.
536 537 538 539 540 541 542 543 544 545

'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
546 547 548
	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.
549 550

'GIT_DIR'::
J
Junio C Hamano 已提交
551 552 553
	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.
554

555 556 557 558 559 560 561
'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.

562 563 564 565 566 567 568 569
'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.)

570
'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
571 572 573 574
	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
575 576 577 578
	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.
579

580 581 582 583 584 585 586
git Commits
~~~~~~~~~~~
'GIT_AUTHOR_NAME'::
'GIT_AUTHOR_EMAIL'::
'GIT_AUTHOR_DATE'::
'GIT_COMMITTER_NAME'::
'GIT_COMMITTER_EMAIL'::
587
'GIT_COMMITTER_DATE'::
588
'EMAIL'::
589
	see linkgit:git-commit-tree[1]
590 591 592

git Diffs
~~~~~~~~~
593
'GIT_DIFF_OPTS'::
594 595 596 597 598
	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.

599
'GIT_EXTERNAL_DIFF'::
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
	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>.
623

624 625
other
~~~~~
J
Jakub Narebski 已提交
626 627 628
'GIT_MERGE_VERBOSITY'::
	A number controlling the amount of output shown by
	the recursive merge strategy.  Overrides merge.verbosity.
629
	See linkgit:git-merge[1]
J
Jakub Narebski 已提交
630

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

637
'GIT_SSH'::
638 639
	If this environment variable is set then 'git fetch'
	and 'git push' will use this command instead
640
	of 'ssh' when they need to connect to a remote system.
641
	The '$GIT_SSH' command will be given exactly two arguments:
642 643 644 645 646 647 648 649 650 651 652
	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.

653 654 655 656 657 658 659
'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].

660 661
'GIT_FLUSH'::
	If this environment variable is set to "1", then commands such
662 663
	as 'git blame' (in incremental mode), 'git rev-list', 'git log',
	and 'git whatchanged' will force a flush of the output stream
664 665 666 667 668 669
	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.

670
'GIT_TRACE'::
671 672
	If this variable is set to "1", "2" or "true" (comparison
	is case insensitive), git will print `trace:` messages on
673 674
	stderr telling about alias expansion, built-in command
	execution and external command execution.
675 676 677 678 679 680 681 682
	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.
683

J
Junio C Hamano 已提交
684 685
Discussion[[Discussion]]
------------------------
686 687 688

More detail on the following is available from the
link:user-manual.html#git-concepts[git concepts chapter of the
689
user-manual] and linkgit:gitcore-tutorial[7].
690 691 692 693 694 695 696 697 698 699

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 已提交
700
directory hierarchies; and commits, which each reference a single tree
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
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 已提交
720
recent commit (or "head") of a branch under development.  SHA1 names of
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
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.
736

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

Documentation
--------------
746 747 748
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>.
749

J
Junio C Hamano 已提交
750 751 752 753 754 755 756
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.

757 758 759
SEE ALSO
--------
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
760
link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
761
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
762 763
linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
linkgit:gitworkflows[7]
764

765 766
GIT
---
767
Part of the linkgit:git[1] suite