]>
Commit | Line | Data |
---|---|---|
c0990ff3 JF |
1 | git-show-ref(1) |
2 | =============== | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-show-ref - List references in a local repository | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
e62b3935 | 11 | 'git show-ref' [-q|--quiet] [--verify] [--head] [-d|--dereference] |
69932bc6 | 12 | [-s|--hash[=<n>]] [--abbrev[=<n>]] [--tags] |
4318d3ba | 13 | [--heads] [--] [<pattern>...] |
33e8fc87 | 14 | 'git show-ref' --exclude-existing[=<pattern>] |
c0990ff3 JF |
15 | |
16 | DESCRIPTION | |
17 | ----------- | |
18 | ||
19 | Displays references available in a local repository along with the associated | |
20 | commit IDs. Results can be filtered using a pattern and tags can be | |
21 | dereferenced into object IDs. Additionally, it can be used to test whether a | |
22 | particular ref exists. | |
23 | ||
3f3d0cea DB |
24 | By default, shows the tags, heads, and remote refs. |
25 | ||
33e8fc87 JH |
26 | The --exclude-existing form is a filter that does the inverse. It reads |
27 | refs from stdin, one ref per line, and shows those that don't exist in | |
28 | the local repository. | |
8bd26c4a | 29 | |
c0990ff3 | 30 | Use of this utility is encouraged in favor of directly accessing files under |
d4900ee4 | 31 | the `.git` directory. |
c0990ff3 JF |
32 | |
33 | OPTIONS | |
34 | ------- | |
35 | ||
3240240f | 36 | --head:: |
c0990ff3 | 37 | |
3f3d0cea | 38 | Show the HEAD reference, even if it would normally be filtered out. |
c0990ff3 | 39 | |
3240240f SB |
40 | --tags:: |
41 | --heads:: | |
c0990ff3 | 42 | |
3f3d0cea DB |
43 | Limit to "refs/heads" and "refs/tags", respectively. These options |
44 | are not mutually exclusive; when given both, references stored in | |
45 | "refs/heads" and "refs/tags" are displayed. | |
c0990ff3 | 46 | |
3240240f SB |
47 | -d:: |
48 | --dereference:: | |
c0990ff3 | 49 | |
6ab26080 | 50 | Dereference tags into object IDs as well. They will be shown with "{caret}{}" |
c0990ff3 JF |
51 | appended. |
52 | ||
3240240f | 53 | -s:: |
69932bc6 | 54 | --hash[=<n>]:: |
9581e0fc | 55 | |
d5fa1f1a TA |
56 | Only show the SHA-1 hash, not the reference name. When combined with |
57 | --dereference the dereferenced tag will still be shown after the SHA-1. | |
9581e0fc | 58 | |
c0990ff3 JF |
59 | --verify:: |
60 | ||
61 | Enable stricter reference checking by requiring an exact ref path. | |
62 | Aside from returning an error code of 1, it will also print an error | |
bcf9626a | 63 | message if `--quiet` was not specified. |
c0990ff3 | 64 | |
69932bc6 | 65 | --abbrev[=<n>]:: |
2eaf2224 JH |
66 | |
67 | Abbreviate the object name. When using `--hash`, you do | |
69932bc6 | 68 | not have to say `--hash --abbrev`; `--hash=n` would do. |
2eaf2224 | 69 | |
3240240f SB |
70 | -q:: |
71 | --quiet:: | |
c0990ff3 | 72 | |
bcf9626a | 73 | Do not print any results to stdout. When combined with `--verify` this |
c0990ff3 JF |
74 | can be used to silently check if a reference exists. |
75 | ||
69932bc6 | 76 | --exclude-existing[=<pattern>]:: |
8bd26c4a | 77 | |
0b444cdb | 78 | Make 'git show-ref' act as a filter that reads refs from stdin of the |
6cf378f0 | 79 | form "`^(?:<anything>\s)?<refname>(?:\^{})?$`" |
f1005987 | 80 | and performs the following actions on each: |
6ab26080 | 81 | (1) strip "{caret}{}" at the end of line if any; |
8bd26c4a JP |
82 | (2) ignore if pattern is provided and does not head-match refname; |
83 | (3) warn if refname is not a well-formed refname and skip; | |
84 | (4) ignore if refname is a ref that exists in the local repository; | |
85 | (5) otherwise output the line. | |
86 | ||
87 | ||
f448e24e | 88 | <pattern>...:: |
c0990ff3 | 89 | |
9fbd8986 MG |
90 | Show references matching one or more patterns. Patterns are matched from |
91 | the end of the full name, and only complete parts are matched, e.g. | |
92 | 'master' matches 'refs/heads/master', 'refs/remotes/origin/master', | |
a58088ab | 93 | 'refs/tags/jedi/master' but not 'refs/heads/mymaster' or |
9fbd8986 | 94 | 'refs/remotes/master/jedi'. |
c0990ff3 JF |
95 | |
96 | OUTPUT | |
97 | ------ | |
98 | ||
99 | The output is in the format: '<SHA-1 ID>' '<space>' '<reference name>'. | |
100 | ||
101 | ----------------------------------------------------------------------------- | |
102 | $ git show-ref --head --dereference | |
103 | 832e76a9899f560a90ffd62ae2ce83bbeff58f54 HEAD | |
104 | 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/master | |
105 | 832e76a9899f560a90ffd62ae2ce83bbeff58f54 refs/heads/origin | |
106 | 3521017556c5de4159da4615a39fa4d5d2c279b5 refs/tags/v0.99.9c | |
107 | 6ddc0964034342519a87fe013781abf31c6db6ad refs/tags/v0.99.9c^{} | |
108 | 055e4ae3ae6eb344cbabf2a5256a49ea66040131 refs/tags/v1.0rc4 | |
109 | 423325a2d24638ddcc82ce47be5e40be550f4507 refs/tags/v1.0rc4^{} | |
110 | ... | |
111 | ----------------------------------------------------------------------------- | |
112 | ||
9581e0fc CC |
113 | When using --hash (and not --dereference) the output format is: '<SHA-1 ID>' |
114 | ||
115 | ----------------------------------------------------------------------------- | |
116 | $ git show-ref --heads --hash | |
117 | 2e3ba0114a1f52b47df29743d6915d056be13278 | |
118 | 185008ae97960c8d551adcd9e23565194651b5d1 | |
119 | 03adf42c988195b50e1a1935ba5fcbc39b2b029b | |
120 | ... | |
121 | ----------------------------------------------------------------------------- | |
122 | ||
c0990ff3 JF |
123 | EXAMPLE |
124 | ------- | |
125 | ||
126 | To show all references called "master", whether tags or heads or anything | |
127 | else, and regardless of how deep in the reference naming hierarchy they are, | |
128 | use: | |
129 | ||
130 | ----------------------------------------------------------------------------- | |
131 | git show-ref master | |
132 | ----------------------------------------------------------------------------- | |
133 | ||
134 | This will show "refs/heads/master" but also "refs/remote/other-repo/master", | |
135 | if such references exists. | |
136 | ||
bcf9626a | 137 | When using the `--verify` flag, the command requires an exact path: |
c0990ff3 JF |
138 | |
139 | ----------------------------------------------------------------------------- | |
140 | git show-ref --verify refs/heads/master | |
141 | ----------------------------------------------------------------------------- | |
142 | ||
143 | will only match the exact branch called "master". | |
144 | ||
0b444cdb | 145 | If nothing matches, 'git show-ref' will return an error code of 1, |
c0990ff3 JF |
146 | and in the case of verification, it will show an error message. |
147 | ||
148 | For scripting, you can ask it to be quiet with the "--quiet" flag, which | |
149 | allows you to do things like | |
150 | ||
151 | ----------------------------------------------------------------------------- | |
b1889c36 | 152 | git show-ref --quiet --verify -- "refs/heads/$headname" || |
c0990ff3 JF |
153 | echo "$headname is not a valid branch" |
154 | ----------------------------------------------------------------------------- | |
155 | ||
156 | to check whether a particular branch exists or not (notice how we don't | |
157 | actually want to show any results, and we want to use the full refname for it | |
158 | in order to not trigger the problem with ambiguous partial matches). | |
159 | ||
160 | To show only tags, or only proper branch heads, use "--tags" and/or "--heads" | |
161 | respectively (using both means that it shows tags and heads, but not other | |
162 | random references under the refs/ subdirectory). | |
163 | ||
164 | To do automatic tag object dereferencing, use the "-d" or "--dereference" | |
165 | flag, so you can do | |
166 | ||
167 | ----------------------------------------------------------------------------- | |
168 | git show-ref --tags --dereference | |
169 | ----------------------------------------------------------------------------- | |
170 | ||
171 | to get a listing of all tags together with what they dereference. | |
172 | ||
977ed83a JN |
173 | FILES |
174 | ----- | |
175 | `.git/refs/*`, `.git/packed-refs` | |
176 | ||
c0990ff3 JF |
177 | SEE ALSO |
178 | -------- | |
f21e1c5d | 179 | linkgit:git-for-each-ref[1], |
977ed83a JN |
180 | linkgit:git-ls-remote[1], |
181 | linkgit:git-update-ref[1], | |
182 | linkgit:gitrepository-layout[5] | |
c0990ff3 | 183 | |
c0990ff3 JF |
184 | GIT |
185 | --- | |
9e1f0a85 | 186 | Part of the linkgit:git[1] suite |