summaryrefslogtreecommitdiff
path: root/Documentation/git-show-ref.txt
diff options
context:
space:
mode:
authorJulian Phillips <julian@quantumfyre.co.uk>2007-04-09 20:57:36 (GMT)
committerJunio C Hamano <junkio@cox.net>2007-04-10 01:54:52 (GMT)
commit8bd26c4a2f7539f6418934858710c674bb139cdd (patch)
tree769f9ae21a9a6fd9c4e1a345db471f4a3fe5a810 /Documentation/git-show-ref.txt
parentfc1f458c3506ea3f76a328f10b4008c45af32c4b (diff)
downloadgit-8bd26c4a2f7539f6418934858710c674bb139cdd.zip
git-8bd26c4a2f7539f6418934858710c674bb139cdd.tar.gz
git-8bd26c4a2f7539f6418934858710c674bb139cdd.tar.bz2
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>
Diffstat (limited to 'Documentation/git-show-ref.txt')
-rw-r--r--Documentation/git-show-ref.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index 5973a82..2355aa5 100644
--- 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>...
+'git-show-ref' --exclude-existing[=pattern]
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.
+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.
@@ -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.
+--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.