forked from git/git
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathgit-branch.html
More file actions
707 lines (670 loc) · 16.9 KB
/
git-branch.html
File metadata and controls
707 lines (670 loc) · 16.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.2.5" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
div.olist2 ol {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hlist td {
padding-bottom: 5px;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
include1::./stylesheets/xhtml11-manpage.css[]
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>git-branch(1)</title>
</head>
<body>
<div id="header">
<h1>
git-branch(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-branch -
List, create, or delete branches
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<div class="content"><em>git branch</em> [--color[=<when>] | --no-color] [-r | -a]
[-v [--abbrev=<length> | --no-abbrev]]
[(--merged | --no-merged | --contains) [<commit>]]
<em>git branch</em> [--set-upstream | --track | --no-track] [-l] [-f] <branchname> [<start-point>]
<em>git branch</em> (-m | -M) [<oldbranch>] <newbranch>
<em>git branch</em> (-d | -D) [-r] <branchname>…</div></div>
</div>
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="para"><p>With no arguments, existing branches are listed and the current branch will
be highlighted with an asterisk. Option <tt>-r</tt> causes the remote-tracking
branches to be listed, and option <tt>-a</tt> shows both.</p></div>
<div class="para"><p>With <tt>--contains</tt>, shows only the branches that contain the named commit
(in other words, the branches whose tip commits are descendants of the
named commit). With <tt>--merged</tt>, only branches merged into the named
commit (i.e. the branches whose tip commits are reachable from the named
commit) will be listed. With <tt>--no-merged</tt> only branches not merged into
the named commit will be listed. If the <commit> argument is missing it
defaults to <em>HEAD</em> (i.e. the tip of the current branch).</p></div>
<div class="para"><p>The command's second form creates a new branch head named <branchname>
which points to the current <em>HEAD</em>, or <start-point> if given.</p></div>
<div class="para"><p>Note that this will create the new branch, but it will not switch the
working tree to it; use "git checkout <newbranch>" to switch to the
new branch.</p></div>
<div class="para"><p>When a local branch is started off a remote branch, git sets up the
branch so that <em>git pull</em> will appropriately merge from
the remote branch. This behavior may be changed via the global
<tt>branch.autosetupmerge</tt> configuration flag. That setting can be
overridden by using the <tt>--track</tt> and <tt>--no-track</tt> options.</p></div>
<div class="para"><p>With a <em>-m</em> or <em>-M</em> option, <oldbranch> will be renamed to <newbranch>.
If <oldbranch> had a corresponding reflog, it is renamed to match
<newbranch>, and a reflog entry is created to remember the branch
renaming. If <newbranch> exists, -M must be used to force the rename
to happen.</p></div>
<div class="para"><p>With a <tt>-d</tt> or <tt>-D</tt> option, <tt><branchname></tt> will be deleted. You may
specify more than one branch for deletion. If the branch currently
has a reflog then the reflog will also be deleted.</p></div>
<div class="para"><p>Use -r together with -d to delete remote-tracking branches. Note, that it
only makes sense to delete remote-tracking branches if they no longer exist
in the remote repository or if <em>git fetch</em> was configured not to fetch
them again. See also the <em>prune</em> subcommand of <a href="git-remote.html">git-remote(1)</a> for a
way to clean up all obsolete remote-tracking branches.</p></div>
</div>
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
-d
</dt>
<dd>
<p>
Delete a branch. The branch must be fully merged in its
upstream branch, or in <tt>HEAD</tt> if no upstream was set with
<tt>--track</tt> or <tt>--set-upstream</tt>.
</p>
</dd>
<dt>
-D
</dt>
<dd>
<p>
Delete a branch irrespective of its merged status.
</p>
</dd>
<dt>
-l
</dt>
<dd>
<p>
Create the branch's reflog. This activates recording of
all changes made to the branch ref, enabling use of date
based sha1 expressions such as "<branchname>@{yesterday}".
Note that in non-bare repositories, reflogs are usually
enabled by default by the <tt>core.logallrefupdates</tt> config option.
</p>
</dd>
<dt>
-f
</dt>
<dt>
--force
</dt>
<dd>
<p>
Reset <branchname> to <startpoint> if <branchname> exists
already. Without <tt>-f</tt> <em>git branch</em> refuses to change an existing branch.
</p>
</dd>
<dt>
-m
</dt>
<dd>
<p>
Move/rename a branch and the corresponding reflog.
</p>
</dd>
<dt>
-M
</dt>
<dd>
<p>
Move/rename a branch even if the new branch name already exists.
</p>
</dd>
<dt>
--color[=<when>]
</dt>
<dd>
<p>
Color branches to highlight current, local, and remote branches.
The value must be always (the default), never, or auto.
</p>
</dd>
<dt>
--no-color
</dt>
<dd>
<p>
Turn off branch colors, even when the configuration file gives the
default to color output.
Same as <tt>--color=never</tt>.
</p>
</dd>
<dt>
-r
</dt>
<dd>
<p>
List or delete (if used with -d) the remote-tracking branches.
</p>
</dd>
<dt>
-a
</dt>
<dd>
<p>
List both remote-tracking branches and local branches.
</p>
</dd>
<dt>
-v
</dt>
<dt>
--verbose
</dt>
<dd>
<p>
Show sha1 and commit subject line for each head, along with
relationship to upstream branch (if any). If given twice, print
the name of the upstream branch, as well.
</p>
</dd>
<dt>
--abbrev=<length>
</dt>
<dd>
<p>
Alter the sha1's minimum display length in the output listing.
The default value is 7.
</p>
</dd>
<dt>
--no-abbrev
</dt>
<dd>
<p>
Display the full sha1s in the output listing rather than abbreviating them.
</p>
</dd>
<dt>
-t
</dt>
<dt>
--track
</dt>
<dd>
<p>
When creating a new branch, set up configuration to mark the
start-point branch as "upstream" from the new branch. This
configuration will tell git to show the relationship between the
two branches in <tt>git status</tt> and <tt>git branch -v</tt>. Furthermore,
it directs <tt>git pull</tt> without arguments to pull from the
upstream when the new branch is checked out.
</p>
<div class="para"><p>This behavior is the default when the start point is a remote branch.
Set the branch.autosetupmerge configuration variable to <tt>false</tt> if you
want <tt>git checkout</tt> and <tt>git branch</tt> to always behave as if <em>--no-track</em>
were given. Set it to <tt>always</tt> if you want this behavior when the
start-point is either a local or remote branch.</p></div>
</dd>
<dt>
--no-track
</dt>
<dd>
<p>
Do not set up "upstream" configuration, even if the
branch.autosetupmerge configuration variable is true.
</p>
</dd>
<dt>
--set-upstream
</dt>
<dd>
<p>
If specified branch does not exist yet or if <em>--force</em> has been
given, acts exactly like <em>--track</em>. Otherwise sets up configuration
like <em>--track</em> would when creating the branch, except that where
branch points to is not changed.
</p>
</dd>
<dt>
--contains <commit>
</dt>
<dd>
<p>
Only list branches which contain the specified commit.
</p>
</dd>
<dt>
--merged [<commit>]
</dt>
<dd>
<p>
Only list branches whose tips are reachable from the
specified commit (HEAD if not specified).
</p>
</dd>
<dt>
--no-merged [<commit>]
</dt>
<dd>
<p>
Only list branches whose tips are not reachable from the
specified commit (HEAD if not specified).
</p>
</dd>
<dt>
<branchname>
</dt>
<dd>
<p>
The name of the branch to create or delete.
The new branch name must pass all checks defined by
<a href="git-check-ref-format.html">git-check-ref-format(1)</a>. Some of these checks
may restrict the characters allowed in a branch name.
</p>
</dd>
<dt>
<start-point>
</dt>
<dd>
<p>
The new branch head will point to this commit. It may be
given as a branch name, a commit-id, or a tag. If this
option is omitted, the current HEAD will be used instead.
</p>
</dd>
<dt>
<oldbranch>
</dt>
<dd>
<p>
The name of an existing branch to rename.
</p>
</dd>
<dt>
<newbranch>
</dt>
<dd>
<p>
The new name for an existing branch. The same restrictions as for
<branchname> apply.
</p>
</dd>
</dl></div>
</div>
<h2 id="_examples">Examples</h2>
<div class="sectionbody">
<div class="vlist"><dl>
<dt>
Start development from a known tag
</dt>
<dd>
<div class="listingblock">
<div class="content">
<pre><tt>$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
$ cd my2.6
$ git branch my2.6.14 v2.6.14 <b>(1)</b>
$ git checkout my2.6.14</tt></pre>
</div></div>
<div class="colist"><ol>
<li>
<p>
This step and the next one could be combined into a single step with
"checkout -b my2.6.14 v2.6.14".
</p>
</li>
</ol></div>
</dd>
<dt>
Delete an unneeded branch
</dt>
<dd>
<div class="listingblock">
<div class="content">
<pre><tt>$ git clone git://git.kernel.org/.../git.git my.git
$ cd my.git
$ git branch -d -r origin/todo origin/html origin/man <b>(1)</b>
$ git branch -D test <b>(2)</b></tt></pre>
</div></div>
<div class="colist"><ol>
<li>
<p>
Delete the remote-tracking branches "todo", "html" and "man". The next
<em>fetch</em> or <em>pull</em> will create them again unless you configure them not to.
See <a href="git-fetch.html">git-fetch(1)</a>.
</p>
</li>
<li>
<p>
Delete the "test" branch even if the "master" branch (or whichever branch
is currently checked out) does not have all commits from the test branch.
</p>
</li>
</ol></div>
</dd>
</dl></div>
</div>
<h2 id="_notes">Notes</h2>
<div class="sectionbody">
<div class="para"><p>If you are creating a branch that you want to checkout immediately, it is
easier to use the git checkout command with its <tt>-b</tt> option to create
a branch and check it out with a single command.</p></div>
<div class="para"><p>The options <tt>--contains</tt>, <tt>--merged</tt> and <tt>--no-merged</tt> serve three related
but different purposes:</p></div>
<div class="ilist"><ul>
<li>
<p>
<tt>--contains <commit></tt> is used to find all branches which will need
special attention if <commit> were to be rebased or amended, since those
branches contain the specified <commit>.
</p>
</li>
<li>
<p>
<tt>--merged</tt> is used to find all branches which can be safely deleted,
since those branches are fully contained by HEAD.
</p>
</li>
<li>
<p>
<tt>--no-merged</tt> is used to find branches which are candidates for merging
into HEAD, since those branches are not fully contained by HEAD.
</p>
</li>
</ul></div>
</div>
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="para"><p><a href="git-check-ref-format.html">git-check-ref-format(1)</a>,
<a href="git-fetch.html">git-fetch(1)</a>,
<a href="git-remote.html">git-remote(1)</a>,
<a href="user-manual.html#what-is-a-branch">“Understanding history: What is
a branch?”</a> in the Git User's Manual.</p></div>
</div>
<h2 id="_author">Author</h2>
<div class="sectionbody">
<div class="para"><p>Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <gitster@pobox.com></p></div>
</div>
<h2 id="_documentation">Documentation</h2>
<div class="sectionbody">
<div class="para"><p>Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.</p></div>
</div>
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2010-09-18 23:56:34 UTC
</div>
</div>
</body>
</html>