Add a few more words to the glossary.
Clean up a few entries and fix typos. bare repository cherry-picking hook topic branch [jc: removing questionable "symbolic ref -- see 'ref'" for now.] Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
Jon Loeliger committed
May 3, 2006 at 23:19 UTC
7abd7117ec57b8c3c2a469db62c7811fdac5c655
1 file changed
+51
-12
Documentation/glossary.txt
+51
-12
@@ -3,6 +3,17 @@ alternate object database::
3
object database from another object database, which is called
4
"alternate".
5
6
+bare repository::
7
+ A bare repository is normally an appropriately named
8
+ directory with a `.git` suffix that does not have a
9
+ locally checked-out copy of any of the files under revision
10
+ control. That is, all of the `git` administrative and
11
+ control files that would normally be present in the
12
+ hidden `.git` sub-directory are directly present in
13
+ the `repository.git` directory instead, and no other files
14
+ are present and checked out. Usually publishers of public
15
+ repositories make bare repositories available.
16
+
17
blob object::
18
Untyped object, e.g. the contents of a file.
19
@@ -28,6 +39,15 @@ checkout::
39
The action of updating the working tree to a revision which was
40
stored in the object database.
41
42
+cherry-picking::
43
+ In SCM jargon, "cherry pick" means to choose a subset of
44
+ changes out of a series of changes (typically commits)
45
+ and record them as a new series of changes on top of
46
+ different codebase. In GIT, this is performed by
47
+ "git cherry-pick" command to extract the change
48
+ introduced by an existing commit and to record it based
49
+ on the tip of the current branch as a new commit.
50
+
51
clean::
52
A working tree is clean, if it corresponds to the revision
53
referenced by the current head. Also see "dirty".
@@ -100,6 +120,16 @@ head ref::
120
A ref pointing to a head. Often, this is abbreviated to "head".
121
Head refs are stored in `$GIT_DIR/refs/heads/`.
122
123
+hook::
124
+ During the normal execution of several git commands,
125
+ call-outs are made to optional scripts that allow
126
+ a developer to add functionality or checking.
127
+ Typically, the hooks allow for a command to be pre-verified
128
+ and potentially aborted, and allow for a post-notification
129
+ after the operation is done.
130
+ The hook scripts are found in the `$GIT_DIR/hooks/` directory,
131
+ and are enabled by simply making them executable.
132
+
133
index::
134
A collection of files with stat information, whose contents are
135
stored as objects. The index is a stored version of your working
@@ -113,10 +143,10 @@ index entry::
143
that file).
144
145
master::
116
- The default branch. Whenever you create a git repository, a branch
117
- named "master" is created, and becomes the active branch. In most
118
- cases, this contains the local development.
119
-
146
+ The default development branch. Whenever you create a git
147
+ repository, a branch named "master" is created, and becomes
148
+ the active branch. In most cases, this contains the local
149
+ development, though that is purely conventional and not required.
150
151
merge::
152
To merge branches means to try to accumulate the changes since a
@@ -151,10 +181,11 @@ octopus::
181
predator.
182
183
origin::
154
- The default upstream branch. Most projects have one upstream
155
- project which they track, and by default 'origin' is used for
156
- that purpose. New updates from upstream will be fetched into
157
- this branch; you should never commit to it yourself.
184
+ The default upstream tracking branch. Most projects have at
185
+ least one upstream project which they track. By default
186
+ 'origin' is used for that purpose. New upstream updates
187
+ will be fetched into this branch; you should never commit
188
+ to it yourself.
189
190
pack::
191
A set of objects which have been compressed into one file (to save
@@ -168,7 +199,8 @@ parent::
199
A commit object contains a (possibly empty) list of the logical
200
predecessor(s) in the line of development, i.e. its parents.
201
171
-pickaxe:: The term pickaxe refers to an option to the diffcore routines
202
+pickaxe::
203
+ The term pickaxe refers to an option to the diffcore routines
204
that help select changes that add or delete a given text string.
205
With the --pickaxe-all option, it can be used to view the
206
full changeset that introduced or removed, say, a particular
@@ -204,8 +236,8 @@ rebase::
236
changes from that branch.
237
238
ref::
207
- A 40-byte hex representation of a SHA1 pointing to a particular
208
- object. These may be stored in `$GIT_DIR/refs/`.
239
+ A 40-byte hex representation of a SHA1 or a name that denotes
240
+ a particular object. These may be stored in `$GIT_DIR/refs/`.
241
242
refspec::
243
A refspec is used by fetch and push to describe the mapping
@@ -243,10 +275,17 @@ SCM::
275
SHA1::
276
Synonym for object name.
277
278
+topic branch::
279
+ A regular git branch that is used by a developer to
280
+ identify a conceptual line of development. Since branches
281
+ are very easy and inexpensive, it is often desirable to
282
+ have several small branches that each contain very well
283
+ defined concepts or small incremental yet related changes.
284
+
285
tracking branch::
286
A regular git branch that is used to follow changes from
287
another repository. A tracking branch should not contain
249
- direct modifications or made commits made locally.
288
+ direct modifications or have local commits made to it.
289
A tracking branch can usually be identified as the
290
right-hand-side ref in a Pull: refspec.
291