Autogenerated HTML docs for v1.7.7-325-g05f6ed
[git/jnareb-git.git] / git-branch.html
blobad374379cf1f626d1ade99423d0eb14597b0edf3
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" />
6 <meta name="generator" content="AsciiDoc 8.5.2" />
7 <title>git-branch(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, 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;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#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;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.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;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
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;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#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;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
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.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
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);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
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);
491 iterate(i);
495 iterate(el);
496 return result;
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);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: 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;
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>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 git-branch(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-branch -
578 List, create, or delete branches
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git branch</em> [--color[=&lt;when&gt;] | --no-color] [-r | -a]
587 [--list] [-v [--abbrev=&lt;length&gt; | --no-abbrev]]
588 [(--merged | --no-merged | --contains) [&lt;commit&gt;]] [&lt;pattern&gt;&#8230;]
589 <em>git branch</em> [--set-upstream | --track | --no-track] [-l] [-f] &lt;branchname&gt; [&lt;start-point&gt;]
590 <em>git branch</em> (-m | -M) [&lt;oldbranch&gt;] &lt;newbranch&gt;
591 <em>git branch</em> (-d | -D) [-r] &lt;branchname&gt;&#8230;</div>
592 <div class="verseblock-attribution">
593 </div></div>
594 </div>
595 <h2 id="_description">DESCRIPTION</h2>
596 <div class="sectionbody">
597 <div class="paragraph"><p>With no arguments, existing branches are listed and the current branch will
598 be highlighted with an asterisk. Option <tt>-r</tt> causes the remote-tracking
599 branches to be listed, and option <tt>-a</tt> shows both. This list mode is also
600 activated by the <tt>--list</tt> option (see below).
601 &lt;pattern&gt; restricts the output to matching branches, the pattern is a shell
602 wildcard (i.e., matched using fnmatch(3))
603 Multiple patterns may be given; if any of them matches, the tag is shown.</p></div>
604 <div class="paragraph"><p>With <tt>--contains</tt>, shows only the branches that contain the named commit
605 (in other words, the branches whose tip commits are descendants of the
606 named commit). With <tt>--merged</tt>, only branches merged into the named
607 commit (i.e. the branches whose tip commits are reachable from the named
608 commit) will be listed. With <tt>--no-merged</tt> only branches not merged into
609 the named commit will be listed. If the &lt;commit&gt; argument is missing it
610 defaults to <em>HEAD</em> (i.e. the tip of the current branch).</p></div>
611 <div class="paragraph"><p>The command&#8217;s second form creates a new branch head named &lt;branchname&gt;
612 which points to the current <em>HEAD</em>, or &lt;start-point&gt; if given.</p></div>
613 <div class="paragraph"><p>Note that this will create the new branch, but it will not switch the
614 working tree to it; use "git checkout &lt;newbranch&gt;" to switch to the
615 new branch.</p></div>
616 <div class="paragraph"><p>When a local branch is started off a remote-tracking branch, git sets up the
617 branch so that <em>git pull</em> will appropriately merge from
618 the remote-tracking branch. This behavior may be changed via the global
619 <tt>branch.autosetupmerge</tt> configuration flag. That setting can be
620 overridden by using the <tt>--track</tt> and <tt>--no-track</tt> options, and
621 changed later using <tt>git branch --set-upstream</tt>.</p></div>
622 <div class="paragraph"><p>With a <em>-m</em> or <em>-M</em> option, &lt;oldbranch&gt; will be renamed to &lt;newbranch&gt;.
623 If &lt;oldbranch&gt; had a corresponding reflog, it is renamed to match
624 &lt;newbranch&gt;, and a reflog entry is created to remember the branch
625 renaming. If &lt;newbranch&gt; exists, -M must be used to force the rename
626 to happen.</p></div>
627 <div class="paragraph"><p>With a <tt>-d</tt> or <tt>-D</tt> option, <tt>&lt;branchname&gt;</tt> will be deleted. You may
628 specify more than one branch for deletion. If the branch currently
629 has a reflog then the reflog will also be deleted.</p></div>
630 <div class="paragraph"><p>Use -r together with -d to delete remote-tracking branches. Note, that it
631 only makes sense to delete remote-tracking branches if they no longer exist
632 in the remote repository or if <em>git fetch</em> was configured not to fetch
633 them again. See also the <em>prune</em> subcommand of <a href="git-remote.html">git-remote(1)</a> for a
634 way to clean up all obsolete remote-tracking branches.</p></div>
635 </div>
636 <h2 id="_options">OPTIONS</h2>
637 <div class="sectionbody">
638 <div class="dlist"><dl>
639 <dt class="hdlist1">
641 </dt>
642 <dt class="hdlist1">
643 --delete
644 </dt>
645 <dd>
647 Delete a branch. The branch must be fully merged in its
648 upstream branch, or in <tt>HEAD</tt> if no upstream was set with
649 <tt>--track</tt> or <tt>--set-upstream</tt>.
650 </p>
651 </dd>
652 <dt class="hdlist1">
654 </dt>
655 <dd>
657 Delete a branch irrespective of its merged status.
658 </p>
659 </dd>
660 <dt class="hdlist1">
662 </dt>
663 <dt class="hdlist1">
664 --create-reflog
665 </dt>
666 <dd>
668 Create the branch&#8217;s reflog. This activates recording of
669 all changes made to the branch ref, enabling use of date
670 based sha1 expressions such as "&lt;branchname&gt;@{yesterday}".
671 Note that in non-bare repositories, reflogs are usually
672 enabled by default by the <tt>core.logallrefupdates</tt> config option.
673 </p>
674 </dd>
675 <dt class="hdlist1">
677 </dt>
678 <dt class="hdlist1">
679 --force
680 </dt>
681 <dd>
683 Reset &lt;branchname&gt; to &lt;startpoint&gt; if &lt;branchname&gt; exists
684 already. Without <tt>-f</tt> <em>git branch</em> refuses to change an existing branch.
685 </p>
686 </dd>
687 <dt class="hdlist1">
689 </dt>
690 <dt class="hdlist1">
691 --move
692 </dt>
693 <dd>
695 Move/rename a branch and the corresponding reflog.
696 </p>
697 </dd>
698 <dt class="hdlist1">
700 </dt>
701 <dd>
703 Move/rename a branch even if the new branch name already exists.
704 </p>
705 </dd>
706 <dt class="hdlist1">
707 --color[=&lt;when&gt;]
708 </dt>
709 <dd>
711 Color branches to highlight current, local, and
712 remote-tracking branches.
713 The value must be always (the default), never, or auto.
714 </p>
715 </dd>
716 <dt class="hdlist1">
717 --no-color
718 </dt>
719 <dd>
721 Turn off branch colors, even when the configuration file gives the
722 default to color output.
723 Same as <tt>--color=never</tt>.
724 </p>
725 </dd>
726 <dt class="hdlist1">
728 </dt>
729 <dt class="hdlist1">
730 --remotes
731 </dt>
732 <dd>
734 List or delete (if used with -d) the remote-tracking branches.
735 </p>
736 </dd>
737 <dt class="hdlist1">
739 </dt>
740 <dt class="hdlist1">
741 --all
742 </dt>
743 <dd>
745 List both remote-tracking branches and local branches.
746 </p>
747 </dd>
748 <dt class="hdlist1">
749 --list
750 </dt>
751 <dd>
753 Activate the list mode. <tt>git branch &lt;pattern&gt;</tt> would try to create a branch,
754 use <tt>git branch --list &lt;pattern&gt;</tt> to list matching branches.
755 </p>
756 </dd>
757 <dt class="hdlist1">
759 </dt>
760 <dt class="hdlist1">
761 --verbose
762 </dt>
763 <dd>
765 When in list mode,
766 show sha1 and commit subject line for each head, along with
767 relationship to upstream branch (if any). If given twice, print
768 the name of the upstream branch, as well.
769 </p>
770 </dd>
771 <dt class="hdlist1">
772 --abbrev=&lt;length&gt;
773 </dt>
774 <dd>
776 Alter the sha1&#8217;s minimum display length in the output listing.
777 The default value is 7 and can be overridden by the <tt>core.abbrev</tt>
778 config option.
779 </p>
780 </dd>
781 <dt class="hdlist1">
782 --no-abbrev
783 </dt>
784 <dd>
786 Display the full sha1s in the output listing rather than abbreviating them.
787 </p>
788 </dd>
789 <dt class="hdlist1">
791 </dt>
792 <dt class="hdlist1">
793 --track
794 </dt>
795 <dd>
797 When creating a new branch, set up configuration to mark the
798 start-point branch as "upstream" from the new branch. This
799 configuration will tell git to show the relationship between the
800 two branches in <tt>git status</tt> and <tt>git branch -v</tt>. Furthermore,
801 it directs <tt>git pull</tt> without arguments to pull from the
802 upstream when the new branch is checked out.
803 </p>
804 <div class="paragraph"><p>This behavior is the default when the start point is a remote-tracking branch.
805 Set the branch.autosetupmerge configuration variable to <tt>false</tt> if you
806 want <tt>git checkout</tt> and <tt>git branch</tt> to always behave as if <em>--no-track</em>
807 were given. Set it to <tt>always</tt> if you want this behavior when the
808 start-point is either a local or remote-tracking branch.</p></div>
809 </dd>
810 <dt class="hdlist1">
811 --no-track
812 </dt>
813 <dd>
815 Do not set up "upstream" configuration, even if the
816 branch.autosetupmerge configuration variable is true.
817 </p>
818 </dd>
819 <dt class="hdlist1">
820 --set-upstream
821 </dt>
822 <dd>
824 If specified branch does not exist yet or if <em>--force</em> has been
825 given, acts exactly like <em>--track</em>. Otherwise sets up configuration
826 like <em>--track</em> would when creating the branch, except that where
827 branch points to is not changed.
828 </p>
829 </dd>
830 <dt class="hdlist1">
831 --contains &lt;commit&gt;
832 </dt>
833 <dd>
835 Only list branches which contain the specified commit.
836 </p>
837 </dd>
838 <dt class="hdlist1">
839 --merged [&lt;commit&gt;]
840 </dt>
841 <dd>
843 Only list branches whose tips are reachable from the
844 specified commit (HEAD if not specified).
845 </p>
846 </dd>
847 <dt class="hdlist1">
848 --no-merged [&lt;commit&gt;]
849 </dt>
850 <dd>
852 Only list branches whose tips are not reachable from the
853 specified commit (HEAD if not specified).
854 </p>
855 </dd>
856 <dt class="hdlist1">
857 &lt;branchname&gt;
858 </dt>
859 <dd>
861 The name of the branch to create or delete.
862 The new branch name must pass all checks defined by
863 <a href="git-check-ref-format.html">git-check-ref-format(1)</a>. Some of these checks
864 may restrict the characters allowed in a branch name.
865 </p>
866 </dd>
867 <dt class="hdlist1">
868 &lt;start-point&gt;
869 </dt>
870 <dd>
872 The new branch head will point to this commit. It may be
873 given as a branch name, a commit-id, or a tag. If this
874 option is omitted, the current HEAD will be used instead.
875 </p>
876 </dd>
877 <dt class="hdlist1">
878 &lt;oldbranch&gt;
879 </dt>
880 <dd>
882 The name of an existing branch to rename.
883 </p>
884 </dd>
885 <dt class="hdlist1">
886 &lt;newbranch&gt;
887 </dt>
888 <dd>
890 The new name for an existing branch. The same restrictions as for
891 &lt;branchname&gt; apply.
892 </p>
893 </dd>
894 </dl></div>
895 </div>
896 <h2 id="_examples">Examples</h2>
897 <div class="sectionbody">
898 <div class="dlist"><dl>
899 <dt class="hdlist1">
900 Start development from a known tag
901 </dt>
902 <dd>
903 <div class="listingblock">
904 <div class="content">
905 <pre><tt>$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
906 $ cd my2.6
907 $ git branch my2.6.14 v2.6.14 <b>&lt;1&gt;</b>
908 $ git checkout my2.6.14</tt></pre>
909 </div></div>
910 <div class="colist arabic"><ol>
911 <li>
913 This step and the next one could be combined into a single step with
914 "checkout -b my2.6.14 v2.6.14".
915 </p>
916 </li>
917 </ol></div>
918 </dd>
919 <dt class="hdlist1">
920 Delete an unneeded branch
921 </dt>
922 <dd>
923 <div class="listingblock">
924 <div class="content">
925 <pre><tt>$ git clone git://git.kernel.org/.../git.git my.git
926 $ cd my.git
927 $ git branch -d -r origin/todo origin/html origin/man <b>&lt;1&gt;</b>
928 $ git branch -D test <b>&lt;2&gt;</b></tt></pre>
929 </div></div>
930 <div class="colist arabic"><ol>
931 <li>
933 Delete the remote-tracking branches "todo", "html" and "man". The next
934 <em>fetch</em> or <em>pull</em> will create them again unless you configure them not to.
935 See <a href="git-fetch.html">git-fetch(1)</a>.
936 </p>
937 </li>
938 <li>
940 Delete the "test" branch even if the "master" branch (or whichever branch
941 is currently checked out) does not have all commits from the test branch.
942 </p>
943 </li>
944 </ol></div>
945 </dd>
946 </dl></div>
947 </div>
948 <h2 id="_notes">Notes</h2>
949 <div class="sectionbody">
950 <div class="paragraph"><p>If you are creating a branch that you want to checkout immediately, it is
951 easier to use the git checkout command with its <tt>-b</tt> option to create
952 a branch and check it out with a single command.</p></div>
953 <div class="paragraph"><p>The options <tt>--contains</tt>, <tt>--merged</tt> and <tt>--no-merged</tt> serve three related
954 but different purposes:</p></div>
955 <div class="ulist"><ul>
956 <li>
958 <tt>--contains &lt;commit&gt;</tt> is used to find all branches which will need
959 special attention if &lt;commit&gt; were to be rebased or amended, since those
960 branches contain the specified &lt;commit&gt;.
961 </p>
962 </li>
963 <li>
965 <tt>--merged</tt> is used to find all branches which can be safely deleted,
966 since those branches are fully contained by HEAD.
967 </p>
968 </li>
969 <li>
971 <tt>--no-merged</tt> is used to find branches which are candidates for merging
972 into HEAD, since those branches are not fully contained by HEAD.
973 </p>
974 </li>
975 </ul></div>
976 </div>
977 <h2 id="_see_also">SEE ALSO</h2>
978 <div class="sectionbody">
979 <div class="paragraph"><p><a href="git-check-ref-format.html">git-check-ref-format(1)</a>,
980 <a href="git-fetch.html">git-fetch(1)</a>,
981 <a href="git-remote.html">git-remote(1)</a>,
982 <a href="user-manual.html#what-is-a-branch">&#8220;Understanding history: What is
983 a branch?&#8221;</a> in the Git User&#8217;s Manual.</p></div>
984 </div>
985 <h2 id="_git">GIT</h2>
986 <div class="sectionbody">
987 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
988 </div>
989 </div>
990 <div id="footnotes"><hr /></div>
991 <div id="footer">
992 <div id="footer-text">
993 Last updated 2011-10-05 13:59:16 PDT
994 </div>
995 </div>
996 </body>
997 </html>