X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-show-ref.txt;h=2f173fff356282df7c906da6edeac1fcd4430025;hb=713697b34f1a1f716df97e331fd82782338c2083;hp=b724d832c8bef16c46bc7955cdbe7033d713e4a7;hpb=194db7e3bbab9669c511133549e6ae74481c9a4f;p=git.git

diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index b724d832c..2f173fff3 100644
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -8,8 +8,9 @@ git-show-ref - List references in a local repository
 SYNOPSIS
 --------
 [verse]
-'git-show-ref' [-q|--quiet] [--verify] [-h|--head] [-d|--dereference]
-	     [-s|--hash] [--tags] [--heads] [--] <pattern>...
+'git show-ref' [-q|--quiet] [--verify] [-h|--head] [-d|--dereference]
+	     [-s|--hash] [--abbrev] [--tags] [--heads] [--] <pattern>...
+'git show-ref' --exclude-existing[=pattern]
 
 DESCRIPTION
 -----------
@@ -19,32 +20,38 @@ commit IDs. Results can be filtered using a pattern and tags can be
 dereferenced into object IDs. Additionally, it can be used to test whether a
 particular ref exists.
 
+The --exclude-existing form is a filter that does the inverse, it shows the
+refs from stdin that don't exist in the local repository.
+
 Use of this utility is encouraged in favor of directly accessing files under
 in the `.git` directory.
 
 OPTIONS
 -------
 
--h, --head::
+-h::
+--head::
 
 	Show the HEAD reference.
 
---tags, --heads::
+--tags::
+--heads::
 
 	Limit to only "refs/heads" and "refs/tags", respectively.  These
 	options are not mutually exclusive; when given both, references stored
 	in "refs/heads" and "refs/tags" are displayed.
 
--d, --dereference::
+-d::
+--dereference::
 
-	Dereference tags into object IDs. They will be shown with "^{}"
+	Dereference tags into object IDs as well. They will be shown with "^{}"
 	appended.
 
--s, --hash::
+-s::
+--hash::
 
 	Only show the SHA1 hash, not the reference name. When also using
-	--dereference the dereferenced tag will still be shown after the SHA1,
-	this maybe a bug.
+	--dereference the dereferenced tag will still be shown after the SHA1.
 
 --verify::
 
@@ -52,12 +59,32 @@ OPTIONS
 	Aside from returning an error code of 1, it will also print an error
 	message if '--quiet' was not specified.
 
--q, --quiet::
+--abbrev::
+--abbrev=len::
+
+	Abbreviate the object name.  When using `--hash`, you do
+	not have to say `--hash --abbrev`; `--hash=len` would do.
+
+-q::
+--quiet::
 
 	Do not print any results to stdout. When combined with '--verify' this
 	can be used to silently check if a reference exists.
 
-<pattern>::
+--exclude-existing::
+--exclude-existing=pattern::
+
+	Make 'git-show-ref' act as a filter that reads refs from stdin of the
+	form "^(?:<anything>\s)?<refname>(?:\^\{\})?$" and performs the
+	following actions on each:
+	(1) strip "^{}" at the end of line if any;
+	(2) ignore if pattern is provided and does not head-match refname;
+	(3) warn if refname is not a well-formed refname and skip;
+	(4) ignore if refname is a ref that exists in the local repository;
+	(5) otherwise output the line.
+
+
+<pattern>...::
 
 	Show references matching one or more patterns.
 
@@ -110,14 +137,14 @@ When using the '--verify' flag, the command requires an exact path:
 
 will only match the exact branch called "master".
 
-If nothing matches, gitlink:git-show-ref[1] will return an error code of 1,
+If nothing matches, 'git-show-ref' will return an error code of 1,
 and in the case of verification, it will show an error message.
 
 For scripting, you can ask it to be quiet with the "--quiet" flag, which
 allows you to do things like
 
 -----------------------------------------------------------------------------
-	git-show-ref --quiet --verify -- "refs/heads/$headname" ||
+	git show-ref --quiet --verify -- "refs/heads/$headname" ||
 		echo "$headname is not a valid branch"
 -----------------------------------------------------------------------------
 
@@ -140,7 +167,7 @@ to get a listing of all tags together with what they dereference.
 
 SEE ALSO
 --------
-gitlink:git-ls-remote[1], gitlink:git-peek-remote[1]
+linkgit:git-ls-remote[1]
 
 AUTHORS
 -------
@@ -149,4 +176,4 @@ Man page by Jonas Fonseca <fonseca@diku.dk>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[1] suite