[PATCH v2 0/3] Some small fixes to glossary-content.txt

[PATCH v2 0/3] Some small fixes to glossary-content.txt

[Thomas Ackermann]

This is a reroll of my patches for glossary-content.txt
with Junio's comments/suggestions included:

[PATCH 1/3] glossary: remove outdated/misleading/irrelevant entries
- keep entries for "directory" and "evil merge"
- keep comparison of "Git tag" to "Lisp tag"
[PATCH 2/3] glossary: improve description of SHA-1 related topics
- more suitable description for "object name"
- use "SHA-1" instead of "SHA1"
[PATCH 3/3] glossary: remove definition of refspec and pathspec
- further small changes to description of refspec and pathspec


---
Thomas

[PATCH v2 1/3] glossary: remove outdated/misleading/irrelevant entries

[Thomas Ackermann]

Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
---
 Documentation/glossary-content.txt | 11 +----------
 1 file changed, 1 insertion(+), 10 deletions(-)

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index eb7ba84..5a7a486 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -104,9 +104,6 @@ to point at the new commit.
 	an arbitrary <<def_commit,commit>> 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_index,index>>.
-
 [[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 <<def_commit,committed>> to the current
 	<<def_branch,branch>>.
 
-[[def_ent]]ent::
-	Favorite synonym to "<<def_tree-ish,tree-ish>>" 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 <<def_merge,merge>> that introduces changes that
 	do not appear in any <<def_parent,parent>>.
@@ -257,8 +249,7 @@ This commit is referred to as a "merge commit", or sometimes just a
 	<<def_object,object>>.
 
 [[def_octopus]]octopus::
-	To <<def_merge,merge>> more than two <<def_branch,branches>>. Also denotes an
-	intelligent predator.
+	To <<def_merge,merge>> more than two <<def_branch,branches>>.
 
 [[def_origin]]origin::
 	The default upstream <<def_repository,repository>>. Most projects have
-- 
1.8.1.msysgit.1


---
Thomas

Re: [PATCH v2 1/3] glossary: remove outdated/misleading/irrelevant entries

[Junio C Hamano]

Thomas Ackermann <th.acker@arcor.de> writes:

> -[[def_dircache]]dircache::
> -	You are *waaaaay* behind. See <<def_index,index>>.
> -
> ...
> -[[def_ent]]ent::
> -	Favorite synonym to "<<def_tree-ish,tree-ish>>" 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_octopus]]octopus::
> -	To <<def_merge,merge>> more than two <<def_branch,branches>>. Also denotes an
> -	intelligent predator.
> +	To <<def_merge,merge>> more than two <<def_branch,branches>>.


I agree that these are distracting and confusing than useful
historical references to our target audience.  People from an
earlier days of the project may miss the occasional entries with
these "fun" phrasing, but we are no longer the primary target of
glossary.

Will queue unless others object.  Thanks.

[PATCH v2 2/3] glossary: improve description of SHA-1 related topics

[Thomas Ackermann]

Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
---
 Documentation/glossary-content.txt | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 5a7a486..4dd0a52 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 <<def_object_name,object name>>.
+	In Git's context, synonym for <<def_object_name,object name>>.
 
 [[def_head]]head::
 	A <<def_ref,named reference>> to the <<def_commit,commit>> 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
-	<<def_SHA1,SHA1>> of its contents. Consequently, an
+	<<def_SHA1,SHA-1>> 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>>.
 
 [[def_object_name]]object name::
-	The unique identifier of an <<def_object,object>>. The <<def_hash,hash>>
-	of the object's contents using the Secure Hash Algorithm
-	1 and usually represented by the 40 character hexadecimal encoding of
-	the <<def_hash,hash>> of the object.
+	The unique identifier of an <<def_object,object>>.  The
+	object name is usually represented by a 40 character
+	hexadecimal string.  Also colloquially called <<def_SHA1,SHA-1>>
 
 [[def_object_type]]object type::
 	One of the identifiers "<<def_commit_object,commit>>",
@@ -376,7 +375,7 @@ should not be combined with other pathspec.
 	to the result.
 
 [[def_ref]]ref::
-	A 40-byte hex representation of a <<def_SHA1,SHA1>> or a name that
+	A 40-byte hex representation of a <<def_SHA1,SHA-1>> or a name that
 	denotes a particular <<def_object,object>>. 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_object_name,object name>>.
+[[def_SHA1]]SHA-1::
+	"Secure Hash Algorithm 1"; a cryptographic hash function. 
+	In the context of Git used as a synonym for <<def_object_name,object name>>.
 
 [[def_shallow_repository]]shallow repository::
 	A shallow <<def_repository,repository>> 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 <<def_SHA1,SHA1>>
+	Symbolic reference: instead of containing the <<def_SHA1,SHA-1>>
 	id itself, it is of the format 'ref: refs/some/thing' and when
 	referenced, it recursively dereferences to this reference.
 	'<<def_HEAD,HEAD>>' is a prime example of a symref. Symbolic
-- 
1.8.1.msysgit.1


---
Thomas

Re: [PATCH v2 2/3] glossary: improve description of SHA-1 related topics

[Junio C Hamano]

Thomas Ackermann <th.acker@arcor.de> writes:

> Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
> ---

The readers of the history may still want to see "improve how"
explained in the log.

	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 (the fact that the
	name is meant to be an unique identifier for the contents
	stored in the object is).

or something?

(no review comment below this line; patch kept for others' reference)

>  Documentation/glossary-content.txt | 20 ++++++++++----------
>  1 file changed, 10 insertions(+), 10 deletions(-)
>
> diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
> index 5a7a486..4dd0a52 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 <<def_object_name,object name>>.
> +	In Git's context, synonym for <<def_object_name,object name>>.
>  
>  [[def_head]]head::
>  	A <<def_ref,named reference>> to the <<def_commit,commit>> 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
> -	<<def_SHA1,SHA1>> of its contents. Consequently, an
> +	<<def_SHA1,SHA-1>> 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>>.
>  
>  [[def_object_name]]object name::
> -	The unique identifier of an <<def_object,object>>. The <<def_hash,hash>>
> -	of the object's contents using the Secure Hash Algorithm
> -	1 and usually represented by the 40 character hexadecimal encoding of
> -	the <<def_hash,hash>> of the object.
> +	The unique identifier of an <<def_object,object>>.  The
> +	object name is usually represented by a 40 character
> +	hexadecimal string.  Also colloquially called <<def_SHA1,SHA-1>>
>  
>  [[def_object_type]]object type::
>  	One of the identifiers "<<def_commit_object,commit>>",
> @@ -376,7 +375,7 @@ should not be combined with other pathspec.
>  	to the result.
>  
>  [[def_ref]]ref::
> -	A 40-byte hex representation of a <<def_SHA1,SHA1>> or a name that
> +	A 40-byte hex representation of a <<def_SHA1,SHA-1>> or a name that
>  	denotes a particular <<def_object,object>>. 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_object_name,object name>>.
> +[[def_SHA1]]SHA-1::
> +	"Secure Hash Algorithm 1"; a cryptographic hash function. 
> +	In the context of Git used as a synonym for <<def_object_name,object name>>.
>  
>  [[def_shallow_repository]]shallow repository::
>  	A shallow <<def_repository,repository>> 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 <<def_SHA1,SHA1>>
> +	Symbolic reference: instead of containing the <<def_SHA1,SHA-1>>
>  	id itself, it is of the format 'ref: refs/some/thing' and when
>  	referenced, it recursively dereferences to this reference.
>  	'<<def_HEAD,HEAD>>' is a prime example of a symref. Symbolic

Re: [PATCH v2 2/3] glossary: improve description of SHA-1 related topics

[Simon Ruderich]

On Sun, Apr 07, 2013 at 05:10:29PM +0200, Thomas Ackermann wrote:
> Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
> ---
> [snip]
>
>  [[def_object_name]]object name::
> -	The unique identifier of an <<def_object,object>>. The <<def_hash,hash>>
> -	of the object's contents using the Secure Hash Algorithm
> -	1 and usually represented by the 40 character hexadecimal encoding of
> -	the <<def_hash,hash>> of the object.
> +	The unique identifier of an <<def_object,object>>.  The
> +	object name is usually represented by a 40 character
> +	hexadecimal string.  Also colloquially called <<def_SHA1,SHA-1>>
                                                                        ^
Trailing . missing.

Regards
Simon
-- 
+ privacy is necessary
+ using gnupg http://gnupg.org
+ public key id: 0x92FEFDB7E44C32F9

[PATCH v2 3/3] glossary: remove definition of refspec and pathspec

[Thomas Ackermann]

Signed-off-by: Thomas Ackermann <th.acker@arcor.de>
---
 Documentation/glossary-content.txt | 64 ++------------------------------------
 1 file changed, 2 insertions(+), 62 deletions(-)

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 4dd0a52..f21678d 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -268,59 +268,7 @@ This commit is referred to as a "merge commit", or sometimes just a
 	pack.
 
 [[def_pathspec]]pathspec::
-       Pattern used to specify paths.
-+
-Pathspecs are used on the command line of "git ls-files", "git
-ls-tree", "git add", "git grep", "git diff", "git checkout",
-and many other commands to
-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
-  directory prefix.  The scope of that pathspec is
-  limited to that subtree.
-* the rest of the pathspec is a pattern for the remainder
-  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
-signature" letters (which optionally is terminated by another colon `:`),
-and the remainder is the pattern to match against the path. The optional
-colon that terminates the "magic signature" can be omitted if the pattern
-begins with a character that cannot be a "magic signature" and is not a
-colon.
-+
-In the long form, the leading colon `:` is followed by a open
-parenthesis `(`, a comma-separated list of zero or more "magic words",
-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.
-+
-A pathspec with only a colon means "there is no pathspec". This form
-should not be combined with other pathspec.
+       Pattern used to limit paths in Git commands.
 
 [[def_parent]]parent::
 	A <<def_commit_object,commit object>> contains a (possibly empty) list
@@ -389,15 +337,7 @@ should not be combined with other pathspec.
 [[def_refspec]]refspec::
 	A "refspec" is used by <<def_fetch,fetch>> and
 	<<def_push,push>> to describe the mapping between remote
-	<<def_ref,ref>> and local ref. They are combined with a colon in
-	the format <src>:<dst>, preceded by an optional plus sign, +.
-	For example: `git fetch $URL
-	refs/heads/master:refs/heads/origin` means "grab the master
-	<<def_branch,branch>> <<def_head,head>> 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].
+	<<def_ref,ref>> and local ref. 
 
 [[def_remote_tracking_branch]]remote-tracking branch::
 	A regular Git <<def_branch,branch>> that is used to follow changes from
