e6b65a35b2a4fe3386876d7d2b28fc96c149f3bf
[git.git] / man1 / git-show-branch.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-SHOW-BRANCH" 1 "" "" ""
21 .SH NAME
22 git-show-branch \- Show branches and their commits.
23 .SH "SYNOPSIS"
24
25
26 git\-show\-branch [\-\-all] [\-\-heads] [\-\-tags] [\-\-topo\-order] [\-\-more=<n> | \-\-list | \-\-independent | \-\-merge\-base] [\-\-no\-name | \-\-sha1\-name] [<rev> | <glob>]...
27
28 .SH "DESCRIPTION"
29
30
31 Shows the commit ancestry graph starting from the commits named with <rev>s or <globs>s (or all refs under $GIT_DIR/refs/heads and/or $GIT_DIR/refs/tags) semi\-visually\&.
32
33
34 It cannot show more than 29 branches and commits at a time\&.
35
36 .SH "OPTIONS"
37
38 .TP
39 <rev>
40 Arbitrary extended SHA1 expression (see git\-rev\-parse) that typically names a branch HEAD or a tag\&.
41
42 .TP
43 <glob>
44 A glob pattern that matches branch or tag names under $GIT_DIR/refs\&. For example, if you have many topic branches under $GIT_DIR/refs/heads/topic, giving topic/* would show all of them\&.
45
46 .TP
47 \-\-all \-\-heads \-\-tags
48 Show all refs under $GIT_DIR/refs, $GIT_DIR/refs/heads, and $GIT_DIR/refs/tags, respectively\&.
49
50 .TP
51 \-\-topo\-order
52 By default, the branches and their commits are shown in reverse chronological order\&. This option makes them appear in topological order (i\&.e\&., descendant commits are shown before their parents)\&.
53
54 .TP
55 \-\-more=<n>
56 Usually the command stops output upon showing the commit that is the common ancestor of all the branches\&. This flag tells the command to go <n> more common commits beyond that\&. When <n> is negative, display only the <reference>s given, without showing the commit ancestry tree\&.
57
58 .TP
59 \-\-list
60 Synomym to \-\-more=\-1 
61
62 .TP
63 \-\-merge\-base
64 Instead of showing the commit list, just act like the git\-merge\-base \-a command, except that it can accept more than two heads\&.
65
66 .TP
67 \-\-independent
68 Among the <reference>s given, display only the ones that cannot be reached from any other <reference>\&.
69
70 .TP
71 \-\-no\-name
72 Do not show naming strings for each commit\&.
73
74 .TP
75 \-\-sha1\-name
76 Instead of naming the commits using the path to reach them from heads (e\&.g\&. "master~2" to mean the grandparent of "master"), name them with the unique prefix of their object names\&.
77
78
79 Note that \-\-more, \-\-list, \-\-independent and \-\-merge\-base options are mutually exclusive\&.
80
81 .SH "OUTPUT"
82
83
84 Given N <references>, the first N lines are the one\-line description from their commit message\&. The branch head that is pointed at by $GIT_DIR/HEAD is prefixed with an asterisk * character while other heads are prefixed with a ! character\&.
85
86
87 Following these N lines, one\-line log for each commit is displayed, indented N places\&. If a commit is on the I\-th branch, the I\-th indentation character shows a + sign; otherwise it shows a space\&. Each commit shows a short name that can be used as an exended SHA1 to name that commit\&.
88
89
90 The following example shows three branches, "master", "fixes" and "mhf":
91
92 .IP
93 $ git show\-branch master fixes mhf
94 ! [master] Add 'git show\-branch'\&.
95  ! [fixes] Introduce "reset type" flag to "git reset"
96   ! [mhf] Allow "+remote:local" refspec to cause \-\-force when fetching\&.
97 \-\-\-
98   + [mhf] Allow "+remote:local" refspec to cause \-\-force when fetching\&.
99   + [mhf~1] Use git\-octopus when pulling more than one heads\&.
100  +  [fixes] Introduce "reset type" flag to "git reset"
101   + [mhf~2] "git fetch \-\-force"\&.
102   + [mhf~3] Use \&.git/remote/origin, not \&.git/branches/origin\&.
103   + [mhf~4] Make "git pull" and "git fetch" default to origin
104   + [mhf~5] Infamous 'octopus merge'
105   + [mhf~6] Retire git\-parse\-remote\&.
106   + [mhf~7] Multi\-head fetch\&.
107   + [mhf~8] Start adding the $GIT_DIR/remotes/ support\&.
108 +++ [master] Add 'git show\-branch'\&.
109
110 These three branches all forked from a common commit, [master], whose commit message is "Add git show\-branch\&. "fixes" branch adds one commit Introduce "reset type"\&. "mhf" branch has many other commits\&.
111
112 .SH "AUTHOR"
113
114
115 Written by Junio C Hamano <junkio@cox\&.net>
116
117 .SH "DOCUMENTATION"
118
119
120 Documentation by Junio C Hamano\&.
121
122 .SH "GIT"
123
124
125 Part of the \fBgit\fR(7) suite
126