blob: 1798f8d94d68942d1385000334894af3cb401c81 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano01078922006-03-10 00:31:476<meta name="generator" content="AsciiDoc 7.0.2" />
Junio C Hamano1a4e8412005-12-27 08:17:237<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git-check-ref-format(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-check-ref-format(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-check-ref-format -
Junio C Hamano01078922006-03-10 00:31:47269 Make sure ref name is well formed
Junio C Hamano1a4e8412005-12-27 08:17:23270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
275<p><em>git-check-ref-format</em> &lt;refname&gt;</p>
276</div>
277<h2>DESCRIPTION</h2>
278<div class="sectionbody">
279<p>Checks if a given <em>refname</em> is acceptable, and exits non-zero if
280it is not.</p>
281<p>A reference is used in git to specify branches and tags. A
282branch head is stored under <tt>$GIT_DIR/refs/heads</tt> directory, and
283a tag is stored under <tt>$GIT_DIR/refs/tags</tt> directory. git
284imposes the following rules on how refs are named:</p>
285<ol>
286<li>
287<p>
288It could be named hierarchically (i.e. separated with slash
289 <tt>/</tt>), but each of its component cannot begin with a dot <tt>.</tt>;
290</p>
291</li>
292<li>
293<p>
294It cannot have two consecutive dots <tt>..</tt> anywhere;
295</p>
296</li>
297<li>
298<p>
299It cannot have ASCII control character (i.e. bytes whose
300 values are lower than \040, or \177 <tt>DEL</tt>), space, tilde <tt>~</tt>,
301 caret <tt>^</tt>, colon <tt>:</tt>, question-mark <tt>?</tt>, asterisk <tt>*</tt>,
302 or open bracket <tt>[</tt> anywhere;
303</p>
304</li>
305<li>
306<p>
307It cannot end with a slash <tt>/</tt>.
308</p>
309</li>
310</ol>
311<p>These rules makes it easy for shell script based tools to parse
312refnames, pathname expansion by the shell when a refname is used
313unquoted (by mistake), and also avoids ambiguities in certain
314refname expressions (see <a href="git-rev-parse.html">git-rev-parse(1)</a>). Namely:</p>
315<ol>
316<li>
317<p>
318double-dot <tt>..</tt> are often used as in <tt>ref1..ref2</tt>, and in some
319 context this notation means <tt>^ref1 ref2</tt> (i.e. not in
320 ref1 and in ref2).
321</p>
322</li>
323<li>
324<p>
325tilde <tt>~</tt> and caret <tt>^</tt> are used to introduce postfix
326 <em>nth parent</em> and <em>peel onion</em> operation.
327</p>
328</li>
329<li>
330<p>
331colon <tt>:</tt> is used as in <tt>srcref:dstref</tt> to mean "use srcref's
332 value and store it in dstref" in fetch and push operations.
333</p>
334</li>
335</ol>
336</div>
337<h2>GIT</h2>
338<div class="sectionbody">
339<p>Part of the <a href="git.html">git(7)</a> suite</p>
340</div>
341<div id="footer">
342<div id="footer-text">
Junio C Hamano01078922006-03-10 00:31:47343Last updated 10-Mar-2006 00:31:21 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23344</div>
345</div>
346</body>
347</html>