blob: 2a3efc7aee7b841934d62f0246b0deb279ef1996 [file] [log] [blame]
iannucci@chromium.orga5d95022014-03-25 21:30:37 +00001'\" t
2.\" Title: git-map
3.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +00005.\" Date: 03/25/2014
iannucci@chromium.orga5d95022014-03-25 21:30:37 +00006.\" Manual: Chromium depot_tools Manual
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +00007.\" Source: depot_tools 207bff1
iannucci@chromium.orga5d95022014-03-25 21:30:37 +00008.\" Language: English
9.\"
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +000010.TH "GIT\-MAP" "1" "03/25/2014" "depot_tools 207bff1" "Chromium depot_tools Manual"
iannucci@chromium.orga5d95022014-03-25 21:30:37 +000011.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31git-map \- Display history of all branches in a colorized terminal format\&.
32.SH "SYNOPSIS"
33.sp
34.nf
35\fIgit map\fR [<extra_args>\&...]
36.fi
37.sp
38.SH "DESCRIPTION"
39.sp
40Git map formats the output of git log \-\-graph from all refs such that:
41.sp
42.RS 4
43.ie n \{\
44\h'-04'\(bu\h'+03'\c
45.\}
46.el \{\
47.sp -1
48.IP \(bu 2.3
49.\}
50Current branch is
51cyan\&.
52.RE
53.sp
54.RS 4
55.ie n \{\
56\h'-04'\(bu\h'+03'\c
57.\}
58.el \{\
59.sp -1
60.IP \(bu 2.3
61.\}
62Local branches are
63green\&.
64.RE
65.sp
66.RS 4
67.ie n \{\
68\h'-04'\(bu\h'+03'\c
69.\}
70.el \{\
71.sp -1
72.IP \(bu 2.3
73.\}
74Remote branches are
75red\&.
76.RE
77.sp
78.RS 4
79.ie n \{\
80\h'-04'\(bu\h'+03'\c
81.\}
82.el \{\
83.sp -1
84.IP \(bu 2.3
85.\}
86Tags are
87magenta\&.
88.RE
89.sp
90.RS 4
91.ie n \{\
92\h'-04'\(bu\h'+03'\c
93.\}
94.el \{\
95.sp -1
96.IP \(bu 2.3
97.\}
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +000098Merge Base markers are
99white\&.
100.RE
101.sp
102.RS 4
103.ie n \{\
104\h'-04'\(bu\h'+03'\c
105.\}
106.el \{\
107.sp -1
108.IP \(bu 2.3
109.\}
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000110The currently checked out commit is highlighted with a
111blue background\&.
112.RE
113.sp
114The output is automatically piped through the less pager command, even on windows\&.
115.SH "OPTIONS"
116.PP
117<extra_args>\&...
118.RS 4
119Extra parameters to pass to the internal
120\fBgit-log\fR(1)
121invocation\&. This can be used to restrict what refs
122\fIgit map\fR
123operates on, etc\&.
124.sp
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +0000125If you run git map with a series of fixed arguments frequently, you can use the depot\-tools\&.map\-extra configuration variable to pre\-set arguments (See
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000126CONFIGURATION VARIABLES)
127.RE
128.SH "CONFIGURATION VARIABLES"
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +0000129.SS "depot\-tools\&.map\-extra"
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000130.sp
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +0000131Each value of the \fIdepot\-tools\&.map\-extra\fR config variable is applied as an additional argument to git log during the execution of git map\&. If you wish to configure this, use git config \-\-add depot\-tools\&.map\-extra <value> to do so\&.
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000132.SH "EXAMPLE"
133.sp
134Running \fIgit map\fR would result in an output something like:
135.sp
136.if n \{\
137.RS 4
138.\}
139.nf
140\fB$ git map\fR
141*\:\fB 7dcfe47 \fR (\:\fBfrozen_changes\fR\:) 2014\-03\-12 ~ FREEZE\&.unindexed
142* \fB4b0c180\fR 2014\-03\-12 ~ modfile
143* \fB59a7cca\fR 2014\-03\-12 ~ a deleted file
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +0000144* \fB6bec695\fR (\:origin/master\:) 2014\-03\-11 ~ Add neat feature \fB<(frozen_changes)\fR
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000145* \fBd15a38a\fR 2014\-03\-11 ~ Epic README update
146* \fBd559894\fR (\:\fBmaster\fR\:) 2014\-03\-11 ~ Important upstream change
147| * \fB9c311fd\fR (\:\fBcool_feature\fR\:) 2014\-03\-11 ~ Respond to CL comments
148| | * \fB2a1eeb2\fR (\:\fBsubfeature\fR\:) 2014\-03\-11 ~ integrate with CoolService
149| | * \fBd777af6\fR 2014\-03\-11 ~ slick commenting action
150| |/
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +0000151| * \fB265803a\fR 2014\-03\-11 ~ another improvement \fB<(subfeature)\fR
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000152| * \fB6d831ac\fR (\:\fBspleen_tag\fR\:) 2014\-03\-11 ~ Refactor spleen
153| * \fB82e74ab\fR 2014\-03\-11 ~ Add widget
154|/
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +0000155* \fBd08c5b3\fR (\:\fBbogus_noparent\fR\:) 2014\-03\-11 ~ Wonderful beginnings \fB<(cool_feature)\fR
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000156.fi
157.if n \{\
158.RE
159.\}
160.sp
161.sp
162As you can see, the structure of the commit history is visible, particularly what the parents of each commit are\&. In order to see the \fIupstream\fR relationships of the branches (i\&.e\&. which branch is tracking which other branch), use the \fBgit-map-branches\fR(1) command\&.
163.SH "SEE ALSO"
164.sp
165\fBgit-map-branches\fR(1)
166.SH "CHROMIUM DEPOT_TOOLS"
167.sp
168Part of the chromium \fBdepot_tools\fR(1) suite\&. These tools are meant to assist with the development of chromium and related projects\&. Download the tools from \m[blue]\fBhere\fR\m[]\&\s-2\u[1]\d\s+2\&.
169.SH "NOTES"
170.IP " 1." 4
171here
172.RS 4
173\%https://chromium.googlesource.com/chromium/tools/depot_tools.git
174.RE