X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=sidebyside;f=Documentation%2Fgit-show-ref.txt;h=6b99529b6bb659ec1e1ffd741208ef03762c0356;hb=c30e699fc509f43f459c17d3148e7d866fb9157a;hp=5973a82517f2b64e5575b891a2fcee8ad0664b8a;hpb=460ca302fdf453459850676c049ed7b46b43a0d4;p=git.git diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt index 5973a8251..6b99529b6 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] [--] ... +'git-show-ref' --exclude-existing[=pattern] DESCRIPTION ----------- @@ -19,28 +20,35 @@ 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. OPTIONS ------- --h, --head:: +-h:: +--head:: Show the HEAD reference. ---tags, --heads:: +--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. --d, --dereference:: +-d:: +--dereference:: Dereference tags into object IDs as well. They will be shown with "^{}" appended. --s, --hash:: +-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. @@ -51,16 +59,31 @@ OPTIONS Aside from returning an error code of 1, it will also print an error message if '--quiet' was not specified. ---abbrev, --abbrev=len:: +--abbrev:: +--abbrev=len:: Abbreviate the object name. When using `--hash`, you do not have to say `--hash --abbrev`; `--hash=len` would do. --q, --quiet:: +-q:: +--quiet:: 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 "^(?:\s)?(?:\^\{\})?$" 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. + + :: Show references matching one or more patterns. @@ -114,7 +137,7 @@ When using the '--verify' flag, the command requires an exact path: will only match the exact branch called "master". -If nothing matches, gitlink:git-show-ref[1] will return an error code of 1, +If nothing matches, linkgit:git-show-ref[1] will return an error code of 1, and in the case of verification, it will show an error message. For scripting, you can ask it to be quiet with the "--quiet" flag, which @@ -144,7 +167,7 @@ to get a listing of all tags together with what they dereference. SEE ALSO -------- -gitlink:git-ls-remote[1], gitlink:git-peek-remote[1] +linkgit:git-ls-remote[1] AUTHORS ------- @@ -153,4 +176,4 @@ Man page by Jonas Fonseca . GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[1] suite