glossary: stop generating automatically
The sort_glossary.pl script sorts the glossary, checks for duplicates, and automatically adds cross-references. But it's not so hard to do all that by hand, and sometimes the automatic cross-references are a little wrong; so let's run the script one last time and check in its output. Note: to make the output fit better into the user manual I also deleted the acknowledgements at the end, which was maybe a little rude; feel free to object and I can find a different solution. Cc: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
J. Bruce Fields committed
Mar 18, 2007 at 17:02 UTC
f562e6f3169f652dd9e840286e43d9e8ca45cf14
4 files changed
+392
-428
Documentation/Makefile
+2
-6
@@ -16,8 +16,9 @@ ARTICLES += repository-layout
16
ARTICLES += hooks
17
ARTICLES += everyday
18
ARTICLES += git-tools
19
+ARTICLES += glossary
20
# with their own formatting rules.
20
-SP_ARTICLES = glossary howto/revert-branch-rebase user-manual
21
+SP_ARTICLES = howto/revert-branch-rebase user-manual
22
23
DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))
24
@@ -111,11 +112,6 @@ XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
112
user-manual.html: user-manual.xml
113
xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<
114
114
-glossary.html : glossary.txt sort_glossary.pl
115
- cat $< | \
116
- perl sort_glossary.pl | \
117
- $(ASCIIDOC) -b xhtml11 - > glossary.html
118
-
115
howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
116
rm -f $@+ $@
117
sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
Documentation/glossary.txt
+390
-350
@@ -1,365 +1,405 @@
1
-alternate object database::
2
- Via the alternates mechanism, a repository can inherit part of its
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
-
20
-branch::
21
- A non-cyclical graph of revisions, i.e. the complete history of
22
- a particular revision, which is called the branch head. The
23
- branch heads are stored in `$GIT_DIR/refs/heads/`.
24
-
25
-cache::
26
- Obsolete for: index.
27
-
28
-chain::
29
- A list of objects, where each object in the list contains a
30
- reference to its successor (for example, the successor of a commit
31
- could be one of its parents).
32
-
33
-changeset::
34
- BitKeeper/cvsps speak for "commit". Since git does not store
35
- changes, but states, it really does not make sense to use
36
- the term "changesets" with git.
37
-
38
-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".
54
-
55
-commit::
56
- As a verb: The action of storing the current state of the index in the
57
- object database. The result is a revision.
58
- As a noun: Short hand for commit object.
59
-
60
-commit object::
61
- An object which contains the information about a particular
62
- revision, such as parents, committer, author, date and the
63
- tree object which corresponds to the top directory of the
64
- stored revision.
65
-
66
-core git::
67
- Fundamental data structures and utilities of git. Exposes only
68
- limited source code management tools.
69
-
70
-DAG::
71
- Directed acyclic graph. The commit objects form a directed acyclic
72
- graph, because they have parents (directed), and the graph of commit
73
- objects is acyclic (there is no chain which begins and ends with the
74
- same object).
75
-
76
-dangling object::
77
- An unreachable object which is not reachable even from other
78
- unreachable objects; a dangling object has no references to it
79
- from any reference or object in the repository.
80
-
81
-dircache::
1
+GIT Glossary
2
+============
3
+
4
+[[def_alternate_object_database]]alternate object database::
5
+ Via the alternates mechanism, a <<def_repository,repository>> can
6
+ inherit part of its <<def_object_database,object database>> from another
7
+ <<def_object_database,object database>>, which is called "alternate".
8
+
9
+[[def_bare_repository]]bare repository::
10
+ A <<def_bare_repository,bare repository>> is normally an appropriately
11
+ named <<def_directory,directory>> with a `.git` suffix that does not
12
+ have a locally checked-out copy of any of the files under
13
+ <<def_revision,revision>> control. That is, all of the `git`
14
+ administrative and control files that would normally be present in the
15
+ hidden `.git` sub-directory are directly present in the
16
+ `<<def_repository,repository>>.git` <<def_directory,directory>> instead,
17
+ and no other files are present and checked out. Usually publishers of
18
+ public repositories make bare repositories available.
19
+
20
+[[def_blob_object]]blob object::
21
+ Untyped <<def_object,object>>, e.g. the contents of a file.
22
+
23
+[[def_branch]]branch::
24
+ A non-cyclical graph of revisions, i.e. the complete history of a
25
+ particular <<def_revision,revision>>, which is called the
26
+ <<def_branch,branch>> <<def_head,head>>. The <<def_branch,branch>> heads
27
+ are stored in `$GIT_DIR/refs/heads/`.
28
+
29
+[[def_cache]]cache::
30
+ Obsolete for: <<def_index,index>>.
31
+
32
+[[def_chain]]chain::
33
+ A list of objects, where each <<def_object,object>> in the list contains
34
+ a reference to its successor (for example, the successor of a
35
+ <<def_commit,commit>> could be one of its parents).
36
+
37
+[[def_changeset]]changeset::
38
+ BitKeeper/cvsps speak for "<<def_commit,commit>>". Since git does not
39
+ store changes, but states, it really does not make sense to use the term
40
+ "changesets" with git.
41
+
42
+[[def_checkout]]checkout::
43
+ The action of updating the <<def_working_tree,working tree>> to a
44
+ <<def_revision,revision>> which was stored in the
45
+ <<def_object_database,object database>>.
46
+
47
+[[def_cherry-picking]]cherry-picking::
48
+ In <<def_SCM,SCM>> jargon, "cherry pick" means to choose a subset of
49
+ changes out of a series of changes (typically commits) and record them
50
+ as a new series of changes on top of different codebase. In GIT, this is
51
+ performed by "git cherry-pick" command to extract the change introduced
52
+ by an existing <<def_commit,commit>> and to record it based on the tip
53
+ of the current <<def_branch,branch>> as a new <<def_commit,commit>>.
54
+
55
+[[def_clean]]clean::
56
+ A <<def_working_tree,working tree>> is <<def_clean,clean>>, if it
57
+ corresponds to the <<def_revision,revision>> referenced by the current
58
+ <<def_head,head>>. Also see "<<def_dirty,dirty>>".
59
+
60
+[[def_commit]]commit::
61
+ As a verb: The action of storing the current state of the
62
+ <<def_index,index>> in the <<def_object_database,object database>>. The
63
+ result is a <<def_revision,revision>>. As a noun: Short hand for
64
+ <<def_commit_object,commit object>>.
65
+
66
+[[def_commit_object]]commit object::
67
+ An <<def_object,object>> which contains the information about a
68
+ particular <<def_revision,revision>>, such as parents, committer,
69
+ author, date and the <<def_tree_object,tree object>> which corresponds
70
+ to the top <<def_directory,directory>> of the stored
71
+ <<def_revision,revision>>.
72
+
73
+[[def_core_git]]core git::
74
+ Fundamental data structures and utilities of git. Exposes only limited
75
+ source code management tools.
76
+
77
+[[def_DAG]]DAG::
78
+ Directed acyclic graph. The <<def_commit,commit>> objects form a
79
+ directed acyclic graph, because they have parents (directed), and the
80
+ graph of <<def_commit,commit>> objects is acyclic (there is no
81
+ <<def_chain,chain>> which begins and ends with the same
82
+ <<def_object,object>>).
83
+
84
+[[def_dangling_object]]dangling object::
85
+ An <<def_unreachable_object,unreachable object>> which is not
86
+ <<def_reachable,reachable>> even from other unreachable objects; a
87
+ <<def_dangling_object,dangling object>> has no references to it from any
88
+ reference or <<def_object,object>> in the <<def_repository,repository>>.
89
+
90
+[[def_dircache]]dircache::
91
You are *waaaaay* behind.
92
84
-dirty::
85
- A working tree is said to be dirty if it contains modifications
86
- which have not been committed to the current branch.
87
-
88
-directory::
93
+[[def_directory]]directory::
94
The list you get with "ls" :-)
95
91
-ent::
92
- Favorite synonym to "tree-ish" by some total geeks. See
96
+[[def_dirty]]dirty::
97
+ A <<def_working_tree,working tree>> is said to be <<def_dirty,dirty>> if
98
+ it contains modifications which have not been committed to the current
99
+ <<def_branch,branch>>.
100
+
101
+[[def_ent]]ent::
102
+ Favorite synonym to "<<def_tree-ish,tree-ish>>" by some total geeks. See
103
`http://en.wikipedia.org/wiki/Ent_(Middle-earth)` for an in-depth
94
- explanation. Avoid this term, not to confuse people.
95
-
96
-fast forward::
97
- A fast-forward is a special type of merge where you have
98
- a revision and you are "merging" another branch's changes
99
- that happen to be a descendant of what you have.
100
- In such these cases, you do not make a new merge commit but
101
- instead just update to his revision. This will happen
102
- frequently on a tracking branch of a remote repository.
103
-
104
-fetch::
105
- Fetching a branch means to get the branch's head ref from a
106
- remote repository, to find out which objects are missing from
107
- the local object database, and to get them, too.
108
-
109
-file system::
110
- Linus Torvalds originally designed git to be a user space file
111
- system, i.e. the infrastructure to hold files and directories.
112
- That ensured the efficiency and speed of git.
113
-
114
-git archive::
115
- Synonym for repository (for arch people).
116
-
117
-grafts::
118
- Grafts enables two otherwise different lines of development to be
119
- joined together by recording fake ancestry information for commits.
120
- This way you can make git pretend the set of parents a commit
121
- has is different from what was recorded when the commit was created.
122
- Configured via the `.git/info/grafts` file.
123
-
124
-hash::
125
- In git's context, synonym to object name.
126
-
127
-head::
128
- The top of a branch. It contains a ref to the corresponding
129
- commit object.
130
-
131
-head ref::
132
- A ref pointing to a head. Often, this is abbreviated to "head".
133
- Head refs are stored in `$GIT_DIR/refs/heads/`.
134
-
135
-hook::
136
- During the normal execution of several git commands,
137
- call-outs are made to optional scripts that allow
138
- a developer to add functionality or checking.
139
- Typically, the hooks allow for a command to be pre-verified
140
- and potentially aborted, and allow for a post-notification
141
- after the operation is done.
142
- The hook scripts are found in the `$GIT_DIR/hooks/` directory,
143
- and are enabled by simply making them executable.
144
-
145
-index::
146
- A collection of files with stat information, whose contents are
147
- stored as objects. The index is a stored version of your working
148
- tree. Truth be told, it can also contain a second, and even a third
149
- version of a working tree, which are used when merging.
150
-
151
-index entry::
152
- The information regarding a particular file, stored in the index.
153
- An index entry can be unmerged, if a merge was started, but not
154
- yet finished (i.e. if the index contains multiple versions of
155
- that file).
156
-
157
-master::
158
- The default development branch. Whenever you create a git
159
- repository, a branch named "master" is created, and becomes
160
- the active branch. In most cases, this contains the local
104
+ explanation. Avoid this term, not to confuse people.
105
+
106
+[[def_fast_forward]]fast forward::
107
+ A fast-forward is a special type of <<def_merge,merge>> where you have a
108
+ <<def_revision,revision>> and you are "merging" another
109
+ <<def_branch,branch>>'s changes that happen to be a descendant of what
110
+ you have. In such these cases, you do not make a new <<def_merge,merge>>
111
+ <<def_commit,commit>> but instead just update to his
112
+ <<def_revision,revision>>. This will happen frequently on a
113
+ <<def_tracking_branch,tracking branch>> of a remote
114
+ <<def_repository,repository>>.
115
+
116
+[[def_fetch]]fetch::
117
+ Fetching a <<def_branch,branch>> means to get the
118
+ <<def_branch,branch>>'s <<def_head_ref,head ref>> from a remote
119
+ <<def_repository,repository>>, to find out which objects are missing
120
+ from the local <<def_object_database,object database>>, and to get them,
121
+ too.
122
+
123
+[[def_file_system]]file system::
124
+ Linus Torvalds originally designed git to be a user space file system,
125
+ i.e. the infrastructure to hold files and directories. That ensured the
126
+ efficiency and speed of git.
127
+
128
+[[def_git_archive]]git archive::
129
+ Synonym for <<def_repository,repository>> (for arch people).
130
+
131
+[[def_grafts]]grafts::
132
+ Grafts enables two otherwise different lines of development to be joined
133
+ together by recording fake ancestry information for commits. This way
134
+ you can make git pretend the set of parents a <<def_commit,commit>> has
135
+ is different from what was recorded when the <<def_commit,commit>> was
136
+ created. Configured via the `.git/info/<<def_grafts,grafts>>` file.
137
+
138
+[[def_hash]]hash::
139
+ In git's context, synonym to <<def_object_name,object name>>.
140
+
141
+[[def_head]]head::
142
+ The top of a <<def_branch,branch>>. It contains a <<def_ref,ref>> to the
143
+ corresponding <<def_commit_object,commit object>>.
144
+
145
+[[def_head_ref]]head ref::
146
+ A <<def_ref,ref>> pointing to a <<def_head,head>>. Often, this is
147
+ abbreviated to "<<def_head,head>>". Head refs are stored in
148
+ `$GIT_DIR/refs/heads/`.
149
+
150
+[[def_hook]]hook::
151
+ During the normal execution of several git commands, call-outs are made
152
+ to optional scripts that allow a developer to add functionality or
153
+ checking. Typically, the hooks allow for a command to be pre-verified
154
+ and potentially aborted, and allow for a post-notification after the
155
+ operation is done. The <<def_hook,hook>> scripts are found in the
156
+ `$GIT_DIR/hooks/` <<def_directory,directory>>, and are enabled by simply
157
+ making them executable.
158
+
159
+[[def_index]]index::
160
+ A collection of files with stat information, whose contents are stored
161
+ as objects. The <<def_index,index>> is a stored version of your working
162
+ <<def_tree,tree>>. Truth be told, it can also contain a second, and even
163
+ a third version of a <<def_working_tree,working tree>>, which are used
164
+ when merging.
165
+
166
+[[def_index_entry]]index entry::
167
+ The information regarding a particular file, stored in the
168
+ <<def_index,index>>. An <<def_index_entry,index entry>> can be unmerged,
169
+ if a <<def_merge,merge>> was started, but not yet finished (i.e. if the
170
+ <<def_index,index>> contains multiple versions of that file).
171
+
172
+[[def_master]]master::
173
+ The default development <<def_branch,branch>>. Whenever you create a git
174
+ <<def_repository,repository>>, a <<def_branch,branch>> named
175
+ "<<def_master,master>>" is created, and becomes the active
176
+ <<def_branch,branch>>. In most cases, this contains the local
177
development, though that is purely conventional and not required.
178
163
-merge::
164
- To merge branches means to try to accumulate the changes since a
165
- common ancestor and apply them to the first branch. An automatic
166
- merge uses heuristics to accomplish that. Evidently, an automatic
167
- merge can fail.
168
-
169
-object::
170
- The unit of storage in git. It is uniquely identified by
171
- the SHA1 of its contents. Consequently, an object can not
172
- be changed.
173
-
174
-object database::
175
- Stores a set of "objects", and an individual object is identified
176
- by its object name. The objects usually live in `$GIT_DIR/objects/`.
177
-
178
-object identifier::
179
- Synonym for object name.
180
-
181
-object name::
182
- The unique identifier of an object. The hash of the object's contents
183
- using the Secure Hash Algorithm 1 and usually represented by the 40
184
- character hexadecimal encoding of the hash of the object (possibly
185
- followed by a white space).
186
-
187
-object type::
188
- One of the identifiers "commit","tree","tag" and "blob" describing
189
- the type of an object.
190
-
191
-octopus::
192
- To merge more than two branches. Also denotes an intelligent
193
- predator.
194
-
195
-origin::
196
- The default upstream repository. Most projects have at
197
- least one upstream project which they track. By default
198
- 'origin' is used for that purpose. New upstream updates
179
+[[def_merge]]merge::
180
+ To <<def_merge,merge>> branches means to try to accumulate the changes
181
+ since a common ancestor and apply them to the first
182
+ <<def_branch,branch>>. An automatic <<def_merge,merge>> uses heuristics
183
+ to accomplish that. Evidently, an automatic <<def_merge,merge>> can
184
+ fail.
185
+
186
+[[def_object]]object::
187
+ The unit of storage in git. It is uniquely identified by the
188
+ <<def_SHA1,SHA1>> of its contents. Consequently, an
189
+ <<def_object,object>> can not be changed.
190
+
191
+[[def_object_database]]object database::
192
+ Stores a set of "objects", and an individual <<def_object,object>> is
193
+ identified by its <<def_object_name,object name>>. The objects usually
194
+ live in `$GIT_DIR/objects/`.
195
+
196
+[[def_object_identifier]]object identifier::
197
+ Synonym for <<def_object_name,object name>>.
198
+
199
+[[def_object_name]]object name::
200
+ The unique identifier of an <<def_object,object>>. The <<def_hash,hash>>
201
+ of the <<def_object,object>>'s contents using the Secure Hash Algorithm
202
+ 1 and usually represented by the 40 character hexadecimal encoding of
203
+ the <<def_hash,hash>> of the <<def_object,object>> (possibly followed by
204
+ a white space).
205
+
206
+[[def_object_type]]object type::
207
+ One of the identifiers
208
+ "<<def_commit,commit>>","<<def_tree,tree>>","<<def_tag,tag>>" and "blob"
209
+ describing the type of an <<def_object,object>>.
210
+
211
+[[def_octopus]]octopus::
212
+ To <<def_merge,merge>> more than two branches. Also denotes an
213
+ intelligent predator.
214
+
215
+[[def_origin]]origin::
216
+ The default upstream <<def_repository,repository>>. Most projects have
217
+ at least one upstream project which they track. By default
218
+ '<<def_origin,origin>>' is used for that purpose. New upstream updates
219
will be fetched into remote tracking branches named
200
- origin/name-of-upstream-branch, which you can see using
201
- "git branch -r".
220
+ <<def_origin,origin>>/name-of-upstream-branch, which you can see using
221
+ "git <<def_branch,branch>> -r".
222
203
-pack::
204
- A set of objects which have been compressed into one file (to save
205
- space or to transmit them efficiently).
223
+[[def_pack]]pack::
224
+ A set of objects which have been compressed into one file (to save space
225
+ or to transmit them efficiently).
226
207
-pack index::
227
+[[def_pack_index]]pack index::
228
The list of identifiers, and other information, of the objects in a
209
- pack, to assist in efficiently accessing the contents of a pack.
210
-
211
-parent::
212
- A commit object contains a (possibly empty) list of the logical
213
- predecessor(s) in the line of development, i.e. its parents.
214
-
215
-pickaxe::
216
- The term pickaxe refers to an option to the diffcore routines
217
- that help select changes that add or delete a given text string.
218
- With the --pickaxe-all option, it can be used to view the
219
- full changeset that introduced or removed, say, a particular
220
- line of text. See gitlink:git-diff[1].
221
-
222
-plumbing::
223
- Cute name for core git.
224
-
225
-porcelain::
226
- Cute name for programs and program suites depending on core git,
227
- presenting a high level access to core git. Porcelains expose
228
- more of a SCM interface than the plumbing.
229
-
230
-pull::
231
- Pulling a branch means to fetch it and merge it.
232
-
233
-push::
234
- Pushing a branch means to get the branch's head ref from a remote
235
- repository, find out if it is an ancestor to the branch's local
236
- head ref is a direct, and in that case, putting all objects, which
237
- are reachable from the local head ref, and which are missing from
238
- the remote repository, into the remote object database, and updating
239
- the remote head ref. If the remote head is not an ancestor to the
240
- local head, the push fails.
241
-
242
-reachable::
243
- All of the ancestors of a given commit are said to be reachable from
244
- that commit. More generally, one object is reachable from another if
245
- we can reach the one from the other by a chain that follows tags to
246
- whatever they tag, commits to their parents or trees, and trees to the
247
- trees or blobs that they contain.
248
-
249
-rebase::
250
- To clean a branch by starting from the head of the main line of
251
- development ("master"), and reapply the (possibly cherry-picked)
252
- changes from that branch.
253
-
254
-ref::
255
- A 40-byte hex representation of a SHA1 or a name that denotes
256
- a particular object. These may be stored in `$GIT_DIR/refs/`.
257
-
258
-refspec::
259
- A refspec is used by fetch and push to describe the mapping
260
- between remote ref and local ref. They are combined with
261
- a colon in the format <src>:<dst>, preceded by an optional
262
- plus sign, +. For example:
263
- `git fetch $URL refs/heads/master:refs/heads/origin`
264
- means "grab the master branch head from the $URL and store
265
- it as my origin branch head".
266
- And `git push $URL refs/heads/master:refs/heads/to-upstream`
267
- means "publish my master branch head as to-upstream branch
268
- at $URL". See also gitlink:git-push[1]
269
-
270
-repository::
271
- A collection of refs together with an object database containing
272
- all objects, which are reachable from the refs, possibly accompanied
273
- by meta data from one or more porcelains. A repository can
274
- share an object database with other repositories.
275
-
276
-resolve::
277
- The action of fixing up manually what a failed automatic merge
278
- left behind.
279
-
280
-revision::
281
- A particular state of files and directories which was stored in
282
- the object database. It is referenced by a commit object.
283
-
284
-rewind::
285
- To throw away part of the development, i.e. to assign the head to
286
- an earlier revision.
287
-
288
-SCM::
229
+ <<def_pack,pack>>, to assist in efficiently accessing the contents of a
230
+ <<def_pack,pack>>.
231
+
232
+[[def_parent]]parent::
233
+ A <<def_commit_object,commit object>> contains a (possibly empty) list
234
+ of the logical predecessor(s) in the line of development, i.e. its
235
+ parents.
236
+
237
+[[def_pickaxe]]pickaxe::
238
+ The term <<def_pickaxe,pickaxe>> refers to an option to the diffcore
239
+ routines that help select changes that add or delete a given text
240
+ string. With the --pickaxe-all option, it can be used to view the full
241
+ <<def_changeset,changeset>> that introduced or removed, say, a
242
+ particular line of text. See gitlink:git-diff[1].
243
+
244
+[[def_plumbing]]plumbing::
245
+ Cute name for <<def_core_git,core git>>.
246
+
247
+[[def_porcelain]]porcelain::
248
+ Cute name for programs and program suites depending on
249
+ <<def_core_git,core git>>, presenting a high level access to
250
+ <<def_core_git,core git>>. Porcelains expose more of a <<def_SCM,SCM>>
251
+ interface than the <<def_plumbing,plumbing>>.
252
+
253
+[[def_pull]]pull::
254
+ Pulling a <<def_branch,branch>> means to <<def_fetch,fetch>> it and
255
+ <<def_merge,merge>> it.
256
+
257
+[[def_push]]push::
258
+ Pushing a <<def_branch,branch>> means to get the <<def_branch,branch>>'s
259
+ <<def_head_ref,head ref>> from a remote <<def_repository,repository>>,
260
+ find out if it is an ancestor to the <<def_branch,branch>>'s local
261
+ <<def_head_ref,head ref>> is a direct, and in that case, putting all
262
+ objects, which are <<def_reachable,reachable>> from the local
263
+ <<def_head_ref,head ref>>, and which are missing from the remote
264
+ <<def_repository,repository>>, into the remote
265
+ <<def_object_database,object database>>, and updating the remote
266
+ <<def_head_ref,head ref>>. If the remote <<def_head,head>> is not an
267
+ ancestor to the local <<def_head,head>>, the <<def_push,push>> fails.
268
+
269
+[[def_reachable]]reachable::
270
+ All of the ancestors of a given <<def_commit,commit>> are said to be
271
+ <<def_reachable,reachable>> from that <<def_commit,commit>>. More
272
+ generally, one <<def_object,object>> is <<def_reachable,reachable>> from
273
+ another if we can reach the one from the other by a <<def_chain,chain>>
274
+ that follows tags to whatever they <<def_tag,tag>>, commits to their
275
+ parents or trees, and trees to the trees or blobs that they contain.
276
+
277
+[[def_rebase]]rebase::
278
+ To <<def_clean,clean>> a <<def_branch,branch>> by starting from the
279
+ <<def_head,head>> of the main line of development
280
+ ("<<def_master,master>>"), and reapply the (possibly cherry-picked)
281
+ changes from that <<def_branch,branch>>.
282
+
283
+[[def_ref]]ref::
284
+ A 40-byte hex representation of a <<def_SHA1,SHA1>> or a name that
285
+ denotes a particular <<def_object,object>>. These may be stored in
286
+ `$GIT_DIR/refs/`.
287
+
288
+[[def_refspec]]refspec::
289
+ A <<def_refspec,refspec>> is used by <<def_fetch,fetch>> and
290
+ <<def_push,push>> to describe the mapping between remote <<def_ref,ref>>
291
+ and local <<def_ref,ref>>. They are combined with a colon in the format
292
+ <src>:<dst>, preceded by an optional plus sign, +. For example: `git
293
+ <<def_fetch,fetch>> $URL
294
+ refs/heads/<<def_master,master>>:refs/heads/<<def_origin,origin>>` means
295
+ "grab the <<def_master,master>> <<def_branch,branch>> <<def_head,head>>
296
+ from the $URL and store it as my <<def_origin,origin>>
297
+ <<def_branch,branch>> <<def_head,head>>". And `git <<def_push,push>>
298
+ $URL refs/heads/<<def_master,master>>:refs/heads/to-upstream` means
299
+ "publish my <<def_master,master>> <<def_branch,branch>>
300
+ <<def_head,head>> as to-upstream <<def_branch,branch>> at $URL". See
301
+ also gitlink:git-push[1]
302
+
303
+[[def_repository]]repository::
304
+ A collection of refs together with an <<def_object_database,object
305
+ database>> containing all objects, which are <<def_reachable,reachable>>
306
+ from the refs, possibly accompanied by meta data from one or more
307
+ porcelains. A <<def_repository,repository>> can share an
308
+ <<def_object_database,object database>> with other repositories.
309
+
310
+[[def_resolve]]resolve::
311
+ The action of fixing up manually what a failed automatic
312
+ <<def_merge,merge>> left behind.
313
+
314
+[[def_revision]]revision::
315
+ A particular state of files and directories which was stored in the
316
+ <<def_object_database,object database>>. It is referenced by a
317
+ <<def_commit_object,commit object>>.
318
+
319
+[[def_rewind]]rewind::
320
+ To throw away part of the development, i.e. to assign the
321
+ <<def_head,head>> to an earlier <<def_revision,revision>>.
322
+
323
+[[def_SCM]]SCM::
324
Source code management (tool).
325
291
-SHA1::
292
- Synonym for object name.
293
-
294
-shallow repository::
295
- A shallow repository has an incomplete history some of
296
- whose commits have parents cauterized away (in other
297
- words, git is told to pretend that these commits do not
298
- have the parents, even though they are recorded in the
299
- commit object). This is sometimes useful when you are
300
- interested only in the recent history of a project even
301
- though the real history recorded in the upstream is
302
- much larger. A shallow repository is created by giving
303
- `--depth` option to gitlink:git-clone[1], and its
326
+[[def_SHA1]]SHA1::
327
+ Synonym for <<def_object_name,object name>>.
328
+
329
+[[def_shallow_repository]]shallow repository::
330
+ A <<def_shallow_repository,shallow repository>> has an incomplete
331
+ history some of whose commits have parents cauterized away (in other
332
+ words, git is told to pretend that these commits do not have the
333
+ parents, even though they are recorded in the <<def_commit_object,commit
334
+ object>>). This is sometimes useful when you are interested only in the
335
+ recent history of a project even though the real history recorded in the
336
+ upstream is much larger. A <<def_shallow_repository,shallow repository>>
337
+ is created by giving `--depth` option to gitlink:git-clone[1], and its
338
history can be later deepened with gitlink:git-fetch[1].
339
306
-symref::
307
- Symbolic reference: instead of containing the SHA1 id itself, it
308
- is of the format 'ref: refs/some/thing' and when referenced, it
309
- recursively dereferences to this reference. 'HEAD' is a prime
310
- example of a symref. Symbolic references are manipulated with
311
- the gitlink:git-symbolic-ref[1] command.
312
-
313
-topic branch::
314
- A regular git branch that is used by a developer to
315
- identify a conceptual line of development. Since branches
316
- are very easy and inexpensive, it is often desirable to
317
- have several small branches that each contain very well
318
- defined concepts or small incremental yet related changes.
319
-
320
-tracking branch::
321
- A regular git branch that is used to follow changes from
322
- another repository. A tracking branch should not contain
323
- direct modifications or have local commits made to it.
324
- A tracking branch can usually be identified as the
325
- right-hand-side ref in a Pull: refspec.
326
-
327
-tree object::
328
- An object containing a list of file names and modes along with refs
329
- to the associated blob and/or tree objects. A tree is equivalent
330
- to a directory.
331
-
332
-tree::
333
- Either a working tree, or a tree object together with the
334
- dependent blob and tree objects (i.e. a stored representation
335
- of a working tree).
336
-
337
-tree-ish::
338
- A ref pointing to either a commit object, a tree object, or a
339
- tag object pointing to a tag or commit or tree object.
340
-
341
-tag object::
342
- An object containing a ref pointing to another object, which can
343
- contain a message just like a commit object. It can also
344
- contain a (PGP) signature, in which case it is called a "signed
345
- tag object".
346
-
347
-tag::
348
- A ref pointing to a tag or commit object. In contrast to a head,
349
- a tag is not changed by a commit. Tags (not tag objects) are
350
- stored in `$GIT_DIR/refs/tags/`. A git tag has nothing to do with
351
- a Lisp tag (which is called object type in git's context).
352
- A tag is most typically used to mark a particular point in the
353
- commit ancestry chain.
354
-
355
-unmerged index::
356
- An index which contains unmerged index entries.
357
-
358
-unreachable object::
359
- An object which is not reachable from a branch, tag, or any
360
- other reference.
361
-
362
-working tree::
363
- The set of files and directories currently being worked on,
364
- i.e. you can work in your working tree without using git at all.
365
-
340
+[[def_symref]]symref::
341
+ Symbolic reference: instead of containing the <<def_SHA1,SHA1>> id
342
+ itself, it is of the format '<<def_ref,ref>>: refs/some/thing' and when
343
+ referenced, it recursively dereferences to this reference. 'HEAD' is a
344
+ prime example of a <<def_symref,symref>>. Symbolic references are
345
+ manipulated with the gitlink:git-symbolic-ref[1] command.
346
+
347
+[[def_tag]]tag::
348
+ A <<def_ref,ref>> pointing to a <<def_tag,tag>> or
349
+ <<def_commit_object,commit object>>. In contrast to a <<def_head,head>>,
350
+ a <<def_tag,tag>> is not changed by a <<def_commit,commit>>. Tags (not
351
+ <<def_tag,tag>> objects) are stored in `$GIT_DIR/refs/tags/`. A git
352
+ <<def_tag,tag>> has nothing to do with a Lisp <<def_tag,tag>> (which is
353
+ called <<def_object_type,object type>> in git's context). A
354
+ <<def_tag,tag>> is most typically used to mark a particular point in the
355
+ <<def_commit,commit>> ancestry <<def_chain,chain>>.
356
+
357
+[[def_tag_object]]tag object::
358
+ An <<def_object,object>> containing a <<def_ref,ref>> pointing to
359
+ another <<def_object,object>>, which can contain a message just like a
360
+ <<def_commit_object,commit object>>. It can also contain a (PGP)
361
+ signature, in which case it is called a "signed <<def_tag_object,tag
362
+ object>>".
363
+
364
+[[def_topic_branch]]topic branch::
365
+ A regular git <<def_branch,branch>> that is used by a developer to
366
+ identify a conceptual line of development. Since branches are very easy
367
+ and inexpensive, it is often desirable to have several small branches
368
+ that each contain very well defined concepts or small incremental yet
369
+ related changes.
370
+
371
+[[def_tracking_branch]]tracking branch::
372
+ A regular git <<def_branch,branch>> that is used to follow changes from
373
+ another <<def_repository,repository>>. A <<def_tracking_branch,tracking
374
+ branch>> should not contain direct modifications or have local commits
375
+ made to it. A <<def_tracking_branch,tracking branch>> can usually be
376
+ identified as the right-hand-side <<def_ref,ref>> in a Pull:
377
+ <<def_refspec,refspec>>.
378
+
379
+[[def_tree]]tree::
380
+ Either a <<def_working_tree,working tree>>, or a <<def_tree_object,tree
381
+ object>> together with the dependent blob and <<def_tree,tree>> objects
382
+ (i.e. a stored representation of a <<def_working_tree,working tree>>).
383
+
384
+[[def_tree_object]]tree object::
385
+ An <<def_object,object>> containing a list of file names and modes along
386
+ with refs to the associated blob and/or <<def_tree,tree>> objects. A
387
+ <<def_tree,tree>> is equivalent to a <<def_directory,directory>>.
388
+
389
+[[def_tree-ish]]tree-ish::
390
+ A <<def_ref,ref>> pointing to either a <<def_commit_object,commit
391
+ object>>, a <<def_tree_object,tree object>>, or a <<def_tag_object,tag
392
+ object>> pointing to a <<def_tag,tag>> or <<def_commit,commit>> or
393
+ <<def_tree_object,tree object>>.
394
+
395
+[[def_unmerged_index]]unmerged index::
396
+ An <<def_index,index>> which contains <<def_unmerged_index,unmerged
397
+ index>> entries.
398
+
399
+[[def_unreachable_object]]unreachable object::
400
+ An <<def_object,object>> which is not <<def_reachable,reachable>> from a
401
+ <<def_branch,branch>>, <<def_tag,tag>>, or any other reference.
402
+
403
+[[def_working_tree]]working tree::
404
+ The set of files and directories currently being worked on, i.e. you can
405
+ work in your <<def_working_tree,working tree>> without using git at all.
Documentation/sort_glossary.pl
deleted
-69
@@ -1,69 +0,0 @@
1
-#!/usr/bin/perl
2
-
3
-%terms=();
4
-
5
-while(<>) {
6
- if(/^(\S.*)::$/) {
7
- my $term=$1;
8
- if(defined($terms{$term})) {
9
- die "$1 defined twice\n";
10
- }
11
- $terms{$term}="";
12
- LOOP: while(<>) {
13
- if(/^$/) {
14
- last LOOP;
15
- }
16
- if(/^ \S/) {
17
- $terms{$term}.=$_;
18
- } else {
19
- die "Error 1: $_";
20
- }
21
- }
22
- }
23
-}
24
-
25
-sub format_tab_80 ($) {
26
- my $text=$_[0];
27
- my $result="";
28
- $text=~s/\s+/ /g;
29
- $text=~s/^\s+//;
30
- while($text=~/^(.{1,72})(|\s+(\S.*)?)$/) {
31
- $result.=" ".$1."\n";
32
- $text=$3;
33
- }
34
- return $result;
35
-}
36
-
37
-sub no_spaces ($) {
38
- my $result=$_[0];
39
- $result=~tr/ /_/;
40
- return $result;
41
-}
42
-
43
-print 'GIT Glossary
44
-============
45
-
46
-This list is sorted alphabetically:
47
-
48
-';
49
-
50
-@keys=sort {uc($a) cmp uc($b)} keys %terms;
51
-$pattern='(\b(?<!link:git-)'.join('\b|\b(?<!-)',reverse @keys).'\b)';
52
-foreach $key (@keys) {
53
- $terms{$key}=~s/$pattern/sprintf "<<def_".no_spaces($1).",$1>>";/eg;
54
- print '[[def_'.no_spaces($key).']]'.$key."::\n"
55
- .format_tab_80($terms{$key})."\n";
56
-}
57
-
58
-print '
59
-
60
-Author
61
-------
62
-Written by Johannes Schindelin <Johannes.Schindelin@gmx.de> and
63
-the git-list <git@vger.kernel.org>.
64
-
65
-GIT
66
----
67
-Part of the link:git.html[git] suite
68
-';
69
-
Documentation/user-manual.txt
-3
@@ -3013,9 +3013,6 @@ confusing and scary messages, but it won't actually do anything bad. In
3013
contrast, running "git prune" while somebody is actively changing the
3014
repository is a *BAD* idea).
3015
3016
-Glossary of git terms
3017
-=====================
3018
-
3016
include::glossary.txt[]
3017
3018
Notes and todo list for this manual