From: Jakub Narebski Date: Fri, 25 May 2007 22:37:38 +0000 (+0200) Subject: Documentation: Clean up links in GIT Glossary X-Git-Tag: v1.5.2.1~4^2~13 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=a58f3c01f7e6aecb486aadece040a6293eb43059;p=git.git 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 Signed-off-by: Junio C Hamano --- diff --git a/Documentation/glossary.txt b/Documentation/glossary.txt index 489c3e9d5..ba5261883 100644 --- a/Documentation/glossary.txt +++ b/Documentation/glossary.txt @@ -10,7 +10,7 @@ GIT Glossary A bare repository is normally an appropriately named <> with a `.git` suffix that does not have a locally checked-out copy of any of the files under - <> control. That is, all of the `git` + revision control. That is, all of the `git` administrative and control files that would normally be present in the hidden `.git` sub-directory are directly present in the `repository.git` directory instead, @@ -37,7 +37,7 @@ GIT Glossary [[def_chain]]chain:: A list of objects, where each <> in the list contains a reference to its successor (for example, the successor of a - <> could be one of its parents). + <> could be one of its <>). [[def_changeset]]changeset:: BitKeeper/cvsps speak for "<>". Since git does not @@ -77,10 +77,10 @@ to point at the new commit. [[def_commit_object]]commit object:: An <> which contains the information about a - particular <>, such as parents, committer, + particular <>, such as <>, committer, author, date and the <> which corresponds to the top <> of the stored - <>. + revision. [[def_core_git]]core git:: Fundamental data structures and utilities of git. Exposes only limited @@ -101,19 +101,19 @@ to point at the new commit. [[def_detached_HEAD]]detached HEAD:: Normally the <> stores the name of a - <>. However, git also allows you to check - out an arbitrary commit that isn't necessarily the tip of any + <>. However, git also allows you to <> + an arbitrary <> that isn't necessarily the tip of any particular branch. In this case HEAD is said to be "detached". [[def_dircache]]dircache:: - You are *waaaaay* behind. + You are *waaaaay* behind. See <>. [[def_directory]]directory:: The list you get with "ls" :-) [[def_dirty]]dirty:: A <> is said to be "dirty" if - it contains modifications which have not been committed to the current + it contains modifications which have not been <> to the current <>. [[def_ent]]ent:: @@ -149,7 +149,7 @@ to point at the new commit. [[def_grafts]]grafts:: Grafts enables two otherwise different lines of development to be joined together by recording fake ancestry information for commits. This way - you can make git pretend the set of parents a <> has + you can make git pretend the set of <> a <> has is different from what was recorded when the commit was created. Configured via the `.git/info/grafts` file. @@ -157,13 +157,13 @@ to point at the new commit. In git's context, synonym to <>. [[def_head]]head:: - A named reference to the <> at the tip of a + A <> to the <> at the tip of a <>. Heads are stored in `$GIT_DIR/refs/heads/`, except when using packed refs. (See gitlink:git-pack-refs[1].) [[def_HEAD]]HEAD:: - The current branch. In more detail: Your <>. In more detail: Your <> is normally derived from the state of the tree referred to by HEAD. HEAD is a reference to one of the <> in your repository, except when using a @@ -179,15 +179,15 @@ to point at the new commit. checking. Typically, the hooks allow for a command to be pre-verified and potentially aborted, and allow for a post-notification after the operation is done. The hook scripts are found in the - `$GIT_DIR/hooks/` <>, and are enabled by simply + `$GIT_DIR/hooks/` directory, and are enabled by simply making them executable. [[def_index]]index:: A collection of files with stat information, whose contents are stored - as objects. The index is a stored version of your working - <>. Truth be told, it can also contain a second, and even - a third version of a <>, which are used - when merging. + as objects. The index is a stored version of your + <>. Truth be told, it can also contain a second, and even + a third version of a working tree, which are used + when <>. [[def_index_entry]]index entry:: 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 describing the type of an <>. [[def_octopus]]octopus:: - To <> more than two branches. Also denotes an + To <> more than two <>. Also denotes an intelligent predator. [[def_origin]]origin:: The default upstream <>. Most projects have at least one upstream project which they track. By default 'origin' is used for that purpose. New upstream updates - will be fetched into remote tracking branches named + will be fetched into remote <> named origin/name-of-upstream-branch, which you can see using - "git <> -r". + "`git branch -r`". [[def_pack]]pack:: 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 `$GIT_DIR/refs/`. [[def_refspec]]refspec:: - A <> is used by <> and + A "refspec" is used by <> and <> to describe the mapping between remote <> and local ref. They are combined with a colon in the format :, preceded by an optional plus sign, +. @@ -340,11 +340,12 @@ This commit is referred to as a "merge commit", or sometimes just a gitlink:git-push[1] [[def_repository]]repository:: - A collection of refs together with an + A collection of <> together with an <> containing all objects which are <> from the refs, possibly - accompanied by meta data from one or more porcelains. A - repository can share an object database with other repositories. + accompanied by meta data from one or more <>. A + repository can share an object database with other repositories + via <>. [[def_resolve]]resolve:: 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 Synonym for <>. [[def_shallow_repository]]shallow repository:: - A shallow repository has an incomplete - history some of whose commits have parents cauterized away (in other + A shallow <> has an incomplete + history some of whose <> have <> cauterized away (in other words, git is told to pretend that these commits do not have the parents, even though they are recorded in the <>). 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 command. [[def_tag]]tag:: - A <> pointing to a tag or + A <> pointing to a <> or <>. In contrast to a <>, a tag is not changed by a <>. Tags (not <>) 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 An <> containing a <> pointing to another object, which can contain a message just like a <>. It can also contain a (PGP) - signature, in which case it is called a "signed <>". + signature, in which case it is called a "signed tag object". [[def_topic_branch]]topic branch:: A regular git <> that is used by a developer to @@ -418,7 +418,7 @@ This commit is referred to as a "merge commit", or sometimes just a [[def_tree]]tree:: Either a <>, or a <> together with the dependent blob and tree objects + object>> together with the dependent <> and tree objects (i.e. a stored representation of a working tree). [[def_tree_object]]tree object::