Google Git
Sign in
chromium / external / gitster / git-htmldocs / 98448e5db4ae52975b912cf54a86a2b06795419c / . / git-symbolic-ref.html
blob: d9d1ebb33f7863d27a4890b4646f9c144d3bed58 [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 Hamano7ccb9fd2006-07-15 01:38:40[diff] [blame]6<meta name="generator" content="AsciiDoc 7.0.2" />
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7<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-symbolic-ref(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-symbolic-ref(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-symbolic-ref -
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]269 Read and modify symbolic refs
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamano16cf1582007-02-05 07:21:48[diff] [blame]275<p><em>git-symbolic-ref</em> [-q] [-m &lt;reason&gt;] &lt;name&gt; [&lt;ref&gt;]</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]276</div>
277<h2>DESCRIPTION</h2>
278<div class="sectionbody">
279<p>Given one argument, reads which branch head the given symbolic
280ref refers to and outputs its path, relative to the <tt>.git/</tt>
281directory. Typically you would give <tt>HEAD</tt> as the &lt;name&gt;
282argument to see on which branch your working tree is on.</p>
283<p>Give two arguments, create or update a symbolic ref &lt;name&gt; to
284point at the given branch &lt;ref&gt;.</p>
Junio C Hamano735a4f72006-12-03 01:53:32[diff] [blame]285<p>A symbolic ref is a regular file that stores a string that
286begins with <tt>ref: refs/</tt>. For example, your <tt>.git/HEAD</tt> is
287a regular file whose contents is <tt>ref: refs/heads/master</tt>.</p>
288</div>
Junio C Hamano97c11c52007-01-16 10:44:47[diff] [blame]289<h2>OPTIONS</h2>
290<div class="sectionbody">
291<dl>
292<dt>
Junio C Hamano7ae0ab22007-11-03 02:46:46[diff] [blame]293-q, --quiet
Junio C Hamano97c11c52007-01-16 10:44:47[diff] [blame]294</dt>
295<dd>
296<p>
297 Do not issue an error message if the &lt;name&gt; is not a
298 symbolic ref but a detached HEAD; instead exit with
299 non-zero status silently.
300</p>
301</dd>
Junio C Hamano16cf1582007-02-05 07:21:48[diff] [blame]302<dt>
303-m
304</dt>
305<dd>
306<p>
307 Update the reflog for &lt;name&gt; with &lt;reason&gt;. This is valid only
308 when creating or updating a symbolic ref.
309</p>
310</dd>
Junio C Hamano97c11c52007-01-16 10:44:47[diff] [blame]311</dl>
312</div>
Junio C Hamano735a4f72006-12-03 01:53:32[diff] [blame]313<h2>NOTES</h2>
314<div class="sectionbody">
315<p>In the past, <tt>.git/HEAD</tt> was a symbolic link pointing at
316<tt>refs/heads/master</tt>. When we wanted to switch to another branch,
317we did <tt>ln -sf refs/heads/newbranch .git/HEAD</tt>, and when we wanted
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]318to find out which branch we are on, we did <tt>readlink .git/HEAD</tt>.
319This was fine, and internally that is what still happens by
320default, but on platforms that do not have working symlinks,
321or that do not have the <tt>readlink(1)</tt> command, this was a bit
322cumbersome. On some platforms, <tt>ln -sf</tt> does not even work as
Junio C Hamano735a4f72006-12-03 01:53:32[diff] [blame]323advertised (horrors). Therefore symbolic links are now deprecated
324and symbolic refs are used by default.</p>
Junio C Hamano97c11c52007-01-16 10:44:47[diff] [blame]325<p>git-symbolic-ref will exit with status 0 if the contents of the
326symbolic ref were printed correctly, with status 1 if the requested
327name is not a symbolic ref, or 128 if another error occurs.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]328</div>
329<h2>Author</h2>
330<div class="sectionbody">
331<p>Written by Junio C Hamano &lt;junkio@cox.net&gt;</p>
332</div>
333<h2>GIT</h2>
334<div class="sectionbody">
335<p>Part of the <a href="git.html">git(7)</a> suite</p>
336</div>
337<div id="footer">
338<div id="footer-text">
Junio C Hamano35738e82008-01-07 07:55:46[diff] [blame]339Last updated 07-Jan-2008 07:50:52 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]340</div>
341</div>
342</body>
343</html>