-- 
1.8.1.msysgit.1


---
Thomas

Re: [PATCH v2 3/3] glossary: remove definition of refspec and pathspec

[Junio C Hamano]

Thomas Ackermann <th.acker@arcor.de> writes:

> Signed-off-by: Thomas Ackermann <th.acker@arcor.de>

It looks, at least to me, that the patch is about "give only
definitions for refspec and pathspec" removing other excessive
information that are better left to the real manual pages.

	Subject: glossary: just define refspec and pathspec

	In the glossary, just describe what it is and what it is for
	to define these terms.  How to formulate and use refspec and
	pathspec are already described in the documentation for X
	and Y, respectively.

or something, perhaps?  By the way, what are the values of X and Y?
If there is none, some of the text lost by this patch need to be
moved to and massaged to match the flow of some documentation pages
that currently lack these information.

> ---
>  Documentation/glossary-content.txt | 64 ++------------------------------------
>  1 file changed, 2 insertions(+), 62 deletions(-)
>
> diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
> index 4dd0a52..f21678d 100644
> --- a/Documentation/glossary-content.txt
> +++ b/Documentation/glossary-content.txt
> @@ -268,59 +268,7 @@ This commit is referred to as a "merge commit", or sometimes just a
>  	pack.
>  
>  [[def_pathspec]]pathspec::
> -       Pattern used to specify paths.
> -+
> -Pathspecs are used on the command line of "git ls-files", "git
> -ls-tree", "git add", "git grep", "git diff", "git checkout",
> -and many other commands to
> -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
> -  directory prefix.  The scope of that pathspec is
> -  limited to that subtree.
> -* the rest of the pathspec is a pattern for the remainder
> -  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
> -signature" letters (which optionally is terminated by another colon `:`),
> -and the remainder is the pattern to match against the path. The optional
> -colon that terminates the "magic signature" can be omitted if the pattern
> -begins with a character that cannot be a "magic signature" and is not a
> -colon.
> -+
> -In the long form, the leading colon `:` is followed by a open
> -parenthesis `(`, a comma-separated list of zero or more "magic words",
> -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.
> -+
> -A pathspec with only a colon means "there is no pathspec". This form
> -should not be combined with other pathspec.
> +       Pattern used to limit paths in Git commands.
>  
>  [[def_parent]]parent::
>  	A <<def_commit_object,commit object>> contains a (possibly empty) list
> @@ -389,15 +337,7 @@ should not be combined with other pathspec.
>  [[def_refspec]]refspec::
>  	A "refspec" is used by <<def_fetch,fetch>> and
>  	<<def_push,push>> to describe the mapping between remote
> -	<<def_ref,ref>> and local ref. They are combined with a colon in
> -	the format <src>:<dst>, preceded by an optional plus sign, +.
> -	For example: `git fetch $URL
> -	refs/heads/master:refs/heads/origin` means "grab the master
> -	<<def_branch,branch>> <<def_head,head>> 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].
> +	<<def_ref,ref>> and local ref. 
>  
>  [[def_remote_tracking_branch]]remote-tracking branch::
>  	A regular Git <<def_branch,branch>> that is used to follow changes from