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' [--all] [--remotes] [--topo-order | --date-order]
  12                 [--current] [--color | --no-color]
  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 <globs>s (or all refs under $GIT_DIR/refs/heads
  23 and/or $GIT_DIR/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> nor <glob> is given on the command line.
  29
  30
  31 OPTIONS
  32 -------
  33 <rev>::
  34         Arbitrary extended SHA1 expression (see linkgit:git-rev-parse[1])
  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         $GIT_DIR/refs.  For example, if you have many topic
  40         branches under $GIT_DIR/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 to 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         <reference>s given, without showing the commit ancestry
  78         tree.
  79
  80 --list::
  81         Synonym to `--more=-1`
  82
  83 --merge-base::
  84         Instead of showing the commit list, just act like the
  85         'git-merge-base -a' command, except that it can accept
  86         more than two heads.
  87
  88 --independent::
  89         Among the <reference>s given, display only the ones that
  90         cannot be reached from any other <reference>.
  91
  92 --no-name::
  93         Do not show naming strings for each commit.
  94
  95 --sha1-name::
  96         Instead of naming the commits using the path to reach
  97         them from heads (e.g. "master~2" to mean the grandparent
  98         of "master"), name them with the unique prefix of their
  99         object names.
 100
 101 --topics::
 102         Shows only commits that are NOT on the first branch given.
 103         This helps track topic branches by hiding any commit that
 104         is already in the main line of development.  When given
 105         "git show-branch --topics master topic1 topic2", this
 106         will show the revisions given by "git rev-list {caret}master
 107         topic1 topic2"
 108
 109 -g::
 110 --reflog[=<n>[,<base>]] [<ref>]::
 111         Shows <n> most recent ref-log entries for the given
 112         ref.  If <base> is given, <n> entries going back from
 113         that entry.  <base> can be specified as count or date.
 114         When no explicit <ref> parameter is given, it defaults to the
 115         current branch (or `HEAD` if it is detached).
 116
 117 --color::
 118         Color the status sign (one of these: `*` `!` `+` `-`) of each commit
 119         corresponding to the branch it's in.
 120
 121 --no-color::
 122         Turn off colored output, even when the configuration file gives the
 123         default to color output.
 124
 125 Note that --more, --list, --independent and --merge-base options
 126 are mutually exclusive.
 127
 128
 129 OUTPUT
 130 ------
 131 Given N <references>, the first N lines are the one-line
 132 description from their commit message.  The branch head that is
 133 pointed at by $GIT_DIR/HEAD is prefixed with an asterisk `*`
 134 character while other heads are prefixed with a `!` character.
 135
 136 Following these N lines, one-line log for each commit is
 137 displayed, indented N places.  If a commit is on the I-th
 138 branch, the I-th indentation character shows a `+` sign;
 139 otherwise it shows a space.  Merge commits are denoted by
 140 a `-` sign.  Each commit shows a short name that
 141 can be used as an extended SHA1 to name that commit.
 142
 143 The following example shows three branches, "master", "fixes"
 144 and "mhf":
 145
 146 ------------------------------------------------
 147 $ git show-branch master fixes mhf
 148 * [master] Add 'git show-branch'.
 149  ! [fixes] Introduce "reset type" flag to "git reset"
 150   ! [mhf] Allow "+remote:local" refspec to cause --force when fetching.
 151 ---
 152   + [mhf] Allow "+remote:local" refspec to cause --force when fetching.
 153   + [mhf~1] Use git-octopus when pulling more than one heads.
 154  +  [fixes] Introduce "reset type" flag to "git reset"
 155   + [mhf~2] "git fetch --force".
 156   + [mhf~3] Use .git/remote/origin, not .git/branches/origin.
 157   + [mhf~4] Make "git pull" and "git fetch" default to origin
 158   + [mhf~5] Infamous 'octopus merge'
 159   + [mhf~6] Retire git-parse-remote.
 160   + [mhf~7] Multi-head fetch.
 161   + [mhf~8] Start adding the $GIT_DIR/remotes/ support.
 162 *++ [master] Add 'git show-branch'.
 163 ------------------------------------------------
 164
 165 These three branches all forked from a common commit, [master],
 166 whose commit message is "Add \'git show-branch\'". The "fixes"
 167 branch adds one commit "Introduce "reset type" flag to "git reset"".
 168 The "mhf" branch adds many other commits. The current branch
 169 is "master".
 170
 171
 172 EXAMPLE
 173 -------
 174
 175 If you keep your primary branches immediately under
 176 `$GIT_DIR/refs/heads`, and topic branches in subdirectories of
 177 it, having the following in the configuration file may help:
 178
 179 ------------
 180 [showbranch]
 181         default = --topo-order
 182         default = heads/*
 183
 184 ------------
 185
 186 With this, `git show-branch` without extra parameters would show
 187 only the primary branches.  In addition, if you happen to be on
 188 your topic branch, it is shown as well.
 189
 190 ------------
 191 $ git show-branch --reflog="10,1 hour ago" --list master
 192 ------------
 193
 194 shows 10 reflog entries going back from the tip as of 1 hour ago.
 195 Without `--list`, the output also shows how these tips are
 196 topologically related with each other.
 197
 198
 199 Author
 200 ------
 201 Written by Junio C Hamano <gitster@pobox.com>
 202
 203
 204 Documentation
 205 --------------
 206 Documentation by Junio C Hamano.
 207
 208
 209 GIT
 210 ---
 211 Part of the linkgit:git[1] suite