[PATCH] Add 'git show-branch'.
[git.git] / Documentation / git-show-branches-script.txt
1 git-show-branches-script(1)
2 ===========================
3 v0.99.4, Aug 2005
4
5 NAME
6 ----
7 git-show-branches-script - Show branches and their commits.
8
9 SYNOPSIS
10 --------
11 'git show-branches <reference>...'
12
13 DESCRIPTION
14 -----------
15 Shows the head commits from the named <reference> (or all refs under
16 $GIT_DIR/refs/heads), and displays concise list of commit logs
17 to show their relationship semi-visually.
18
19 OPTIONS
20 -------
21 <reference>::
22         Name of the reference under $GIT_DIR/refs/heads/.
23
24
25 OUTPUT
26 ------
27 Given N <references>, the first N lines are the one-line
28 description from their commit message.  The branch head that is
29 pointed at by $GIT_DIR/HEAD is prefixed with an asterisk '*'
30 character while other heads are prefixed with a '!' character.
31
32 Following these N lines, one-line log for each commit is
33 displayed, indented N places.  If a commit is on the I-th
34 branch, the I-th indentation character shows a '+' sign;
35 otherwise it shows a space.
36
37 The following example shows three branches, "pu", "master" and
38 "rc":
39
40 ------------------------------------------------
41 * [pu] Add cheap local clone '-s' flag to git-clone-script
42  ! [master] Documentation updates.
43   ! [rc] Merge master into rc
44 +   Add cheap local clone '-s' flag to git-clone-script
45 +   Alternate object pool mechanism updates.
46 +   Audit rev-parse users.
47 ++  Documentation updates.
48   + Merge master into rc
49 +++ [PATCH] plug memory leak in diff.c::diff_free_filepair()
50 ------------------------------------------------
51
52 These three branches all forked from a common commit, "[PATCH]
53 plug memory leak...", and "rc" has one commit ahead of it.  The
54 "master" branch has one different commit that is also shared by
55 "pu" branch, and "pu" branch has three more commits on top of
56 "master" branch.
57
58
59 Author
60 ------
61 Written by Junio C Hamano <junkio@cox.net>
62
63
64 Documentation
65 --------------
66 Documentation by Junio C Hamano.
67
68
69 GIT
70 ---
71 Part of the link:git.html[git] suite