blob: c3fdb1101268da58f287cc9af8b1557831676e0c [file] [log] [blame]
'\" t
.\" Title: git-map
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 04/10/2014
.\" Manual: Chromium depot_tools Manual
.\" Source: depot_tools 68b1017
.\" Language: English
.\"
.TH "GIT\-MAP" "1" "04/10/2014" "depot_tools 68b1017" "Chromium depot_tools Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-map \- Display history of all branches in a colorized terminal format\&.
.SH "SYNOPSIS"
.sp
.nf
\fIgit map\fR [<extra_args>\&...]
.fi
.sp
.SH "DESCRIPTION"
.sp
Git map formats the output of git log \-\-graph from all refs such that:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Current branch is
cyan\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Local branches are
green\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Remote branches are
red\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Tags are
magenta\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Merge Base markers are
white\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The currently checked out commit is highlighted with a
blue background\&.
.RE
.sp
The output is automatically piped through the less pager command, even on windows\&.
.SH "OPTIONS"
.PP
<extra_args>\&...
.RS 4
Extra parameters to pass to the internal
\fBgit-log\fR(1)
invocation\&. This can be used to restrict what refs
\fIgit map\fR
operates on, etc\&.
.sp
If 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
CONFIGURATION VARIABLES)
.RE
.SH "CONFIGURATION VARIABLES"
.SS "depot\-tools\&.map\-extra"
.sp
Each 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\&.
.SH "EXAMPLE"
.sp
Running \fIgit map\fR would result in an output something like:
.sp
.if n \{\
.RS 4
.\}
.nf
\fB$ git map\fR
\fB* d0fb9c7 \fR (\fBfrozen_branch\fR) 2014\-04\-10 ~ FREEZE\&.unindexed
* \fBf48f415 \fR 2014\-04\-10 ~ modfile
* \fB4c5b9c0 \fR 2014\-04\-10 ~ a deleted file
* \fBf7ce1e4 \fR (\fBfixit\fR) 2014\-04\-10 ~ Add neat feature\fB <(frozen_branch)\fR
* \fB3726937 \fR 2014\-04\-10 ~ Epic README update
| * \fB14db2e5 \fR (\fBcool_feature\fR) 2014\-04\-10 ~ Respond to CL comments
| | * \fBee3f972 \fR (\fBsubfeature\fR) 2014\-04\-10 ~ integrate with CoolService
| | * \fB4f9f508 \fR 2014\-04\-10 ~ slick commenting action
| |/
| * \fB7d84f85 \fR 2014\-04\-10 ~ another improvement\fB <(subfeature)\fR
| * \fB27abea4 \fR (\fBspleen_tag\fR) 2014\-04\-10 ~ Refactor spleen
| * \fBd8abe73 \fR 2014\-04\-10 ~ Add widget
|/
* \fBbeec6f4 \fR (origin/master, origin/HEAD) 2014\-04\-10 ~ Make ReflectorImpl use mailboxes\fB <(cool_feature, fixit)\fR
* \fB41290e0 \fR 2014\-04\-10 ~ don\*(Aqt use glibc\-specific execinfo\&.h on uclibc builds
* \fBa76fde7 \fR 2014\-04\-10 ~ [fsp] Add requestUnmount() method together with the request manager\&.
* \fB9de7a71 \fR 2014\-04\-10 ~ linux_aura: Use system configuration for middle clicking the titlebar\&.
* \fB073b0c2 \fR 2014\-04\-10 ~ ContentView\->ContentViewCore in ContentViewRenderView
* \fB2250f53 \fR 2014\-04\-10 ~ ozone: evdev: Filter devices by path
* \fB33a7a74 \fR 2014\-04\-10 ~ Always output seccomp error messages to stderr
.fi
.if n \{\
.RE
.\}
.sp
.sp
As 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\&.
.SH "SEE ALSO"
.sp
\fBgit-map-branches\fR(1)
.SH "CHROMIUM DEPOT_TOOLS"
.sp
Part of the chromium \fBdepot_tools\fR(7) 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\&.
.SH "NOTES"
.IP " 1." 4
here
.RS 4
\%https://chromium.googlesource.com/chromium/tools/depot_tools.git
.RE