From 79de45588c2d90591a2bc0fcf28964bce642fd71 Mon Sep 17 00:00:00 2001 From: Thomas Ackermann Date: Mon, 15 Apr 2013 19:46:56 +0200 Subject: glossary: remove outdated/misleading/irrelevant entries Signed-off-by: Thomas Ackermann Signed-off-by: Junio C Hamano --- Documentation/glossary-content.txt | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) (limited to 'Documentation/glossary-content.txt') diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index eb7ba84f1f..5a7a486aab 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -104,9 +104,6 @@ to point at the new commit. 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. See <>. - [[def_directory]]directory:: The list you get with "ls" :-) @@ -115,11 +112,6 @@ to point at the new commit. it contains modifications which have not been <> to the current <>. -[[def_ent]]ent:: - Favorite synonym to "<>" by some total geeks. See - http://en.wikipedia.org/wiki/Ent_(Middle-earth) for an in-depth - explanation. Avoid this term, not to confuse people. - [[def_evil_merge]]evil merge:: An evil merge is a <> that introduces changes that do not appear in any <>. @@ -257,8 +249,7 @@ This commit is referred to as a "merge commit", or sometimes just a <>. [[def_octopus]]octopus:: - To <> more than two <>. Also denotes an - intelligent predator. + To <> more than two <>. [[def_origin]]origin:: The default upstream <>. Most projects have -- cgit 1.2.3-korg From 3ab501209b46e83a377ac5a781a8f2fef7f4f30c Mon Sep 17 00:00:00 2001 From: Thomas Ackermann Date: Mon, 15 Apr 2013 19:47:50 +0200 Subject: glossary: improve description of SHA-1 related topics The name of the hash function is "SHA-1", not "SHA1". Also to people who look up "object name" in the glossary, the details of which hash function is applied on what to compute "object name" is not important but the fact that the name is meant to be an unique identifier for the contents stored in the object is. Signed-off-by: Thomas Ackermann Signed-off-by: Junio C Hamano --- Documentation/glossary-content.txt | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'Documentation/glossary-content.txt') diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index 5a7a486aab..7f87f560c8 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -153,7 +153,7 @@ to point at the new commit. created. Configured via the `.git/info/grafts` file. [[def_hash]]hash:: - In Git's context, synonym to <>. + In Git's context, synonym for <>. [[def_head]]head:: A <> to the <> at the tip of a @@ -225,7 +225,7 @@ This commit is referred to as a "merge commit", or sometimes just a [[def_object]]object:: The unit of storage in Git. It is uniquely identified by the - <> of its contents. Consequently, an + <> of its contents. Consequently, an object can not be changed. [[def_object_database]]object database:: @@ -237,10 +237,9 @@ This commit is referred to as a "merge commit", or sometimes just a Synonym for <>. [[def_object_name]]object name:: - The unique identifier of an <>. The <> - of the object's contents using the Secure Hash Algorithm - 1 and usually represented by the 40 character hexadecimal encoding of - the <> of the object. + The unique identifier of an <>. The + object name is usually represented by a 40 character + hexadecimal string. Also colloquially called <>. [[def_object_type]]object type:: One of the identifiers "<>", @@ -376,7 +375,7 @@ should not be combined with other pathspec. to the result. [[def_ref]]ref:: - A 40-byte hex representation of a <> or a name that + 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. @@ -432,8 +431,9 @@ should not be combined with other pathspec. [[def_SCM]]SCM:: Source code management (tool). -[[def_SHA1]]SHA1:: - Synonym for <>. +[[def_SHA1]]SHA-1:: + "Secure Hash Algorithm 1"; a cryptographic hash function. + In the context of Git used as a synonym for <>. [[def_shallow_repository]]shallow repository:: A shallow <> has an incomplete @@ -447,7 +447,7 @@ should not be combined with other pathspec. its history can be later deepened with linkgit:git-fetch[1]. [[def_symref]]symref:: - Symbolic reference: instead of containing the <> + Symbolic reference: instead of containing the <> id itself, it is of the format 'ref: refs/some/thing' and when referenced, it recursively dereferences to this reference. '<>' is a prime example of a symref. Symbolic -- cgit 1.2.3-korg From 57148ebb30fd7ed72acf7b3fc6f59d7cf2d94643 Mon Sep 17 00:00:00 2001 From: Thomas Ackermann Date: Mon, 15 Apr 2013 19:50:07 +0200 Subject: glossary: improve definitions of refspec and pathspec The exact definition of "refspec" can be found in git-fetch and git-push manpages. So don't duplicate this here in the glossary. Actually the definition of "pathspec" should be moved to a separate file akin to the way it's done with "refspec". But this will only be wortwhile when there's more to say about it. So for the time being just improve the first sentence a little bit; fix the indentation of the first paragraph after the bullet list and remove the one-item list of magic signatures with its - for the user - unnecessary introduction of "magic word 'top'". Signed-off-by: Thomas Ackermann Signed-off-by: Junio C Hamano --- Documentation/glossary-content.txt | 33 ++++++++++----------------------- 1 file changed, 10 insertions(+), 23 deletions(-) (limited to 'Documentation/glossary-content.txt') diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index 7f87f560c8..740bb325bf 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -268,7 +268,7 @@ This commit is referred to as a "merge commit", or sometimes just a pack. [[def_pathspec]]pathspec:: - Pattern used to specify paths. + Pattern used to limit paths in Git commands. + Pathspecs are used on the command line of "git ls-files", "git ls-tree", "git add", "git grep", "git diff", "git checkout", @@ -277,6 +277,8 @@ limit the scope of operations to some subset of the tree or worktree. See the documentation of each command for whether paths are relative to the current directory or toplevel. The pathspec syntax is as follows: ++ +-- * any path matches itself * the pathspec up to the last slash represents a @@ -286,11 +288,12 @@ pathspec syntax is as follows: of the pathname. Paths relative to the directory prefix will be matched against that pattern using fnmatch(3); in particular, '*' and '?' _can_ match directory separators. + +-- + For example, Documentation/*.jpg will match all .jpg files in the Documentation subtree, including Documentation/chapter_1/figure_1.jpg. - + A pathspec that begins with a colon `:` has special meaning. In the short form, the leading colon `:` is followed by zero or more "magic @@ -306,18 +309,10 @@ and a close parentheses `)`, and the remainder is the pattern to match against the path. + The "magic signature" consists of an ASCII symbol that is not -alphanumeric. -+ --- -top `/`;; - The magic word `top` (mnemonic: `/`) makes the pattern match - from the root of the working tree, even when you are running - the command from inside a subdirectory. --- -+ -Currently only the slash `/` is recognized as the "magic signature", -but it is envisioned that we will support more types of magic in later -versions of Git. +alphanumeric. Currently only the slash `/` is recognized as a +"magic signature": it makes the pattern match from the root of +the working tree, even when you are running the command from +inside a subdirectory. + A pathspec with only a colon means "there is no pathspec". This form should not be combined with other pathspec. @@ -389,15 +384,7 @@ should not be combined with other pathspec. [[def_refspec]]refspec:: 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, +. - For example: `git fetch $URL - refs/heads/master:refs/heads/origin` means "grab the master - <> <> from the $URL and store - it as my origin branch head". And `git push - $URL refs/heads/master:refs/heads/to-upstream` means "publish my - master branch head as to-upstream branch at $URL". See also - linkgit:git-push[1]. + <> and local ref. [[def_remote_tracking_branch]]remote-tracking branch:: A regular Git <> that is used to follow changes from -- cgit 1.2.3-korg