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