summaryrefslogtreecommitdiff
path: root/Documentation/git.txt
blob: 66b68b89d58a6110489d354c04dd900d9be5fc1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
git(1)
======
v0.1, May 2005
 
NAME
----
git - the stupid content tracker
 
 
SYNOPSIS
--------
'git-<command>' <args>
 
DESCRIPTION
-----------
 
This is reference information for the core git commands.
 
The link:README[] contains much useful definition and clarification
info - read that first.  And of the commands, I suggest reading
'git-update-cache' and 'git-read-tree' first - I wish I had!
 
David Greaves <david@dgreaves.com>
08/05/05
 
Updated by Junio C Hamano <junkio@cox.net> on 2005-05-05 to
reflect recent changes.
 
Commands Overview
-----------------
The git commands can helpfully be split into those that manipulate
the repository, the cache and the working fileset and those that
interrogate and compare them.
 
There are also some ancilliary programs that can be viewed as useful
aids for using the core commands but which are unlikely to be used by
SCMs layered over git.
 
Manipulation commands
~~~~~~~~~~~~~~~~~~~~~
link:git-checkout-cache.html[git-checkout-cache]::
	Copy files from the cache to the working directory
 
link:git-commit-tree.html[git-commit-tree]::
	Creates a new commit object
 
link:git-init-db.html[git-init-db]::
	Creates an empty git object database
 
link:git-merge-base.html[git-merge-base]::
	Finds as good a common ancestor as possible for a merge
 
link:git-mktag.html[git-mktag]::
	Creates a tag object
 
link:git-read-tree.html[git-read-tree]::
	Reads tree information into the directory cache
 
link:git-update-cache.html[git-update-cache]::
	Modifies the index or directory cache
 
link:git-write-blob.html[git-write-blob]::
	Creates a blob from a file
 
link:git-write-tree.html[git-write-tree]::
	Creates a tree from the current cache
 
Interrogation commands
~~~~~~~~~~~~~~~~~~~~~~
link:git-cat-file.html[git-cat-file]::
	Provide content or type information for repository objects
 
link:git-check-files.html[git-check-files]::
	Verify a list of files are up-to-date
 
link:git-diff-cache.html[git-diff-cache]::
	Compares content and mode of blobs between the cache and repository
 
link:git-diff-files.html[git-diff-files]::
	Compares files in the working tree and the cache
 
link:git-diff-tree.html[git-diff-tree]::
	Compares the content and mode of blobs found via two tree objects
 
link:git-export.html[git-export]::
	Exports each commit and a diff against each of its parents
 
link:git-fsck-cache.html[git-fsck-cache]::
	Verifies the connectivity and validity of the objects in the database
 
link:git-ls-files.html[git-ls-files]::
	Information about files in the cache/working directory
 
link:git-ls-tree.html[git-ls-tree]::
	Displays a tree object in human readable form
 
link:git-merge-cache.html[git-merge-cache]::
	Runs a merge for files needing merging
 
link:git-rev-list.html[git-rev-list]::
	Lists commit objects in reverse chronological order
 
link:git-rev-tree.html[git-rev-tree]::
	Provides the revision tree for one or more commits
 
link:git-tar-tree.html[git-tar-tree]::
	Creates a tar archive of the files in the named tree
 
link:git-unpack-file.html[git-unpack-file]::
	Creates a temporary file with a blob's contents
 
The interrogate commands may create files - and you can force them to
touch the working file set - but in general they don't
 
 
Ancilliary Commands
-------------------
Manipulators:
 
link:git-apply-patch-script.html[git-apply-patch-script]::
	Sample script to apply the diffs from git-diff-*
 
link:git-convert-cache.html[git-convert-cache]::
	Converts old-style GIT repository
 
link:git-http-pull.html[git-http-pull]::
	Downloads a remote GIT repository via HTTP
 
link:git-local-pull.html[git-local-pull]::
	Duplicates another GIT repository on a local system
 
link:git-merge-one-file-script.html[git-merge-one-file-script]::
	The standard helper program to use with "git-merge-cache"
 
link:git-pull-script.html[git-pull-script]::
	Script used by Linus to pull and merge a remote repository
 
link:git-prune-script.html[git-prune-script]::
	Prunes all unreachable objects from the object database
 
link:git-resolve-script.html[git-resolve-script]::
	Script used to merge two trees
 
link:git-tag-script.html[git-tag-script]::
	An example script to create a tag object signed with GPG
 
link:git-rpull.html[git-rpull]::
	Pulls from a remote repository over ssh connection
 
Interogators:
 
link:git-diff-tree-helper.html[git-diff-tree-helper]::
	Generates patch format output for git-diff-*
 
link:git-rpush.html[git-rpush]::
	Helper "server-side" program used by git-rpull
 
 
 
Terminology
-----------
see README for description
 
Identifier terminology
----------------------
<object>::
	Indicates any object sha1 identifier
 
<blob>::
	Indicates a blob object sha1 identifier
 
<tree>::
	Indicates a tree object sha1 identifier
 
<commit>::
	Indicates a commit object sha1 identifier
 
<tree-ish>::
	Indicates a tree, commit or tag object sha1 identifier.
	A command that takes a <tree-ish> argument ultimately
	wants to operate on a <tree> object but automatically
	dereferences <commit> and <tag> that points at a
	<tree>.
 
<type>::
	Indicates that an object type is required.
	Currently one of: blob/tree/commit/tag
 
<file>::
	Indicates a filename - always relative to the root of
	the tree structure GIT_INDEX_FILE describes.
 
Terminology
-----------
Each line contains terms used interchangeably
 
 object database, .git directory
 directory cache, index
 id, sha1, sha1-id, sha1 hash
 type, tag
 blob, blob object
 tree, tree object
 commit, commit object
 parent
 root object
 changeset
 
 
Environment Variables
---------------------
Various git commands use the following environment variables:
 
- 'GIT_AUTHOR_NAME'
- 'GIT_AUTHOR_EMAIL'
- 'GIT_AUTHOR_DATE'
- 'GIT_COMMITTER_NAME'
- 'GIT_COMMITTER_EMAIL'
- 'GIT_DIFF_OPTS'
- 'GIT_EXTERNAL_DIFF'
- 'GIT_INDEX_FILE'
- 'GIT_OBJECT_DIRECTORY'
- 'GIT_ALTERNATE_OBJECT_DIRECTORIES'
 
 
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
 
Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
 
GIT
---
Part of the link:git.html[git] suite