Documentation: show-ref: document --exclude-existing

Use the comment in the code to document the --exclude-existing
function to git-show-ref.

Signed-off-by: Julian Phillips <julian@quantumfyre.co.uk>
Signed-off-by: Junio C Hamano <junkio@cox.net>

diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index 5973a82517f2b64e5575b891a2fcee8ad0664b8a..2355aa5e86d21766bbde61e3188e1c9539738150 100644 (file)
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -10,6 +10,7 @@ SYNOPSIS
 [verse]
 'git-show-ref' [-q|--quiet] [--verify] [-h|--head] [-d|--dereference]
             [-s|--hash] [--abbrev] [--tags] [--heads] [--] <pattern>...
 [verse]
 'git-show-ref' [-q|--quiet] [--verify] [-h|--head] [-d|--dereference]
             [-s|--hash] [--abbrev] [--tags] [--heads] [--] <pattern>...

+'git-show-ref' --exclude-existing[=pattern]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -19,6 +20,9 @@ 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.
 
 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.
 
 Use of this utility is encouraged in favor of directly accessing files under
 in the `.git` directory.
 


@@ -61,6 +65,18 @@ OPTIONS
        Do not print any results to stdout. When combined with '--verify' this
        can be used to silently check if a reference exists.
 
        Do not print any results to stdout. When combined with '--verify' this
        can be used to silently check if a reference exists.
 

+--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.
 <pattern>::
 
        Show references matching one or more patterns.