blob: ee328a1c9a1cc3cdb47ff68040084cf6ef4b8783 [file] [log] [blame]
iannucci@chromium.orga5d95022014-03-25 21:30:37 +00001git-map-branches(1)
2===================
3
4NAME
5----
6git-map-branches -
7include::_git-map-branches_desc.helper.txt[]
8
9SYNOPSIS
10--------
11[verse]
12'git map-branches'
13
14DESCRIPTION
15-----------
16
17Git map-branches displays all local branches such that:
18
19* Current branch is [aqua]#cyan#.
20** The branch which will be modified with git-commit is denoted with an asterisk
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +000021 (`*`) after the name.
iannucci@chromium.orga5d95022014-03-25 21:30:37 +000022* Local branches are [green]#green#.
23* Remote branches are [red]#red# (usually, the root of all other branches).
calamity@chromium.org4cd0a8b2014-09-23 03:30:50 +000024* 'branch-heads' branches are [blue]#blue#.
iannucci@chromium.orga5d95022014-03-25 21:30:37 +000025* `{NO UPSTREAM}` is a special placeholder in [fuchsia]#magenta#.
26** Branches which have this as their parent are usually misconfigured, and
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +000027 should be assigned a parent by checking out the branch and running git branch
28 --set-upstream-to=<correct parent branch>.
iannucci@chromium.orga5d95022014-03-25 21:30:37 +000029
30NOTE: If multiple branches are on the same commit, they will all be cyan.
31
Clemens Hammacher03640c72018-12-13 08:08:19 +000032OPTIONS
33-------
34
35--no-color::
36 Turn off colors.
37
38-v::
39 Be more verbose. Pass once to show tracking info, twice for hash and review
40 URL, thrice for review status.
41
iannucci@chromium.orga5d95022014-03-25 21:30:37 +000042EXAMPLE
43-------
44
45Given the hypothetical demo repo in linkgit:git-map[1]\'s EXAMPLE section, and
46assuming that the `frozen_changes` branch was currently checked out, running
47'git map-branches' would result in an output like:
48
iannucci@chromium.org21980022014-04-11 04:51:49 +000049demo:1[]
iannucci@chromium.orga5d95022014-03-25 21:30:37 +000050
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +000051include::_aliases.txt[]
52
53----
54[alias]
55 git bmap = map-branches
56----
57
iannucci@chromium.orga5d95022014-03-25 21:30:37 +000058SEE ALSO
59--------
60linkgit:git-map[1]
61
62include::_footer.txt[]
63
iannucci@chromium.org21980022014-04-11 04:51:49 +000064// vim: ft=asciidoc: