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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Thomas Ackermann <th.acker@xxxxxxxx> writes:

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

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
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]