Documentation/git-show-branch.txt

   1 git-show-branch(1)
   2 ==================
   3
   4 NAME
   5 ----
   6 git-show-branch - Show branches and their commits
   7
   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>]
  17
  18 DESCRIPTION
  19 -----------
  20
  21 Shows the commit ancestry graph starting from the commits named
  22 with <rev>s or <glob>s (or all refs under refs/heads
  23 and/or refs/tags) semi-visually.
  24
  25 It cannot show more than 29 branches and commits at a time.
  26
  27 It uses `showbranch.default` multi-valued configuration items if
  28 no <rev> or <glob> is given on the command line.
  29
  30
  31 OPTIONS
  32 -------
  33 <rev>::
  34         Arbitrary extended SHA-1 expression (see linkgit:gitrevisions[7])
  35         that typically names a branch head or a tag.
  36
  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.
  42
  43 -r::
  44 --remotes::
  45         Show the remote-tracking branches.
  46
  47 -a::
  48 --all::
  49         Show both remote-tracking branches and local branches.
  50
  51 --current::
  52         With this option, the command includes the current
  53         branch in the list of revs to be shown when it is not
  54         given on the command line.
  55
  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).
  61
  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.
  66
  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.
  71
  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         <ref>s given, without showing the commit ancestry tree.
  78
  79 --list::
  80         Synonym to `--more=-1`
  81
  82 --merge-base::
  83         Instead of showing the commit list, determine possible
  84         merge bases for the specified commits. All merge bases
  85         will be contained in all specified commits. This is
  86         different from how linkgit:git-merge-base[1] handles
  87         the case of three or more commits.
  88
  89 --independent::
  90         Among the <ref>s given, display only the ones that cannot be
  91         reached from any other <ref>.
  92
  93 --no-name::
  94         Do not show naming strings for each commit.
  95
  96 --sha1-name::
  97         Instead of naming the commits using the path to reach
  98         them from heads (e.g. "master~2" to mean the grandparent
  99         of "master"), name them with the unique prefix of their
 100         object names.
 101
 102 --topics::
 103         Shows only commits that are NOT on the first branch given.
 104         This helps track topic branches by hiding any commit that
 105         is already in the main line of development.  When given
 106         "git show-branch --topics master topic1 topic2", this
 107         will show the revisions given by "git rev-list {caret}master
 108         topic1 topic2"
 109
 110 -g::
 111 --reflog[=<n>[,<base>]] [<ref>]::
 112         Shows <n> most recent ref-log entries for the given
 113         ref.  If <base> is given, <n> entries going back from
 114         that entry.  <base> can be specified as count or date.
 115         When no explicit <ref> parameter is given, it defaults to the
 116         current branch (or `HEAD` if it is detached).
 117
 118 --color[=<when>]::
 119         Color the status sign (one of these: `*` `!` `+` `-`) of each commit
 120         corresponding to the branch it's in.
 121         The value must be always (the default), never, or auto.
 122
 123 --no-color::
 124         Turn off colored output, even when the configuration file gives the
 125         default to color output.
 126         Same as `--color=never`.
 127
 128 Note that --more, --list, --independent, and --merge-base options
 129 are mutually exclusive.
 130
 131
 132 OUTPUT
 133 ------
 134
 135 Given N <ref>s, the first N lines are the one-line description from
 136 their commit message. The branch head that is pointed at by
 137 $GIT_DIR/HEAD is prefixed with an asterisk `*` character while other
 138 heads are prefixed with a `!` character.
 139
 140 Following these N lines, a 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 SHA-1 to name that commit.
 146
 147 The following example shows three branches, "master", "fixes",
 148 and "mhf":
 149
 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.
 155 ---
 156   + [mhf] Allow "+remote:local" refspec to cause --force when fetching.
 157   + [mhf~1] Use git-octopus when pulling more than one head.
 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 ------------------------------------------------
 168
 169 These three branches all forked from a common commit, [master],
 170 whose commit message is "Add \'git show-branch'".
 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".
 174
 175
 176 EXAMPLES
 177 --------
 178
 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:
 182
 183 ------------
 184 [showbranch]
 185         default = --topo-order
 186         default = heads/*
 187
 188 ------------
 189
 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.
 193
 194 ------------
 195 $ git show-branch --reflog="10,1 hour ago" --list master
 196 ------------
 197
 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 to each other.
 201
 202 CONFIGURATION
 203 -------------
 204
 205 include::includes/cmd-config-section-all.txt[]
 206
 207 include::config/showbranch.txt[]
 208
 209 GIT
 210 ---
 211 Part of the linkgit:git[1] suite