From 36a2a54dbf49b74519f6af1a672c9232e450f5f1 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Wed, 4 Sep 2013 15:04:28 -0400 Subject: glossary: mention 'treeish' as an alternative to 'tree-ish' The documentation contains a mix of the two spellings, so include both in the glossary so that a search for either will lead to the definition. Signed-off-by: Richard Hansen Signed-off-by: Junio C Hamano --- Documentation/glossary-content.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/glossary-content.txt') diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index dba5062b37..0273095eb4 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -486,7 +486,7 @@ should not be combined with other pathspec. with refs to the associated blob and/or tree objects. A <> is equivalent to a <>. -[[def_tree-ish]]tree-ish:: +[[def_tree-ish]]tree-ish (also treeish):: A <> pointing to either a <>, a <>, or a <> pointing to a tag or commit or tree object. -- cgit 1.2.3-korg From 406fde17da450036acc35316c085e32bbd73ebc1 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Wed, 4 Sep 2013 15:04:29 -0400 Subject: glossary: define commit-ish (a.k.a. committish) Signed-off-by: Richard Hansen Signed-off-by: Junio C Hamano --- Documentation/glossary-content.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'Documentation/glossary-content.txt') diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index 0273095eb4..47e901ece8 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -82,6 +82,18 @@ to point at the new commit. to the top <> of the stored revision. +[[def_commit-ish]]commit-ish (also committish):: + A <> or an + <> that can be recursively dereferenced to + a commit object. + The following are all commit-ishes: + a commit object, + a <> that points to a commit + object, + a tag object that points to a tag object that points to a + commit object, + etc. + [[def_core_git]]core Git:: Fundamental data structures and utilities of Git. Exposes only limited source code management tools. -- cgit 1.2.3-korg From 930f302cdbdd8410188fe306341117cd10af3383 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Wed, 4 Sep 2013 15:04:32 -0400 Subject: glossary: more precise definition of tree-ish (a.k.a. treeish) A tree-ish isn't a ref. Also, mention dereferencing, and that a commit dereferences to a tree, to support gitrevisions(7) and rev-parse's error messages. Signed-off-by: Richard Hansen Signed-off-by: Junio C Hamano --- Documentation/glossary-content.txt | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'Documentation/glossary-content.txt') diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index 47e901ece8..3466ce9129 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -499,9 +499,18 @@ should not be combined with other pathspec. <> is equivalent to a <>. [[def_tree-ish]]tree-ish (also treeish):: - A <> pointing to either a <>, a <>, or a <> pointing to a tag or commit or tree object. + A <> or an <> + that can be recursively dereferenced to a tree object. + Dereferencing a <> yields the + tree object corresponding to the <>'s + top <>. + The following are all tree-ishes: + a <>, + a tree object, + a <> that points to a tree object, + a tag object that points to a tag object that points to a tree + object, + etc. [[def_unmerged_index]]unmerged index:: An <> which contains unmerged -- cgit 1.2.3-korg From 4b6acde54364d9350779eb470a1677aa78ed5bf4 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Wed, 4 Sep 2013 15:04:34 -0400 Subject: glossary: fix and clarify the definition of 'ref' Signed-off-by: Richard Hansen Signed-off-by: Junio C Hamano --- Documentation/glossary-content.txt | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) (limited to 'Documentation/glossary-content.txt') diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index 3466ce9129..7ad13e1a9d 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -395,10 +395,20 @@ should not be combined with other pathspec. to the result. [[def_ref]]ref:: - A 40-byte hex representation of a <> or a name that - denotes a particular <>. They may be stored in - a file under `$GIT_DIR/refs/` directory, or - in the `$GIT_DIR/packed-refs` file. + A name that begins with `refs/` (e.g. `refs/heads/master`) + that points to an <> or another + ref (the latter is called a <>). + For convenience, a ref can sometimes be abbreviated when used + as an argument to a Git command; see linkgit:gitrevisions[7] + for details. + Refs are stored in the <>. ++ +The ref namespace is hierarchical. +Different subhierarchies are used for different purposes (e.g. the +`refs/heads/` hierarchy is used to represent local branches). ++ +There are a few special-purpose refs that do not begin with `refs/`. +The most notable example is `HEAD`. [[def_reflog]]reflog:: A reflog shows the local "history" of a ref. In other words, -- cgit 1.2.3-korg