Autogenerated HTML docs for v1.4.0-rc2-g5e3a6
[git.git] / git-branch.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 7.0.2" />\r
7 <style type="text/css">\r
8 /* Debug borders */\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10 /*\r
11   border: 1px solid red;\r
12 */\r
13 }\r
14 \r
15 body {\r
16   margin: 1em 5% 1em 5%;\r
17 }\r
18 \r
19 a { color: blue; }\r
20 a:visited { color: fuchsia; }\r
21 \r
22 em {\r
23   font-style: italic;\r
24 }\r
25 \r
26 strong {\r
27   font-weight: bold;\r
28 }\r
29 \r
30 tt {\r
31   color: navy;\r
32 }\r
33 \r
34 h1, h2, h3, h4, h5, h6 {\r
35   color: #527bbd;\r
36   font-family: sans-serif;\r
37   margin-top: 1.2em;\r
38   margin-bottom: 0.5em;\r
39   line-height: 1.3;\r
40 }\r
41 \r
42 h1 {\r
43   border-bottom: 2px solid silver;\r
44 }\r
45 h2 {\r
46   border-bottom: 2px solid silver;\r
47   padding-top: 0.5em;\r
48 }\r
49 \r
50 div.sectionbody {\r
51   font-family: serif;\r
52   margin-left: 0;\r
53 }\r
54 \r
55 hr {\r
56   border: 1px solid silver;\r
57 }\r
58 \r
59 p {\r
60   margin-top: 0.5em;\r
61   margin-bottom: 0.5em;\r
62 }\r
63 \r
64 pre {\r
65   padding: 0;\r
66   margin: 0;\r
67 }\r
68 \r
69 span#author {\r
70   color: #527bbd;\r
71   font-family: sans-serif;\r
72   font-weight: bold;\r
73   font-size: 1.2em;\r
74 }\r
75 span#email {\r
76 }\r
77 span#revision {\r
78   font-family: sans-serif;\r
79 }\r
80 \r
81 div#footer {\r
82   font-family: sans-serif;\r
83   font-size: small;\r
84   border-top: 2px solid silver;\r
85   padding-top: 0.5em;\r
86   margin-top: 4.0em;\r
87 }\r
88 div#footer-text {\r
89   float: left;\r
90   padding-bottom: 0.5em;\r
91 }\r
92 div#footer-badges {\r
93   float: right;\r
94   padding-bottom: 0.5em;\r
95 }\r
96 \r
97 div#preamble,\r
98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
100 div.admonitionblock {\r
101   margin-right: 10%;\r
102   margin-top: 1.5em;\r
103   margin-bottom: 1.5em;\r
104 }\r
105 div.admonitionblock {\r
106   margin-top: 2.5em;\r
107   margin-bottom: 2.5em;\r
108 }\r
109 \r
110 div.content { /* Block element content. */\r
111   padding: 0;\r
112 }\r
113 \r
114 /* Block element titles. */\r
115 div.title, caption.title {\r
116   font-family: sans-serif;\r
117   font-weight: bold;\r
118   text-align: left;\r
119   margin-top: 1.0em;\r
120   margin-bottom: 0.5em;\r
121 }\r
122 div.title + * {\r
123   margin-top: 0;\r
124 }\r
125 \r
126 td div.title:first-child {\r
127   margin-top: 0.0em;\r
128 }\r
129 div.content div.title:first-child {\r
130   margin-top: 0.0em;\r
131 }\r
132 div.content + div.title {\r
133   margin-top: 0.0em;\r
134 }\r
135 \r
136 div.sidebarblock > div.content {\r
137   background: #ffffee;\r
138   border: 1px solid silver;\r
139   padding: 0.5em;\r
140 }\r
141 \r
142 div.listingblock > div.content {\r
143   border: 1px solid silver;\r
144   background: #f4f4f4;\r
145   padding: 0.5em;\r
146 }\r
147 \r
148 div.quoteblock > div.content {\r
149   padding-left: 2.0em;\r
150 }\r
151 div.quoteblock .attribution {\r
152   text-align: right;\r
153 }\r
154 \r
155 div.admonitionblock .icon {\r
156   vertical-align: top;\r
157   font-size: 1.1em;\r
158   font-weight: bold;\r
159   text-decoration: underline;\r
160   color: #527bbd;\r
161   padding-right: 0.5em;\r
162 }\r
163 div.admonitionblock td.content {\r
164   padding-left: 0.5em;\r
165   border-left: 2px solid silver;\r
166 }\r
167 \r
168 div.exampleblock > div.content {\r
169   border-left: 2px solid silver;\r
170   padding: 0.5em;\r
171 }\r
172 \r
173 div.verseblock div.content {\r
174   white-space: pre;\r
175 }\r
176 \r
177 div.imageblock div.content { padding-left: 0; }\r
178 div.imageblock img { border: 1px solid silver; }\r
179 span.image img { border-style: none; }\r
180 \r
181 dl {\r
182   margin-top: 0.8em;\r
183   margin-bottom: 0.8em;\r
184 }\r
185 dt {\r
186   margin-top: 0.5em;\r
187   margin-bottom: 0;\r
188   font-style: italic;\r
189 }\r
190 dd > *:first-child {\r
191   margin-top: 0;\r
192 }\r
193 \r
194 ul, ol {\r
195     list-style-position: outside;\r
196 }\r
197 ol.olist2 {\r
198   list-style-type: lower-alpha;\r
199 }\r
200 \r
201 div.tableblock > table {\r
202   border-color: #527bbd;\r
203   border-width: 3px;\r
204 }\r
205 thead {\r
206   font-family: sans-serif;\r
207   font-weight: bold;\r
208 }\r
209 tfoot {\r
210   font-weight: bold;\r
211 }\r
212 \r
213 div.hlist {\r
214   margin-top: 0.8em;\r
215   margin-bottom: 0.8em;\r
216 }\r
217 td.hlist1 {\r
218   vertical-align: top;\r
219   font-style: italic;\r
220   padding-right: 0.8em;\r
221 }\r
222 td.hlist2 {\r
223   vertical-align: top;\r
224 }\r
225 \r
226 @media print {\r
227   div#footer-badges { display: none; }\r
228 }\r
229 include::./stylesheets/xhtml11-manpage.css[]\r
230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
231 \r
232 div.sidebar-content {\r
233   background: #ffffee;\r
234   border: 1px solid silver;\r
235   padding: 0.5em;\r
236 }\r
237 div.sidebar-title, div.image-title {\r
238   font-family: sans-serif;\r
239   font-weight: bold;\r
240   margin-top: 0.0em;\r
241   margin-bottom: 0.5em;\r
242 }\r
243 \r
244 div.listingblock div.content {\r
245   border: 1px solid silver;\r
246   background: #f4f4f4;\r
247   padding: 0.5em;\r
248 }\r
249 \r
250 div.quoteblock-content {\r
251   padding-left: 2.0em;\r
252 }\r
253 \r
254 div.exampleblock-content {\r
255   border-left: 2px solid silver;\r
256   padding-left: 0.5em;\r
257 }\r
258 </style>\r
259 <title>git-branch(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-branch(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-branch -\r
269    List, create, or delete branches.\r
270 </p>\r
271 </div>\r
272 </div>\r
273 <h2>SYNOPSIS</h2>\r
274 <div class="sectionbody">\r
275 <div class="verseblock">\r
276 <div class="content"><em>git-branch</em> [-r]\r
277 <em>git-branch</em> [-l] [-f] &lt;branchname&gt; [&lt;start-point&gt;]\r
278 <em>git-branch</em> (-d | -D) &lt;branchname&gt;&#8230;</div></div>\r
279 </div>\r
280 <h2>DESCRIPTION</h2>\r
281 <div class="sectionbody">\r
282 <p>With no arguments given (or just <tt>-r</tt>) a list of available branches\r
283 will be shown, the current branch will be highlighted with an asterisk.</p>\r
284 <p>In its second form, a new branch named &lt;branchname&gt; will be created.\r
285 It will start out with a head equal to the one given as &lt;start-point&gt;.\r
286 If no &lt;start-point&gt; is given, the branch will be created with a head\r
287 equal to that of the currently checked out branch.</p>\r
288 <p>With a <tt>-d</tt> or <tt>-D</tt> option, <tt>&lt;branchname&gt;</tt> will be deleted.  You may\r
289 specify more than one branch for deletion.  If the branch currently\r
290 has a ref log then the ref log will also be deleted.</p>\r
291 </div>\r
292 <h2>OPTIONS</h2>\r
293 <div class="sectionbody">\r
294 <dl>\r
295 <dt>\r
296 -d\r
297 </dt>\r
298 <dd>\r
299 <p>\r
300         Delete a branch. The branch must be fully merged.\r
301 </p>\r
302 </dd>\r
303 <dt>\r
304 -D\r
305 </dt>\r
306 <dd>\r
307 <p>\r
308         Delete a branch irrespective of its index status.\r
309 </p>\r
310 </dd>\r
311 <dt>\r
312 -l\r
313 </dt>\r
314 <dd>\r
315 <p>\r
316         Create the branch's ref log.  This activates recording of\r
317         all changes to made the branch ref, enabling use of date\r
318 </p>\r
319 </dd>\r
320 <dt>\r
321 -f\r
322 </dt>\r
323 <dd>\r
324 <p>\r
325         Force the creation of a new branch even if it means deleting\r
326         a branch that already exists with the same name.\r
327 </p>\r
328 </dd>\r
329 <dt>\r
330 -r\r
331 </dt>\r
332 <dd>\r
333 <p>\r
334         List only the "remote" branches.\r
335 </p>\r
336 </dd>\r
337 <dt>\r
338 &lt;branchname&gt;\r
339 </dt>\r
340 <dd>\r
341 <p>\r
342         The name of the branch to create or delete.\r
343         The new branch name must pass all checks defined by\r
344         <a href="git-check-ref-format.html">git-check-ref-format(1)</a>.  Some of these checks\r
345         may restrict the characters allowed in a branch name.\r
346 </p>\r
347 </dd>\r
348 <dt>\r
349 &lt;start-point&gt;\r
350 </dt>\r
351 <dd>\r
352 <p>\r
353         The new branch will be created with a HEAD equal to this.  It may\r
354         be given as a branch name, a commit-id, or a tag.  If this option\r
355         is omitted, the current branch is assumed.\r
356 </p>\r
357 </dd>\r
358 </dl>\r
359 </div>\r
360 <h2>Examples</h2>\r
361 <div class="sectionbody">\r
362 <dl>\r
363 <dt>\r
364 Start development off of a known tag\r
365 </dt>\r
366 <dd>\r
367 <div class="listingblock">\r
368 <div class="content">\r
369 <pre><tt>$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6\r
370 $ cd my2.6\r
371 $ git branch my2.6.14 v2.6.14   <b>(1)</b>\r
372 $ git checkout my2.6.14</tt></pre>\r
373 </div></div>\r
374 <ol>\r
375 <li>\r
376 <p>\r
377 This step and the next one could be combined into a single step with\r
378 "checkout -b my2.6.14 v2.6.14".\r
379 </p>\r
380 </li>\r
381 </ol>\r
382 </dd>\r
383 <dt>\r
384 Delete unneeded branch\r
385 </dt>\r
386 <dd>\r
387 <div class="listingblock">\r
388 <div class="content">\r
389 <pre><tt>$ git clone git://git.kernel.org/.../git.git my.git\r
390 $ cd my.git\r
391 $ git branch -D todo    <b>(1)</b></tt></pre>\r
392 </div></div>\r
393 <ol>\r
394 <li>\r
395 <p>\r
396 delete todo branch even if the "master" branch does not have all\r
397 commits from todo branch.\r
398 </p>\r
399 </li>\r
400 </ol>\r
401 </dd>\r
402 </dl>\r
403 </div>\r
404 <h2>Notes</h2>\r
405 <div class="sectionbody">\r
406 <p>If you are creating a branch that you want to immediately checkout, it's\r
407 easier to use the git checkout command with its <tt>-b</tt> option to create\r
408 a branch and check it out with a single command.</p>\r
409 </div>\r
410 <h2>Author</h2>\r
411 <div class="sectionbody">\r
412 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt; and Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
413 </div>\r
414 <h2>Documentation</h2>\r
415 <div class="sectionbody">\r
416 <p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
417 </div>\r
418 <h2>GIT</h2>\r
419 <div class="sectionbody">\r
420 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
421 </div>\r
422 <div id="footer">\r
423 <div id="footer-text">\r
424 Last updated 04-Jun-2006 07:24:21 UTC\r
425 </div>\r
426 </div>\r
427 </body>\r
428 </html>\r