git-rm: update to saner semantics
[gitweb.git] / Documentation / git-show-ref.txt
index 529ea17c90180f1dd4cbb7df463f0370d512d680..5973a82517f2b64e5575b891a2fcee8ad0664b8a 100644 (file)
@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'git-show-ref' [-q|--quiet] [--verify] [-h|--head] [-d|--dereference]
-            [--tags] [--heads] [--] <pattern>...
+            [-s|--hash] [--abbrev] [--tags] [--heads] [--] <pattern>...
 
 DESCRIPTION
 -----------
@@ -37,15 +37,25 @@ OPTIONS
 
 -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::
+
+       Only show the SHA1 hash, not the reference name. When also using
+       --dereference the dereferenced tag will still be shown after the SHA1.
+
 --verify::
 
        Enable stricter reference checking by requiring an exact ref path.
        Aside from returning an error code of 1, it will also print an error
        message if '--quiet' was not specified.
 
+--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
@@ -72,6 +82,16 @@ $ git show-ref --head --dereference
 ...
 -----------------------------------------------------------------------------
 
+When using --hash (and not --dereference) the output format is: '<SHA-1 ID>'
+
+-----------------------------------------------------------------------------
+$ git show-ref --heads --hash
+2e3ba0114a1f52b47df29743d6915d056be13278
+185008ae97960c8d551adcd9e23565194651b5d1
+03adf42c988195b50e1a1935ba5fcbc39b2b029b
+...
+-----------------------------------------------------------------------------
+
 EXAMPLE
 -------