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 'git-show-branch [--all] [--heads] [--tags] [--topo-order] [--more=<n> | --list | --independent | --merge-base] [--no-name | --sha1-name] [<rev> | <glob>]...'
  11
  12 DESCRIPTION
  13 -----------
  14
  15 Shows the commit ancestry graph starting from the commits named
  16 with <rev>s or <globs>s (or all refs under $GIT_DIR/refs/heads
  17 and/or $GIT_DIR/refs/tags) semi-visually.
  18
  19 It cannot show more than 29 branches and commits at a time.
  20
  21 It uses `showbranch.default` multi-valued configuration items if
  22 no <rev> nor <glob> is given on the command line.
  23
  24
  25 OPTIONS
  26 -------
  27 <rev>::
  28         Arbitrary extended SHA1 expression (see `git-rev-parse`)
  29         that typically names a branch HEAD or a tag.
  30
  31 <glob>::
  32         A glob pattern that matches branch or tag names under
  33         $GIT_DIR/refs.  For example, if you have many topic
  34         branches under $GIT_DIR/refs/heads/topic, giving
  35         `topic/*` would show all of them.
  36
  37 --all --heads --tags::
  38         Show all refs under $GIT_DIR/refs, $GIT_DIR/refs/heads,
  39         and $GIT_DIR/refs/tags, respectively.
  40
  41 --topo-order::
  42         By default, the branches and their commits are shown in
  43         reverse chronological order.  This option makes them
  44         appear in topological order (i.e., descendant commits
  45         are shown before their parents).
  46
  47 --more=<n>::
  48         Usually the command stops output upon showing the commit
  49         that is the common ancestor of all the branches.  This
  50         flag tells the command to go <n> more common commits
  51         beyond that.  When <n> is negative, display only the
  52         <reference>s given, without showing the commit ancestry
  53         tree.
  54
  55 --list::
  56         Synonym to `--more=-1`
  57
  58 --merge-base::
  59         Instead of showing the commit list, just act like the
  60         'git-merge-base -a' command, except that it can accept
  61         more than two heads.
  62
  63 --independent::
  64         Among the <reference>s given, display only the ones that
  65         cannot be reached from any other <reference>.
  66
  67 --no-name::
  68         Do not show naming strings for each commit.
  69
  70 --sha1-name::
  71         Instead of naming the commits using the path to reach
  72         them from heads (e.g. "master~2" to mean the grandparent
  73         of "master"), name them with the unique prefix of their
  74         object names.
  75
  76 Note that --more, --list, --independent and --merge-base options
  77 are mutually exclusive.
  78
  79
  80 OUTPUT
  81 ------
  82 Given N <references>, the first N lines are the one-line
  83 description from their commit message.  The branch head that is
  84 pointed at by $GIT_DIR/HEAD is prefixed with an asterisk '*'
  85 character while other heads are prefixed with a '!' character.
  86
  87 Following these N lines, one-line log for each commit is
  88 displayed, indented N places.  If a commit is on the I-th
  89 branch, the I-th indentation character shows a '+' sign;
  90 otherwise it shows a space.  Each commit shows a short name that
  91 can be used as an extended SHA1 to name that commit.
  92
  93 The following example shows three branches, "master", "fixes"
  94 and "mhf":
  95
  96 ------------------------------------------------
  97 $ git show-branch master fixes mhf
  98 ! [master] Add 'git show-branch'.
  99  ! [fixes] Introduce "reset type" flag to "git reset"
 100   ! [mhf] Allow "+remote:local" refspec to cause --force when fetching.
 101 ---
 102   + [mhf] Allow "+remote:local" refspec to cause --force when fetching.
 103   + [mhf~1] Use git-octopus when pulling more than one heads.
 104  +  [fixes] Introduce "reset type" flag to "git reset"
 105   + [mhf~2] "git fetch --force".
 106   + [mhf~3] Use .git/remote/origin, not .git/branches/origin.
 107   + [mhf~4] Make "git pull" and "git fetch" default to origin
 108   + [mhf~5] Infamous 'octopus merge'
 109   + [mhf~6] Retire git-parse-remote.
 110   + [mhf~7] Multi-head fetch.
 111   + [mhf~8] Start adding the $GIT_DIR/remotes/ support.
 112 +++ [master] Add 'git show-branch'.
 113 ------------------------------------------------
 114
 115 These three branches all forked from a common commit, [master],
 116 whose commit message is "Add 'git show-branch'.  "fixes" branch
 117 adds one commit 'Introduce "reset type"'.  "mhf" branch has many
 118 other commits.
 119
 120
 121 EXAMPLE
 122 -------
 123
 124 If you keep your primary branches immediately under
 125 `$GIT_DIR/refs/heads`, and topic branches in subdirectories of
 126 it, having the following in the configuration file may help:
 127
 128 ------------
 129 [showbranch]
 130         default = --topo-order
 131         default = heads/*
 132
 133 ------------
 134
 135 With this,`git show-branch` without extra parameters would show
 136 only the primary branches.
 137
 138
 139
 140 Author
 141 ------
 142 Written by Junio C Hamano <junkio@cox.net>
 143
 144
 145 Documentation
 146 --------------
 147 Documentation by Junio C Hamano.
 148
 149
 150 GIT
 151 ---
 152 Part of the gitlink:git[7] suite