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

Side by Side Diff: docs/man1/git-map-branches.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-map.1 ('k') | docs/man1/git-nav-downstream.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-branches
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\-BRANCHES" "1" "03/14/2014" "depot_tools a57ed8f" "Chromium depot_ tools Manual"
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-branches \- Helper script to display all local git branches with \(oqups tream\(cq hierarchy in colorized terminal format\&.
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit map\-branches\fR
36 .fi
37 .sp
38 .SH "DESCRIPTION"
39 .sp
40 Git map\-branches displays all local branches 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 .sp
53 .RS 4
54 .ie n \{\
55 \h'-04'\(bu\h'+03'\c
56 .\}
57 .el \{\
58 .sp -1
59 .IP \(bu 2.3
60 .\}
61 The branch which will be modified with git\-commit is denoted with an asterisk ( *) after the name\&.
62 .RE
63 .RE
64 .sp
65 .RS 4
66 .ie n \{\
67 \h'-04'\(bu\h'+03'\c
68 .\}
69 .el \{\
70 .sp -1
71 .IP \(bu 2.3
72 .\}
73 Local branches are
74 green\&.
75 .RE
76 .sp
77 .RS 4
78 .ie n \{\
79 \h'-04'\(bu\h'+03'\c
80 .\}
81 .el \{\
82 .sp -1
83 .IP \(bu 2.3
84 .\}
85 Remote branches are
86 red
87 (usually, the root of all other branches)\&.
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 {NO UPSTREAM}
99 is a special placeholder in
100 magenta\&.
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 .\}
110 Branches which have this as their parent are usually misconfigured, and should b e assigned a parent by checking out the branch and running git branch \-\-set\-u pstream\-to=<correct parent branch>\&.
111 .RE
112 .RE
113 .if n \{\
114 .sp
115 .\}
116 .RS 4
117 .it 1 an-trap
118 .nr an-no-space-flag 1
119 .nr an-break-flag 1
120 .br
121 .ps +1
122 \fBNote\fR
123 .ps -1
124 .br
125 .sp
126 If multiple branches are on the same commit, they will all be cyan\&.
127 .sp .5v
128 .RE
129 .SH "EXAMPLE"
130 .sp
131 Given the hypothetical demo repo in \fBgit-map\fR(1)\*(Aqs EXAMPLE section, and assuming that the frozen_changes branch was currently checked out, running \fIgi t map\-branches\fR would result in an output like:
132 .sp
133 .if n \{\
134 .RS 4
135 .\}
136 .nf
137 \fB$ git map\-branches\fR
138 origin/master
139 cool_feature
140 subfeature
141 frozen_changes *
142 master
143 {NO UPSTREAM}
144 bogus_noparent
145 duplicate_cool_feature_no_upstream
146 .fi
147 .if n \{\
148 .RE
149 .\}
150 .sp
151 .SH "SEE ALSO"
152 .sp
153 \fBgit-map\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-map.1 ('k') | docs/man1/git-nav-downstream.1 » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698