@matheusbsbs / matheus-bagliano / commits / a58f3c01f7
Fork 0

Documentation: Clean up links in GIT Glossary

Ensure that the same link is not repeated in single glossary entry, and that there is no self-link i.e. link to current entry. Add links to other definitions in git glossary. Remove inappropriate (nonsense) links, or change link to link to correct definition (to correct term). Signed-off-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>

Jakub Narebski committed May 26, 2007 at 00:37 UTC a58f3c01f7e6aecb486aadece040a6293eb43059
1 file changed +29 -29
Documentation/glossary.txt
+29 -29
@@ -10,7 +10,7 @@ GIT Glossary
10 A 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`
13 + 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 `repository.git` directory instead,
@@ -37,7 +37,7 @@ GIT Glossary
37 [[def_chain]]chain::
38 A list of objects, where each <<def_object,object>> in the list contains
39 a reference to its successor (for example, the successor of a
40 - <<def_commit,commit>> could be one of its parents).
40 + <<def_commit,commit>> could be one of its <<def_parent,parents>>).
41
42 [[def_changeset]]changeset::
43 BitKeeper/cvsps speak for "<<def_commit,commit>>". Since git does not
@@ -77,10 +77,10 @@ to point at the new commit.
77
78 [[def_commit_object]]commit object::
79 An <<def_object,object>> which contains the information about a
80 - particular <<def_revision,revision>>, such as parents, committer,
80 + particular <<def_revision,revision>>, such as <<def_parent,parents>>, committer,
81 author, date and the <<def_tree_object,tree object>> which corresponds
82 to the top <<def_directory,directory>> of the stored
83 - <<def_revision,revision>>.
83 + revision.
84
85 [[def_core_git]]core git::
86 Fundamental data structures and utilities of git. Exposes only limited
@@ -101,19 +101,19 @@ to point at the new commit.
101
102 [[def_detached_HEAD]]detached HEAD::
103 Normally the <<def_HEAD,HEAD>> stores the name of a
104 - <<def_branch,branch>>. However, git also allows you to check
105 - out an arbitrary commit that isn't necessarily the tip of any
104 + <<def_branch,branch>>. However, git also allows you to <<def_checkout,check out>>
105 + an arbitrary <<def_commit,commit>> that isn't necessarily the tip of any
106 particular branch. In this case HEAD is said to be "detached".
107
108 [[def_dircache]]dircache::
109 - You are *waaaaay* behind.
109 + You are *waaaaay* behind. See <<def_index,index>>.
110
111 [[def_directory]]directory::
112 The list you get with "ls" :-)
113
114 [[def_dirty]]dirty::
115 A <<def_working_tree,working tree>> is said to be "dirty" if
116 - it contains modifications which have not been committed to the current
116 + it contains modifications which have not been <<def_commit,committed>> to the current
117 <<def_branch,branch>>.
118
119 [[def_ent]]ent::
@@ -149,7 +149,7 @@ to point at the new commit.
149 [[def_grafts]]grafts::
150 Grafts enables two otherwise different lines of development to be joined
151 together by recording fake ancestry information for commits. This way
152 - you can make git pretend the set of parents a <<def_commit,commit>> has
152 + you can make git pretend the set of <<def_parent,parents>> a <<def_commit,commit>> has
153 is different from what was recorded when the commit was
154 created. Configured via the `.git/info/grafts` file.
155
@@ -157,13 +157,13 @@ to point at the new commit.
157 In git's context, synonym to <<def_object_name,object name>>.
158
159 [[def_head]]head::
160 - A named reference to the <<def_commit,commit>> at the tip of a
160 + A <<def_ref,named reference>> to the <<def_commit,commit>> at the tip of a
161 <<def_branch,branch>>. Heads are stored in
162 `$GIT_DIR/refs/heads/`, except when using packed refs. (See
163 gitlink:git-pack-refs[1].)
164
165 [[def_HEAD]]HEAD::
166 - The current branch. In more detail: Your <<def_working_tree,
166 + The current <<def_branch,branch>>. In more detail: Your <<def_working_tree,
167 working tree>> is normally derived from the state of the tree
168 referred to by HEAD. HEAD is a reference to one of the
169 <<def_head,heads>> in your repository, except when using a
@@ -179,15 +179,15 @@ to point at the new commit.
179 checking. Typically, the hooks allow for a command to be pre-verified
180 and potentially aborted, and allow for a post-notification after the
181 operation is done. The hook scripts are found in the
182 - `$GIT_DIR/hooks/` <<def_directory,directory>>, and are enabled by simply
182 + `$GIT_DIR/hooks/` directory, and are enabled by simply
183 making them executable.
184
185 [[def_index]]index::
186 A collection of files with stat information, whose contents are stored
187 - as objects. The index is a stored version of your working
188 - <<def_tree,tree>>. Truth be told, it can also contain a second, and even
189 - a third version of a <<def_working_tree,working tree>>, which are used
190 - when merging.
187 + as objects. The index is a stored version of your
188 + <<def_working_tree,working tree>>. Truth be told, it can also contain a second, and even
189 + a third version of a working tree, which are used
190 + when <<def_merge,merging>>.
191
192 [[def_index_entry]]index entry::
193 The information regarding a particular file, stored in the
@@ -249,16 +249,16 @@ This commit is referred to as a "merge commit", or sometimes just a
249 describing the type of an <<def_object,object>>.
250
251 [[def_octopus]]octopus::
252 - To <<def_merge,merge>> more than two branches. Also denotes an
252 + To <<def_merge,merge>> more than two <<def_branch,branches>>. Also denotes an
253 intelligent predator.
254
255 [[def_origin]]origin::
256 The default upstream <<def_repository,repository>>. Most projects have
257 at least one upstream project which they track. By default
258 'origin' is used for that purpose. New upstream updates
259 - will be fetched into remote tracking branches named
259 + will be fetched into remote <<def_tracking_branch,tracking branches>> named
260 origin/name-of-upstream-branch, which you can see using
261 - "git <<def_branch,branch>> -r".
261 + "`git branch -r`".
262
263 [[def_pack]]pack::
264 A set of objects which have been compressed into one file (to save space
@@ -327,7 +327,7 @@ This commit is referred to as a "merge commit", or sometimes just a
327 `$GIT_DIR/refs/`.
328
329 [[def_refspec]]refspec::
330 - A <<def_refspec,refspec>> is used by <<def_fetch,fetch>> and
330 + A "refspec" is used by <<def_fetch,fetch>> and
331 <<def_push,push>> to describe the mapping between remote
332 <<def_ref,ref>> and local ref. They are combined with a colon in
333 the format <src>:<dst>, preceded by an optional plus sign, +.
@@ -340,11 +340,12 @@ This commit is referred to as a "merge commit", or sometimes just a
340 gitlink:git-push[1]
341
342 [[def_repository]]repository::
343 - A collection of refs together with an
343 + A collection of <<def_ref,refs>> together with an
344 <<def_object_database,object database>> containing all objects
345 which are <<def_reachable,reachable>> from the refs, possibly
346 - accompanied by meta data from one or more porcelains. A
347 - repository can share an object database with other repositories.
346 + accompanied by meta data from one or more <<def_porcelain,porcelains>>. A
347 + repository can share an object database with other repositories
348 + via <<def_alternate_object_database,alternates mechanism>>.
349
350 [[def_resolve]]resolve::
351 The action of fixing up manually what a failed automatic
@@ -366,8 +367,8 @@ This commit is referred to as a "merge commit", or sometimes just a
367 Synonym for <<def_object_name,object name>>.
368
369 [[def_shallow_repository]]shallow repository::
369 - A shallow repository has an incomplete
370 - history some of whose commits have parents cauterized away (in other
370 + A shallow <<def_repository,repository>> has an incomplete
371 + history some of whose <<def_commit,commits>> have <<def_parent,parents>> cauterized away (in other
372 words, git is told to pretend that these commits do not have the
373 parents, even though they are recorded in the <<def_commit_object,commit
374 object>>). This is sometimes useful when you are interested only in the
@@ -385,7 +386,7 @@ This commit is referred to as a "merge commit", or sometimes just a
386 command.
387
388 [[def_tag]]tag::
388 - A <<def_ref,ref>> pointing to a tag or
389 + A <<def_ref,ref>> pointing to a <<def_tag_object,tag>> or
390 <<def_commit_object,commit object>>. In contrast to a <<def_head,head>>,
391 a tag is not changed by a <<def_commit,commit>>. Tags (not
392 <<def_tag_object,tag objects>>) are stored in `$GIT_DIR/refs/tags/`. A
@@ -398,8 +399,7 @@ This commit is referred to as a "merge commit", or sometimes just a
399 An <<def_object,object>> containing a <<def_ref,ref>> pointing to
400 another object, which can contain a message just like a
401 <<def_commit_object,commit object>>. It can also contain a (PGP)
401 - signature, in which case it is called a "signed <<def_tag_object,tag
402 - object>>".
402 + signature, in which case it is called a "signed tag object".
403
404 [[def_topic_branch]]topic branch::
405 A regular git <<def_branch,branch>> that is used by a developer to
@@ -418,7 +418,7 @@ This commit is referred to as a "merge commit", or sometimes just a
418
419 [[def_tree]]tree::
420 Either a <<def_working_tree,working tree>>, or a <<def_tree_object,tree
421 - object>> together with the dependent blob and tree objects
421 + object>> together with the dependent <<def_blob_object,blob>> and tree objects
422 (i.e. a stored representation of a working tree).
423
424 [[def_tree_object]]tree object::