Google Git
Sign in
chromium / external / gitster / git-htmldocs / a3cfb7673d419cac3d57ad89e67537288d20696f / . / git-check-ref-format.html
blob: efcf3949d9a11c124936c1f4715884e0ac7ca37b [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1<!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 Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7<title>git-check-ref-format(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]30 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]35 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]91}
92span#email {
93}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]137 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]180 text-align: right;
181}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]182
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]211}
212
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]285
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286
287div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]293}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]298 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]299 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]301 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]302}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]303td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]402 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]429 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573git-check-ref-format(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-check-ref-format -
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]578 Ensures that a reference name is well formed
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]584<div class="sectionbody">
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]585<div class="verseblock">
Junio C Hamano58700662011-10-10 23:42:27[diff] [blame]586<div class="verseblock-content"><em>git check-ref-format</em> [--normalize]
587 [--[no-]allow-onelevel] [--refspec-pattern]
588 &lt;refname&gt;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]589<em>git check-ref-format</em> --branch &lt;branchname-shorthand&gt;</div>
590<div class="verseblock-attribution">
591</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]592</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]593<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]594<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]595<div class="paragraph"><p>Checks if a given <em>refname</em> is acceptable, and exits with a non-zero
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]596status if it is not.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]597<div class="paragraph"><p>A reference is used in git to specify branches and tags. A
Junio C Hamano360e3a12011-07-13 23:51:56[diff] [blame]598branch head is stored in the <tt>refs/heads</tt> hierarchy, while
599a tag is stored in the <tt>refs/tags</tt> hierarchy of the ref namespace
600(typically in <tt>$GIT_DIR/refs/heads</tt> and <tt>$GIT_DIR/refs/tags</tt>
601directories or, as entries in file <tt>$GIT_DIR/packed-refs</tt>
602if refs are packed by <tt>git gc</tt>).</p></div>
603<div class="paragraph"><p>git imposes the following rules on how references are named:</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]604<div class="olist arabic"><ol class="arabic">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]605<li>
606<p>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]607They can include slash <tt>/</tt> for hierarchical (directory)
Junio C Hamano33db4372006-06-07 19:51:45[diff] [blame]608 grouping, but no slash-separated component can begin with a
Junio C Hamano58700662011-10-10 23:42:27[diff] [blame]609 dot <tt>.</tt> or end with the sequence <tt>.lock</tt>.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]610</p>
611</li>
612<li>
613<p>
Junio C Hamano8679a792009-05-13 20:50:32[diff] [blame]614They must contain at least one <tt>/</tt>. This enforces the presence of a
615 category like <tt>heads/</tt>, <tt>tags/</tt> etc. but the actual names are not
Junio C Hamano58700662011-10-10 23:42:27[diff] [blame]616 restricted. If the <tt>--allow-onelevel</tt> option is used, this rule
617 is waived.
Junio C Hamano8679a792009-05-13 20:50:32[diff] [blame]618</p>
619</li>
620<li>
621<p>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]622They cannot have two consecutive dots <tt>..</tt> anywhere.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]623</p>
624</li>
625<li>
626<p>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]627They cannot have ASCII control characters (i.e. bytes whose
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]628 values are lower than \040, or \177 <tt>DEL</tt>), space, tilde <tt>~</tt>,
Junio C Hamanob76a6862012-05-02 22:02:46[diff] [blame]629 caret <tt>^</tt>, or colon <tt>:</tt> anywhere.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]630</p>
631</li>
632<li>
633<p>
Junio C Hamanob76a6862012-05-02 22:02:46[diff] [blame]634They cannot have question-mark <tt>?</tt>, asterisk <tt>*</tt>, or open
Junio C Hamano58700662011-10-10 23:42:27[diff] [blame]635 bracket <tt>[</tt> anywhere. See the <tt>--refspec-pattern</tt> option below for
636 an exception to this rule.
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]637</p>
638</li>
639<li>
640<p>
Junio C Hamano58700662011-10-10 23:42:27[diff] [blame]641They cannot begin or end with a slash <tt>/</tt> or contain multiple
642 consecutive slashes (see the <tt>--normalize</tt> option below for an
643 exception to this rule)
644</p>
645</li>
646<li>
647<p>
648They cannot end with a dot <tt>.</tt>.
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]649</p>
650</li>
651<li>
652<p>
653They cannot contain a sequence <tt>@{</tt>.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]654</p>
Junio C Hamanoe7c7be32010-02-10 23:26:48[diff] [blame]655</li>
Junio C Hamano7ae18252009-05-23 09:53:32[diff] [blame]656<li>
657<p>
Junio C Hamanodca34822010-02-13 01:02:52[diff] [blame]658They cannot contain a <tt>\</tt>.
Junio C Hamano7ae18252009-05-23 09:53:32[diff] [blame]659</p>
660</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]661</ol></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]662<div class="paragraph"><p>These rules make it easy for shell script based tools to parse
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]663reference names, pathname expansion by the shell when a reference name is used
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]664unquoted (by mistake), and also avoids ambiguities in certain
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]665reference name expressions (see <a href="gitrevisions.html">gitrevisions(7)</a>):</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]666<div class="olist arabic"><ol class="arabic">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]667<li>
668<p>
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]669A double-dot <tt>..</tt> is often used as in <tt>ref1..ref2</tt>, and in some
Junio C Hamanob76a6862012-05-02 22:02:46[diff] [blame]670 contexts this notation means <tt>^ref1 ref2</tt> (i.e. not in
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]671 <tt>ref1</tt> and in <tt>ref2</tt>).
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]672</p>
673</li>
674<li>
675<p>
Junio C Hamanob76a6862012-05-02 22:02:46[diff] [blame]676A tilde <tt>~</tt> and caret <tt>^</tt> are used to introduce the postfix
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]677 <em>nth parent</em> and <em>peel onion</em> operation.
678</p>
679</li>
680<li>
681<p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]682A colon <tt>:</tt> is used as in <tt>srcref:dstref</tt> to mean "use srcref&#8217;s
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]683 value and store it in dstref" in fetch and push operations.
Junio C Hamanob2f5edd2006-05-21 10:50:09[diff] [blame]684 It may also be used to select a specific object such as with
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]685 <em>git cat-file</em>: "git cat-file blob v1.3.3:refs.c".
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]686</p>
687</li>
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]688<li>
689<p>
690at-open-brace <tt>@{</tt> is used as a notation to access a reflog entry.
691</p>
692</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]693</ol></div>
Junio C Hamanob76a6862012-05-02 22:02:46[diff] [blame]694<div class="paragraph"><p>With the <tt>--branch</tt> option, it expands the <tt>`previous branch syntax''
695`@{-n}</tt>. For example, <tt>@{-1}</tt> is a way to refer the last branch you
Junio C Hamano3d23a0a2009-10-19 08:04:30[diff] [blame]696were on. This option should be used by porcelains to accept this
697syntax anywhere a branch name is expected, so they can act as if you
698typed the branch name.</p></div>
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]699</div>
Junio C Hamano58700662011-10-10 23:42:27[diff] [blame]700<h2 id="_options">OPTIONS</h2>
701<div class="sectionbody">
702<div class="dlist"><dl>
703<dt class="hdlist1">
704--allow-onelevel
705</dt>
706<dt class="hdlist1">
707--no-allow-onelevel
708</dt>
709<dd>
710<p>
711 Controls whether one-level refnames are accepted (i.e.,
712 refnames that do not contain multiple <tt>/</tt>-separated
713 components). The default is <tt>--no-allow-onelevel</tt>.
714</p>
715</dd>
716<dt class="hdlist1">
717--refspec-pattern
718</dt>
719<dd>
720<p>
721 Interpret &lt;refname&gt; as a reference name pattern for a refspec
722 (as used with remote repositories). If this option is
Junio C Hamanob76a6862012-05-02 22:02:46[diff] [blame]723 enabled, &lt;refname&gt; is allowed to contain a single <tt>*</tt>
Junio C Hamano58700662011-10-10 23:42:27[diff] [blame]724 in place of a one full pathname component (e.g.,
Junio C Hamanob76a6862012-05-02 22:02:46[diff] [blame]725 <tt>foo/*/bar</tt> but not <tt>foo/bar*</tt>).
Junio C Hamano58700662011-10-10 23:42:27[diff] [blame]726</p>
727</dd>
728<dt class="hdlist1">
729--normalize
730</dt>
731<dd>
732<p>
733 Normalize <em>refname</em> by removing any leading slash (<tt>/</tt>)
734 characters and collapsing runs of adjacent slashes between
735 name components into a single slash. Iff the normalized
736 refname is valid then print it to standard output and exit
737 with a status of 0. (<tt>--print</tt> is a deprecated way to spell
738 <tt>--normalize</tt>.)
739</p>
740</dd>
741</dl></div>
742</div>
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]743<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]744<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]745<div class="ulist"><ul>
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]746<li>
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]747<p>
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]748Print the name of the previous branch:
Junio C Hamano5f9a6f02009-04-06 08:26:56[diff] [blame]749</p>
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]750<div class="listingblock">
751<div class="content">
752<pre><tt>$ git check-ref-format --branch @{-1}</tt></pre>
753</div></div>
754</li>
755<li>
756<p>
757Determine the reference name to use for a new branch:
758</p>
759<div class="listingblock">
760<div class="content">
Junio C Hamano58700662011-10-10 23:42:27[diff] [blame]761<pre><tt>$ ref=$(git check-ref-format --normalize "refs/heads/$newbranch") ||
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]762die "we do not like '$newbranch' as a branch name."</tt></pre>
763</div></div>
764</li>
765</ul></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]766</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]767<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]768<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]769<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]770</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]771</div>
772<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]773<div id="footer">
774<div id="footer-text">
Junio C Hamanob76a6862012-05-02 22:02:46[diff] [blame]775Last updated 2012-05-02 15:00:44 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]776</div>
777</div>
778</body>
779</html>