Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2595)

Unified Diff: docs/man1/git-map.1

Issue 200903002: Add documentation for git-map-branches, git-map, git-nav-downstream, (Closed) Base URL: https://chromium.googlesource.com/chromium/tools/depot_tools.git@documentation
Patch Set: rebase Created 6 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « docs/man1/git-freeze.1 ('k') | docs/man1/git-map-branches.1 » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: docs/man1/git-map.1
diff --git a/docs/man1/git-map.1 b/docs/man1/git-map.1
new file mode 100644
index 0000000000000000000000000000000000000000..e4921c004057e3c45e2feade29da56d254e292a0
--- /dev/null
+++ b/docs/man1/git-map.1
@@ -0,0 +1,162 @@
+'\" 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: 03/14/2014
+.\" Manual: Chromium depot_tools Manual
+.\" Source: depot_tools a57ed8f
+.\" Language: English
+.\"
+.TH "GIT\-MAP" "1" "03/14/2014" "depot_tools a57ed8f" "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
+.\}
+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 7dcfe47 \fR (\:\fBfrozen_changes\fR\:) 2014\-03\-12 ~ FREEZE\&.unindexed
+* \fB4b0c180\fR 2014\-03\-12 ~ modfile
+* \fB59a7cca\fR 2014\-03\-12 ~ a deleted file
+* \fB6bec695\fR (\:origin/master\:) 2014\-03\-11 ~ Add neat feature
+* \fBd15a38a\fR 2014\-03\-11 ~ Epic README update
+* \fBd559894\fR (\:\fBmaster\fR\:) 2014\-03\-11 ~ Important upstream change
+| * \fB9c311fd\fR (\:\fBcool_feature\fR\:) 2014\-03\-11 ~ Respond to CL comments
+| | * \fB2a1eeb2\fR (\:\fBsubfeature\fR\:) 2014\-03\-11 ~ integrate with CoolService
+| | * \fBd777af6\fR 2014\-03\-11 ~ slick commenting action
+| |/
+| * \fB265803a\fR 2014\-03\-11 ~ another improvement
+| * \fB6d831ac\fR (\:\fBspleen_tag\fR\:) 2014\-03\-11 ~ Refactor spleen
+| * \fB82e74ab\fR 2014\-03\-11 ~ Add widget
+|/
+* \fBd08c5b3\fR (\:\fBbogus_noparent\fR\:) 2014\-03\-11 ~ Wonderful beginnings
+.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(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\&.
+.SH "NOTES"
+.IP " 1." 4
+here
+.RS 4
+\%https://chromium.googlesource.com/chromium/tools/depot_tools.git
+.RE
« no previous file with comments | « docs/man1/git-freeze.1 ('k') | docs/man1/git-map-branches.1 » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698