Gitiles
Code Review Sign In
gerrit.openfyde.cn / chromium.googlesource.com / chromium / tools / depot_tools / 2d8c977b8e1c6bb5929b27527e6ec46636157b34 / . / docs / man7 / depot_tools.7
blob: 7fd2128ed40bcb4b9cc627c68bbef0427ba04135 [file] [log] [blame]
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000[diff] [blame]1'\" t
2.\" Title: depot_tools
3.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
iannucci@chromium.org95801c72014-03-26 19:20:34 +0000[diff] [blame]4.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5.\" Date: 03/26/2014
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000[diff] [blame]6.\" Manual: Chromium depot_tools Manual
iannucci@chromium.org95801c72014-03-26 19:20:34 +0000[diff] [blame]7.\" Source: depot_tools 9c0c59f
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000[diff] [blame]8.\" Language: English
9.\"
iannucci@chromium.org95801c72014-03-26 19:20:34 +0000[diff] [blame]10.TH "DEPOT_TOOLS" "7" "03/26/2014" "depot_tools 9c0c59f" "Chromium depot_tools Manual"
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000[diff] [blame]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"
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"
42.PP
43\fBgit-freeze\fR(1)
44.RS 4
45Freeze all changes on a branch (indexed and unindexed)\&.
46.RE
47.PP
48\fBgit-map-branches\fR(1)
49.RS 4
50Helper script to display all local git branches with \(oqupstream\(cq hierarchy in colorized terminal format\&.
51.RE
52.PP
53\fBgit-map\fR(1)
54.RS 4
55Display history of all branches in a colorized terminal format\&.
56.RE
57.PP
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +0000[diff] [blame]58\fBgit-mark-merge-base\fR(1)
59.RS 4
60Manually interact with depot_tools\*(Aq merge\-base markers\&.
61.RE
62.PP
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000[diff] [blame]63\fBgit-nav-downstream\fR(1)
64.RS 4
65Checkout a downstream branch of the currently checked out branch\&.
66.RE
67.PP
68\fBgit-nav-upstream\fR(1)
69.RS 4
70Checkout the upstream branch of the currently checked out branch\&.
71.RE
72.PP
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +0000[diff] [blame]73\fBgit-new-branch\fR(1)
74.RS 4
75Create a new branch with correct tracking information\&.
76.RE
77.PP
78\fBgit-rebase-update\fR(1)
79.RS 4
80Updates all branches to have the latest changes from their upstreams\&.
81.RE
82.PP
83\fBgit-rename-branch\fR(1)
84.RS 4
85Rename a branch and correctly preserve all downstream relationships\&.
86.RE
87.PP
88\fBgit-reparent-branch\fR(1)
89.RS 4
90Alter the parentage (upstream) for the current branch\&.
91.RE
92.PP
93\fBgit-squash-branch\fR(1)
94.RS 4
95Takes all commits in a single branch and replaces them with a single commit\&.
96.RE
97.PP
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000[diff] [blame]98\fBgit-thaw\fR(1)
99.RS 4
100Un\-freeze all changes on a frozen branch\&.
101.RE
iannucci@chromium.orgc050a5b2014-03-26 06:18:50 +0000[diff] [blame]102.PP
103\fBgit-upstream-diff\fR(1)
104.RS 4
105Print a diff of the current branch, compared to its upstream\&.
106.RE
iannucci@chromium.orga5d95022014-03-25 21:30:37 +0000[diff] [blame]107.SH "NOTES"
108.IP " 1." 4
109here
110.RS 4
111\%https://chromium.googlesource.com/chromium/tools/depot_tools.git
112.RE