blob: d09a06d1fc43f2a6a6bab5f8c946eae324f83ad2 [file] [log] [blame]
iannucci@chromium.orga5d95022014-03-25 21:30:37 +00001'\" t
2.\" Title: depot_tools
3.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
iannucci@chromium.org21980022014-04-11 04:51:49 +00004.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5.\" Date: 04/10/2014
iannucci@chromium.orga5d95022014-03-25 21:30:37 +00006.\" Manual: Chromium depot_tools Manual
iannucci@chromium.org21980022014-04-11 04:51:49 +00007.\" Source: depot_tools 68b1017
iannucci@chromium.orga5d95022014-03-25 21:30:37 +00008.\" Language: English
9.\"
iannucci@chromium.org21980022014-04-11 04:51:49 +000010.TH "DEPOT_TOOLS" "7" "04/10/2014" "depot_tools 68b1017" "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"
31depot_tools \- A collection of tools for dealing with Chromium development\&.
32.SH "DESCRIPTION"
33.sp
34The Chromium depot_tools suite contains many tools to assist/augment the Chromium development environment\&. The tools may be downloaded from \m[blue]\fBhere\fR\m[]\&\s-2\u[1]\d\s+2\&.
35.sp
36There are two primary categories of tools\&. Some of these tools are \fIessential\fR to the development flow, in the sense that you cannot successfully develop Chromium without them\&.
37.sp
38Other tools are merely \fIhelper\fR tools\&. Not required, but they can substantially ease the develpment workflow\&.
39.sp
40A listing of both categories of tools follows\&.
41.SH "HELPER TOOLS"
iannucci@chromium.org21980022014-04-11 04:51:49 +000042.sp
43A tutorial for these tools can be found at \fBdepot_tools_tutorial\fR(7)\&.
iannucci@chromium.orga5d95022014-03-25 21:30:37 +000044.PP
45\fBgit-freeze\fR(1)
46.RS 4
47Freeze all changes on a branch (indexed and unindexed)\&.
48.RE
49.PP
50\fBgit-map-branches\fR(1)
51.RS 4
52Helper script to display all local git branches with \(oqupstream\(cq hierarchy in colorized terminal format\&.
53.RE
54.PP
55\fBgit-map\fR(1)
56.RS 4
57Display history of all branches in a colorized terminal format\&.
58.RE
59.PP
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +000060\fBgit-mark-merge-base\fR(1)
61.RS 4
62Manually interact with depot_tools\*(Aq merge\-base markers\&.
63.RE
64.PP
iannucci@chromium.orga5d95022014-03-25 21:30:37 +000065\fBgit-nav-downstream\fR(1)
66.RS 4
67Checkout a downstream branch of the currently checked out branch\&.
68.RE
69.PP
70\fBgit-nav-upstream\fR(1)
71.RS 4
72Checkout the upstream branch of the currently checked out branch\&.
73.RE
74.PP
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +000075\fBgit-new-branch\fR(1)
76.RS 4
77Create a new branch with correct tracking information\&.
78.RE
79.PP
80\fBgit-rebase-update\fR(1)
81.RS 4
82Updates all branches to have the latest changes from their upstreams\&.
83.RE
84.PP
85\fBgit-rename-branch\fR(1)
86.RS 4
87Rename a branch and correctly preserve all downstream relationships\&.
88.RE
89.PP
90\fBgit-reparent-branch\fR(1)
91.RS 4
92Alter the parentage (upstream) for the current branch\&.
93.RE
94.PP
95\fBgit-squash-branch\fR(1)
96.RS 4
97Takes all commits in a single branch and replaces them with a single commit\&.
98.RE
99.PP
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000100\fBgit-thaw\fR(1)
101.RS 4
102Un\-freeze all changes on a frozen branch\&.
103.RE
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +0000104.PP
105\fBgit-upstream-diff\fR(1)
106.RS 4
107Print a diff of the current branch, compared to its upstream\&.
108.RE
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000109.SH "NOTES"
110.IP " 1." 4
111here
112.RS 4
113\%https://chromium.googlesource.com/chromium/tools/depot_tools.git
114.RE