"git prune" is safe
[gitweb.git] / Documentation / git-show-ref.txt
index fcee0008a9d868bb27c9eacbcfe72a3a3f8ed60f..b0a309b117bd12170ccd9194d1cf5083d5675365 100644 (file)
@@ -21,6 +21,8 @@ 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.
 
+By default, shows the tags, heads, and remote refs.
+
 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.
 
@@ -32,14 +34,14 @@ OPTIONS
 
 --head::
 
-       Show the HEAD reference.
+       Show the HEAD reference, even if it would normally be filtered out.
 
 --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.
+       Limit to "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::
@@ -50,8 +52,8 @@ OPTIONS
 -s::
 --hash[=<n>]::
 
-       Only show the SHA1 hash, not the reference name. When combined with
-       --dereference the dereferenced tag will still be shown after the SHA1.
+       Only show the SHA-1 hash, not the reference name. When combined with
+       --dereference the dereferenced tag will still be shown after the SHA-1.
 
 --verify::
 
@@ -73,7 +75,7 @@ OPTIONS
 --exclude-existing[=<pattern>]::
 
        Make 'git show-ref' act as a filter that reads refs from stdin of the
-       form "`{caret}(?:<anything>\s)?<refname>(?:{backslash}{caret}{})?$`"
+       form "`^(?:<anything>\s)?<refname>(?:\^{})?$`"
        and performs the following actions on each:
        (1) strip "{caret}{}" at the end of line if any;
        (2) ignore if pattern is provided and does not head-match refname;