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

Side by Side 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 unified diff | 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 »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 '\" 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/>
5 .\" Date: 03/14/2014
6 .\" Manual: Chromium depot_tools Manual
7 .\" Source: depot_tools a57ed8f
8 .\" Language: English
9 .\"
10 .TH "GIT\-MAP" "1" "03/14/2014" "depot_tools a57ed8f" "Chromium depot_tools Manu al"
11 .\" -----------------------------------------------------------------
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"
31 git-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
40 Git 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 .\}
50 Current branch is
51 cyan\&.
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 .\}
62 Local branches are
63 green\&.
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 .\}
74 Remote branches are
75 red\&.
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 .\}
86 Tags are
87 magenta\&.
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 .\}
98 The currently checked out commit is highlighted with a
99 blue background\&.
100 .RE
101 .sp
102 The output is automatically piped through the less pager command, even on window s\&.
103 .SH "OPTIONS"
104 .PP
105 <extra_args>\&...
106 .RS 4
107 Extra parameters to pass to the internal
108 \fBgit-log\fR(1)
109 invocation\&. This can be used to restrict what refs
110 \fIgit map\fR
111 operates on, etc\&.
112 .sp
113 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
114 CONFIGURATION VARIABLES)
115 .RE
116 .SH "CONFIGURATION VARIABLES"
117 .SS "depot_tools\&.map_extra"
118 .sp
119 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 t o configure this, use git config \-\-add depot_tools\&.map_extra <value> to do s o\&.
120 .SH "EXAMPLE"
121 .sp
122 Running \fIgit map\fR would result in an output something like:
123 .sp
124 .if n \{\
125 .RS 4
126 .\}
127 .nf
128 \fB$ git map\fR
129 *\:\fB 7dcfe47 \fR (\:\fBfrozen_changes\fR\:) 2014\-03\-12 ~ FREEZE\&.unin dexed
130 * \fB4b0c180\fR 2014\-03\-12 ~ modfile
131 * \fB59a7cca\fR 2014\-03\-12 ~ a deleted file
132 * \fB6bec695\fR (\:origin/master\:) 2014\-03\-11 ~ Add neat feature
133 * \fBd15a38a\fR 2014\-03\-11 ~ Epic README update
134 * \fBd559894\fR (\:\fBmaster\fR\:) 2014\-03\-11 ~ Important upstream chan ge
135 | * \fB9c311fd\fR (\:\fBcool_feature\fR\:) 2014\-03\-11 ~ Respond to CL com ments
136 | | * \fB2a1eeb2\fR (\:\fBsubfeature\fR\:) 2014\-03\-11 ~ integrate with Cool Service
137 | | * \fBd777af6\fR 2014\-03\-11 ~ slick commenting action
138 | |/
139 | * \fB265803a\fR 2014\-03\-11 ~ another improvement
140 | * \fB6d831ac\fR (\:\fBspleen_tag\fR\:) 2014\-03\-11 ~ Refactor spleen
141 | * \fB82e74ab\fR 2014\-03\-11 ~ Add widget
142 |/
143 * \fBd08c5b3\fR (\:\fBbogus_noparent\fR\:) 2014\-03\-11 ~ Wonderful begin nings
144 .fi
145 .if n \{\
146 .RE
147 .\}
148 .sp
149 .sp
150 As you can see, the structure of the commit history is visible, particularly wha t the parents of each commit are\&. In order to see the \fIupstream\fR relations hips of the branches (i\&.e\&. which branch is tracking which other branch), use the \fBgit-map-branches\fR(1) command\&.
151 .SH "SEE ALSO"
152 .sp
153 \fBgit-map-branches\fR(1)
154 .SH "CHROMIUM DEPOT_TOOLS"
155 .sp
156 Part of the chromium \fBdepot_tools\fR(1) suite\&. These tools are meant to assi st with the development of chromium and related projects\&. Download the tools f rom \m[blue]\fBhere\fR\m[]\&\s-2\u[1]\d\s+2\&.
157 .SH "NOTES"
158 .IP " 1." 4
159 here
160 .RS 4
161 \%https://chromium.googlesource.com/chromium/tools/depot_tools.git
162 .RE
OLDNEW
« 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