blob: d20eb6270cd795ab61b281154a7e24070519b7fb [file] [log] [blame]
Junio C Hamano88a3a072006-05-04 08:01:431alternate object database::
2Via the alternates mechanism, a repository can inherit part of its
3object database from another object database, which is called
4"alternate".
Junio C Hamano1a4e8412005-12-27 08:17:235
Junio C Hamano88a3a072006-05-04 08:01:436bare repository::
7A bare repository is normally an appropriately named
8directory with a `.git` suffix that does not have a
9locally checked-out copy of any of the files under revision
10control. That is, all of the `git` administrative and
11control files that would normally be present in the
12hidden `.git` sub-directory are directly present in
13the `repository.git` directory instead, and no other files
14are present and checked out. Usually publishers of public
15repositories make bare repositories available.
Junio C Hamano1a4e8412005-12-27 08:17:2316
17blob object::
18Untyped object, e.g. the contents of a file.
19
Junio C Hamano88a3a072006-05-04 08:01:4320branch::
21A non-cyclical graph of revisions, i.e. the complete history of
22a particular revision, which is called the branch head. The
23branch heads are stored in `$GIT_DIR/refs/heads/`.
Junio C Hamano1a4e8412005-12-27 08:17:2324
Junio C Hamano88a3a072006-05-04 08:01:4325cache::
26Obsolete for: index.
27
28chain::
29A list of objects, where each object in the list contains a
30reference to its successor (for example, the successor of a commit
31could be one of its parents).
32
33changeset::
34BitKeeper/cvsps speak for "commit". Since git does not store
35changes, but states, it really does not make sense to use
36the term "changesets" with git.
37
38checkout::
39The action of updating the working tree to a revision which was
40stored in the object database.
41
42cherry-picking::
43In SCM jargon, "cherry pick" means to choose a subset of
44changes out of a series of changes (typically commits)
45and record them as a new series of changes on top of
46different codebase. In GIT, this is performed by
47"git cherry-pick" command to extract the change
48introduced by an existing commit and to record it based
49on the tip of the current branch as a new commit.
50
51clean::
52A working tree is clean, if it corresponds to the revision
53referenced by the current head. Also see "dirty".
54
55commit::
56As a verb: The action of storing the current state of the index in the
57object database. The result is a revision.
58As a noun: Short hand for commit object.
59
60commit object::
61An object which contains the information about a particular
62revision, such as parents, committer, author, date and the
63tree object which corresponds to the top directory of the
64stored revision.
65
66core git::
67Fundamental data structures and utilities of git. Exposes only
68limited source code management tools.
Junio C Hamano1a4e8412005-12-27 08:17:2369
70DAG::
71Directed acyclic graph. The commit objects form a directed acyclic
72graph, because they have parents (directed), and the graph of commit
73objects is acyclic (there is no chain which begins and ends with the
74same object).
75
Junio C Hamano88a3a072006-05-04 08:01:4376dircache::
77You are *waaaaay* behind.
78
79dirty::
80A working tree is said to be dirty if it contains modifications
81which have not been committed to the current branch.
82
83directory::
84The list you get with "ls" :-)
85
86ent::
87Favorite synonym to "tree-ish" by some total geeks. See
88`http://en.wikipedia.org/wiki/Ent_(Middle-earth)` for an in-depth
Junio C Hamano51c2ab02006-07-09 20:38:5489explanation. Avoid this term, not to confuse people.
Junio C Hamano88a3a072006-05-04 08:01:4390
91fast forward::
92A fast-forward is a special type of merge where you have
93a revision and you are "merging" another branch's changes
94that happen to be a descendant of what you have.
95In such these cases, you do not make a new merge commit but
96instead just update to his revision. This will happen
97frequently on a tracking branch of a remote repository.
98
99fetch::
100Fetching a branch means to get the branch's head ref from a
101remote repository, to find out which objects are missing from
102the local object database, and to get them, too.
103
104file system::
105Linus Torvalds originally designed git to be a user space file
106system, i.e. the infrastructure to hold files and directories.
107That ensured the efficiency and speed of git.
108
109git archive::
110Synonym for repository (for arch people).
111
Junio C Hamano33db4372006-06-07 19:51:45112grafts::
113Grafts enables two otherwise different lines of development to be
114joined together by recording fake ancestry information for commits.
115This way you can make git pretend the set of parents a commit
116has is different from what was recorded when the commit was created.
117Configured via the `.git/info/grafts` file.
118
Junio C Hamano88a3a072006-05-04 08:01:43119hash::
120In git's context, synonym to object name.
121
122head::
123The top of a branch. It contains a ref to the corresponding
124commit object.
125
126head ref::
127A ref pointing to a head. Often, this is abbreviated to "head".
128Head refs are stored in `$GIT_DIR/refs/heads/`.
129
130hook::
131During the normal execution of several git commands,
132call-outs are made to optional scripts that allow
133a developer to add functionality or checking.
134Typically, the hooks allow for a command to be pre-verified
135and potentially aborted, and allow for a post-notification
136after the operation is done.
137The hook scripts are found in the `$GIT_DIR/hooks/` directory,
138and are enabled by simply making them executable.
139
Junio C Hamano1a4e8412005-12-27 08:17:23140index::
141A collection of files with stat information, whose contents are
142stored as objects. The index is a stored version of your working
143tree. Truth be told, it can also contain a second, and even a third
144version of a working tree, which are used when merging.
145
146index entry::
147The information regarding a particular file, stored in the index.
148An index entry can be unmerged, if a merge was started, but not
149yet finished (i.e. if the index contains multiple versions of
150that file).
151
Junio C Hamano88a3a072006-05-04 08:01:43152master::
153The default development branch. Whenever you create a git
154repository, a branch named "master" is created, and becomes
155the active branch. In most cases, this contains the local
156development, though that is purely conventional and not required.
Junio C Hamano1a4e8412005-12-27 08:17:23157
Junio C Hamano88a3a072006-05-04 08:01:43158merge::
159To merge branches means to try to accumulate the changes since a
160common ancestor and apply them to the first branch. An automatic
161merge uses heuristics to accomplish that. Evidently, an automatic
162merge can fail.
Junio C Hamano1a4e8412005-12-27 08:17:23163
Junio C Hamano88a3a072006-05-04 08:01:43164object::
165The unit of storage in git. It is uniquely identified by
166the SHA1 of its contents. Consequently, an object can not
167be changed.
Junio C Hamano1a4e8412005-12-27 08:17:23168
Junio C Hamano88a3a072006-05-04 08:01:43169object database::
170Stores a set of "objects", and an individual object is identified
171by its object name. The objects usually live in `$GIT_DIR/objects/`.
Junio C Hamano1a4e8412005-12-27 08:17:23172
Junio C Hamano88a3a072006-05-04 08:01:43173object identifier::
174Synonym for object name.
Junio C Hamano1a4e8412005-12-27 08:17:23175
Junio C Hamano88a3a072006-05-04 08:01:43176object name::
177The unique identifier of an object. The hash of the object's contents
178using the Secure Hash Algorithm 1 and usually represented by the 40
179character hexadecimal encoding of the hash of the object (possibly
180followed by a white space).
Junio C Hamano1a4e8412005-12-27 08:17:23181
Junio C Hamano21c0b422006-10-12 19:10:36182object type::
Junio C Hamano88a3a072006-05-04 08:01:43183One of the identifiers "commit","tree","tag" and "blob" describing
184the type of an object.
Junio C Hamano1a4e8412005-12-27 08:17:23185
Junio C Hamano88a3a072006-05-04 08:01:43186octopus::
187To merge more than two branches. Also denotes an intelligent
188predator.
189
190origin::
Junio C Hamanod3361ad2007-01-01 03:20:24191The default upstream repository. Most projects have at
Junio C Hamano88a3a072006-05-04 08:01:43192least one upstream project which they track. By default
193'origin' is used for that purpose. New upstream updates
Junio C Hamanod3361ad2007-01-01 03:20:24194will be fetched into remote tracking branches named
195origin/name-of-upstream-branch, which you can see using
196"git branch -r".
Junio C Hamano88a3a072006-05-04 08:01:43197
198pack::
199A set of objects which have been compressed into one file (to save
200space or to transmit them efficiently).
201
202pack index::
203The list of identifiers, and other information, of the objects in a
204pack, to assist in efficiently accessing the contents of a pack.
Junio C Hamano1a4e8412005-12-27 08:17:23205
206parent::
207A commit object contains a (possibly empty) list of the logical
208predecessor(s) in the line of development, i.e. its parents.
209
Junio C Hamano88a3a072006-05-04 08:01:43210pickaxe::
211The term pickaxe refers to an option to the diffcore routines
212that help select changes that add or delete a given text string.
213With the --pickaxe-all option, it can be used to view the
214full changeset that introduced or removed, say, a particular
215line of text. See gitlink:git-diff[1].
Junio C Hamano1a4e8412005-12-27 08:17:23216
Junio C Hamano88a3a072006-05-04 08:01:43217plumbing::
218Cute name for core git.
Junio C Hamano1a4e8412005-12-27 08:17:23219
Junio C Hamano88a3a072006-05-04 08:01:43220porcelain::
221Cute name for programs and program suites depending on core git,
222presenting a high level access to core git. Porcelains expose
223more of a SCM interface than the plumbing.
Junio C Hamano1a4e8412005-12-27 08:17:23224
Junio C Hamano88a3a072006-05-04 08:01:43225pull::
226Pulling a branch means to fetch it and merge it.
Junio C Hamano1a4e8412005-12-27 08:17:23227
Junio C Hamano88a3a072006-05-04 08:01:43228push::
229Pushing a branch means to get the branch's head ref from a remote
230repository, find out if it is an ancestor to the branch's local
231head ref is a direct, and in that case, putting all objects, which
232are reachable from the local head ref, and which are missing from
233the remote repository, into the remote object database, and updating
234the remote head ref. If the remote head is not an ancestor to the
235local head, the push fails.
Junio C Hamano1a4e8412005-12-27 08:17:23236
Junio C Hamano88a3a072006-05-04 08:01:43237reachable::
Junio C Hamanofc4d38c2007-01-08 06:53:32238All of the ancestors of a given commit are said to be reachable from
239that commit. More generally, one object is reachable from another if
240we can reach the one from the other by a chain that follows tags to
241whatever they tag, commits to their parents or trees, and trees to the
242trees or blobs that they contain.
Junio C Hamanof3e80c02006-01-11 00:54:55243
Junio C Hamano88a3a072006-05-04 08:01:43244rebase::
245To clean a branch by starting from the head of the main line of
246development ("master"), and reapply the (possibly cherry-picked)
247changes from that branch.
Junio C Hamanof3e80c02006-01-11 00:54:55248
Junio C Hamano1a4e8412005-12-27 08:17:23249ref::
Junio C Hamano88a3a072006-05-04 08:01:43250A 40-byte hex representation of a SHA1 or a name that denotes
251a particular object. These may be stored in `$GIT_DIR/refs/`.
Junio C Hamano1a4e8412005-12-27 08:17:23252
Junio C Hamano88a3a072006-05-04 08:01:43253refspec::
254A refspec is used by fetch and push to describe the mapping
255between remote ref and local ref. They are combined with
256a colon in the format <src>:<dst>, preceded by an optional
257plus sign, +. For example:
258`git fetch $URL refs/heads/master:refs/heads/origin`
259means "grab the master branch head from the $URL and store
260it as my origin branch head".
261And `git push $URL refs/heads/master:refs/heads/to-upstream`
Junio C Hamano24351a82007-01-13 08:09:17262means "publish my master branch head as to-upstream branch
Junio C Hamano88a3a072006-05-04 08:01:43263at $URL". See also gitlink:git-push[1]
264
265repository::
266A collection of refs together with an object database containing
267all objects, which are reachable from the refs, possibly accompanied
268by meta data from one or more porcelains. A repository can
269share an object database with other repositories.
270
271resolve::
272The action of fixing up manually what a failed automatic merge
273left behind.
274
275revision::
276A particular state of files and directories which was stored in
277the object database. It is referenced by a commit object.
278
279rewind::
280To throw away part of the development, i.e. to assign the head to
281an earlier revision.
282
283SCM::
284Source code management (tool).
285
286SHA1::
287Synonym for object name.
288
Junio C Hamano4f9a6052007-01-17 20:25:16289shallow repository::
290A shallow repository has an incomplete history some of
291whose commits have parents cauterized away (in other
292words, git is told to pretend that these commits do not
293have the parents, even though they are recorded in the
294commit object). This is sometimes useful when you are
295interested only in the recent history of a project even
296though the real history recorded in the upstream is
297much larger. A shallow repository is created by giving
298`--depth` option to gitlink:git-clone[1], and its
299history can be later deepened with gitlink:git-fetch[1].
300
Junio C Hamano3a971022006-11-18 22:17:58301symref::
302Symbolic reference: instead of containing the SHA1 id itself, it
303is of the format 'ref: refs/some/thing' and when referenced, it
304recursively dereferences to this reference. 'HEAD' is a prime
305example of a symref. Symbolic references are manipulated with
306the gitlink:git-symbolic-ref[1] command.
307
Junio C Hamano88a3a072006-05-04 08:01:43308topic branch::
309A regular git branch that is used by a developer to
310identify a conceptual line of development. Since branches
311are very easy and inexpensive, it is often desirable to
312have several small branches that each contain very well
313defined concepts or small incremental yet related changes.
314
315tracking branch::
316A regular git branch that is used to follow changes from
317another repository. A tracking branch should not contain
318direct modifications or have local commits made to it.
319A tracking branch can usually be identified as the
320right-hand-side ref in a Pull: refspec.
321
322tree object::
323An object containing a list of file names and modes along with refs
324to the associated blob and/or tree objects. A tree is equivalent
325to a directory.
326
327tree::
328Either a working tree, or a tree object together with the
329dependent blob and tree objects (i.e. a stored representation
330of a working tree).
Junio C Hamano1a4e8412005-12-27 08:17:23331
332tree-ish::
333A ref pointing to either a commit object, a tree object, or a
334tag object pointing to a tag or commit or tree object.
335
Junio C Hamano1a4e8412005-12-27 08:17:23336tag object::
337An object containing a ref pointing to another object, which can
338contain a message just like a commit object. It can also
339contain a (PGP) signature, in which case it is called a "signed
340tag object".
341
342tag::
343A ref pointing to a tag or commit object. In contrast to a head,
344a tag is not changed by a commit. Tags (not tag objects) are
345stored in `$GIT_DIR/refs/tags/`. A git tag has nothing to do with
346a Lisp tag (which is called object type in git's context).
347A tag is most typically used to mark a particular point in the
348commit ancestry chain.
349
Junio C Hamano21c0b422006-10-12 19:10:36350unmerged index::
Junio C Hamano88a3a072006-05-04 08:01:43351An index which contains unmerged index entries.
Junio C Hamano1a4e8412005-12-27 08:17:23352
Junio C Hamano88a3a072006-05-04 08:01:43353working tree::
354The set of files and directories currently being worked on,
355i.e. you can work in your working tree without using git at all.
Junio C Hamano1a4e8412005-12-27 08:17:23356