Skip to content

Commit

Permalink
Documentation: show-ref: document --exclude-existing
Browse files Browse the repository at this point in the history
Use the comment in the code to document the --exclude-existing
function to git-show-ref.

Signed-off-by: Julian Phillips <[email protected]>
Signed-off-by: Junio C Hamano <[email protected]>
  • Loading branch information
qur authored and Junio C Hamano committed Apr 10, 2007
1 parent fc1f458 commit 8bd26c4
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Documentation/git-show-ref.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand All @@ -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.

Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 8bd26c4

Please sign in to comment.