i18n: grep: mark parseopt strings for translation
[git/jnareb-git.git] / Documentation / git-show-branch.txt
bloba8e77b5350c8c6a3cf62c22f811974ea64cff8ae
1 git-show-branch(1)
2 ==================
4 NAME
5 ----
6 git-show-branch - Show branches and their commits
8 SYNOPSIS
9 --------
10 [verse]
11 'git show-branch' [-a|--all] [-r|--remotes] [--topo-order | --date-order]
12                 [--current] [--color[=<when>] | --no-color] [--sparse]
13                 [--more=<n> | --list | --independent | --merge-base]
14                 [--no-name | --sha1-name] [--topics]
15                 [(<rev> | <glob>)...]
16 'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]
18 DESCRIPTION
19 -----------
21 Shows the commit ancestry graph starting from the commits named
22 with <rev>s or <globs>s (or all refs under refs/heads
23 and/or refs/tags) semi-visually.
25 It cannot show more than 29 branches and commits at a time.
27 It uses `showbranch.default` multi-valued configuration items if
28 no <rev> nor <glob> is given on the command line.
31 OPTIONS
32 -------
33 <rev>::
34         Arbitrary extended SHA1 expression (see linkgit:gitrevisions[7])
35         that typically names a branch head or a tag.
37 <glob>::
38         A glob pattern that matches branch or tag names under
39         refs/.  For example, if you have many topic
40         branches under refs/heads/topic, giving
41         `topic/*` would show all of them.
43 -r::
44 --remotes::
45         Show the remote-tracking branches.
47 -a::
48 --all::
49         Show both remote-tracking branches and local branches.
51 --current::
52         With this option, the command includes the current
53         branch to the list of revs to be shown when it is not
54         given on the command line.
56 --topo-order::
57         By default, the branches and their commits are shown in
58         reverse chronological order.  This option makes them
59         appear in topological order (i.e., descendant commits
60         are shown before their parents).
62 --date-order::
63         This option is similar to '--topo-order' in the sense that no
64         parent comes before all of its children, but otherwise commits
65         are ordered according to their commit date.
67 --sparse::
68         By default, the output omits merges that are reachable
69         from only one tip being shown.  This option makes them
70         visible.
72 --more=<n>::
73         Usually the command stops output upon showing the commit
74         that is the common ancestor of all the branches.  This
75         flag tells the command to go <n> more common commits
76         beyond that.  When <n> is negative, display only the
77         <reference>s given, without showing the commit ancestry
78         tree.
80 --list::
81         Synonym to `--more=-1`
83 --merge-base::
84         Instead of showing the commit list, determine possible
85         merge bases for the specified commits. All merge bases
86         will be contained in all specified commits. This is
87         different from how linkgit:git-merge-base[1] handles
88         the case of three or more commits.
90 --independent::
91         Among the <reference>s given, display only the ones that
92         cannot be reached from any other <reference>.
94 --no-name::
95         Do not show naming strings for each commit.
97 --sha1-name::
98         Instead of naming the commits using the path to reach
99         them from heads (e.g. "master~2" to mean the grandparent
100         of "master"), name them with the unique prefix of their
101         object names.
103 --topics::
104         Shows only commits that are NOT on the first branch given.
105         This helps track topic branches by hiding any commit that
106         is already in the main line of development.  When given
107         "git show-branch --topics master topic1 topic2", this
108         will show the revisions given by "git rev-list {caret}master
109         topic1 topic2"
111 -g::
112 --reflog[=<n>[,<base>]] [<ref>]::
113         Shows <n> most recent ref-log entries for the given
114         ref.  If <base> is given, <n> entries going back from
115         that entry.  <base> can be specified as count or date.
116         When no explicit <ref> parameter is given, it defaults to the
117         current branch (or `HEAD` if it is detached).
119 --color[=<when>]::
120         Color the status sign (one of these: `*` `!` `+` `-`) of each commit
121         corresponding to the branch it's in.
122         The value must be always (the default), never, or auto.
124 --no-color::
125         Turn off colored output, even when the configuration file gives the
126         default to color output.
127         Same as `--color=never`.
129 Note that --more, --list, --independent and --merge-base options
130 are mutually exclusive.
133 OUTPUT
134 ------
135 Given N <references>, the first N lines are the one-line
136 description from their commit message.  The branch head that is
137 pointed at by $GIT_DIR/HEAD is prefixed with an asterisk `*`
138 character while other heads are prefixed with a `!` character.
140 Following these N lines, one-line log for each commit is
141 displayed, indented N places.  If a commit is on the I-th
142 branch, the I-th indentation character shows a `+` sign;
143 otherwise it shows a space.  Merge commits are denoted by
144 a `-` sign.  Each commit shows a short name that
145 can be used as an extended SHA1 to name that commit.
147 The following example shows three branches, "master", "fixes"
148 and "mhf":
150 ------------------------------------------------
151 $ git show-branch master fixes mhf
152 * [master] Add 'git show-branch'.
153  ! [fixes] Introduce "reset type" flag to "git reset"
154   ! [mhf] Allow "+remote:local" refspec to cause --force when fetching.
156   + [mhf] Allow "+remote:local" refspec to cause --force when fetching.
157   + [mhf~1] Use git-octopus when pulling more than one heads.
158  +  [fixes] Introduce "reset type" flag to "git reset"
159   + [mhf~2] "git fetch --force".
160   + [mhf~3] Use .git/remote/origin, not .git/branches/origin.
161   + [mhf~4] Make "git pull" and "git fetch" default to origin
162   + [mhf~5] Infamous 'octopus merge'
163   + [mhf~6] Retire git-parse-remote.
164   + [mhf~7] Multi-head fetch.
165   + [mhf~8] Start adding the $GIT_DIR/remotes/ support.
166 *++ [master] Add 'git show-branch'.
167 ------------------------------------------------
169 These three branches all forked from a common commit, [master],
170 whose commit message is "Add {apostrophe}git show-branch{apostrophe}".
171 The "fixes" branch adds one commit "Introduce "reset type" flag to
172 "git reset"". The "mhf" branch adds many other commits.
173 The current branch is "master".
176 EXAMPLE
177 -------
179 If you keep your primary branches immediately under
180 `refs/heads`, and topic branches in subdirectories of
181 it, having the following in the configuration file may help:
183 ------------
184 [showbranch]
185         default = --topo-order
186         default = heads/*
188 ------------
190 With this, `git show-branch` without extra parameters would show
191 only the primary branches.  In addition, if you happen to be on
192 your topic branch, it is shown as well.
194 ------------
195 $ git show-branch --reflog="10,1 hour ago" --list master
196 ------------
198 shows 10 reflog entries going back from the tip as of 1 hour ago.
199 Without `--list`, the output also shows how these tips are
200 topologically related with each other.
204 Part of the linkgit:git[1] suite