Minor fixes
BUG=
Review URL: https://codereview.chromium.org/268543013
git-svn-id: svn://svn.chromium.org/chrome/trunk/tools/depot_tools@273851 0039d316-1c4b-4281-b951-d872f2087c98
diff --git a/man/html/depot_tools_tutorial.html b/man/html/depot_tools_tutorial.html
index 6a0d578..ffe62c1 100644
--- a/man/html/depot_tools_tutorial.html
+++ b/man/html/depot_tools_tutorial.html
@@ -988,7 +988,7 @@
<strong><span class="white">$ gclient sync</span></strong>
<strong><span class="white">$</span></strong> # Make a new change and upload it for review
-<strong><span class="white">$ git new-branch branchname</span></strong>
+<strong><span class="white">$ git new-branch <branch_name></span></strong>
<strong><span class="white">$</span></strong> # repeat: [edit, git add, git commit]
<strong><span class="white">$ git cl upload</span></strong>
@@ -1017,7 +1017,8 @@
<pre><code><strong><span class="white">.gclient</span></strong> # A configuration file for you source checkout
<strong><span class="white">src/</span></strong> # Top-level Chromium source checkout.</code></pre>
</div></div>
-<div class="paragraph"><p>If you are on linux, then you’ll need to run:</p></div>
+<div class="paragraph"><p>If you are on linux and fetching the code for the first time, then you’ll need
+to run:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ cd src && ./build/install-build-deps.sh</span></strong></code></pre>
@@ -1028,7 +1029,8 @@
<pre><code><strong><span class="white">$ gclient sync</span></strong></code></pre>
</div></div>
<div class="paragraph"><p>This will pull all dependencies of the Chromium src checkout. You will need
-to run this any time you update the main src checkout.</p></div>
+to run this any time you update the main src checkout, including when you
+switch branches.</p></div>
</div>
</div>
<div class="sect1">
@@ -1044,23 +1046,23 @@
</tr></table>
</div>
<div class="paragraph"><p>Each CL corresponds exactly with a single branch in git. Any time you want to
-begin a new CL, just:</p></div>
+begin a new CL:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git new-branch <branch_name></span></strong></code></pre>
</div></div>
<div class="paragraph"><p>This will create and checkout a new branch named <code>branch_name</code> which will track
-the default upstream (which is <code>origin/master</code>). See <a href="git-new-branch.html">git-new-branch(1)</a>
-for more features, such as the ability to track <em>LKGR</em>.</p></div>
+the default upstream branch (<code>origin/master</code>). See
+<a href="git-new-branch.html">git-new-branch(1)</a> for more features.</p></div>
<div class="paragraph"><p>Commit as many changes as you like to this branch. When you want to upload it
for review, run:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><strong><span class="white">$ git cl upload</span></strong></code></pre>
</div></div>
-<div class="paragraph"><p>This will take the diff of your branch against its upstream (<code>origin/master</code>),
-and will post it to the <a href="https://codereview.chromium.org">Chromium code
-review site</a>.</p></div>
+<div class="paragraph"><p>This will take the diff of your branch against its upstream branch (in that
+case origin/master), and will post it to the
+<a href="https://codereview.chromium.org">Chromium code review site</a>.</p></div>
</div>
</div>
<div class="sect1">
@@ -1115,7 +1117,7 @@
<div class="sectionbody">
<div class="paragraph"><p>Sometimes you want to work on more than one CL at once (say, you have a CL
posted for review and want to work on something else). For each CL that you
-want to work on, just use <code>git new-branch <branchname></code>.</p></div>
+want to work on, just use <code>git new-branch <branch_name></code>.</p></div>
<div class="paragraph"><p>Once you start to have more than one CL at a time, it can be easy to lose your
bearings. Fortunately, <em>depot_tools</em> has two tools to help you out:</p></div>
<div class="listingblock">
@@ -1164,7 +1166,7 @@
</dt>
<dd>
<p>
- This tool just shows you which branches you have in your repo, and thier
+ This tool just shows you which branches you have in your repo, and their
upstream relationship to each other (as well as which branch you have checked
out at the moment).
</p>
@@ -1236,9 +1238,9 @@
</code></pre></div></div><p><div class="paragraph"> Let's fix something!</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #ffffff">$ git new-branch fix_typo</span>
<span style="font-weight: bold; color: #ffffff">$ echo -e '/Banana\ns/Banana/Kuun\nwq' | ed build/whitespace_file.txt</span>
1503
+1501
It was a Domo-Banana.
It was a Domo-Kuun.
-1501
<span style="font-weight: bold; color: #ffffff">$ git commit -am 'Fix terrible typo.'</span>
[fix_typo 615ffa7] Fix terrible typo.
1 file changed, 1 insertion(+), 1 deletion(-)
@@ -1252,10 +1254,10 @@
* <span style="font-weight: bold; color: #e42e16">2250f53 </span><span style="color: #19c518"></span> <span style="color: #e7e71c">2014-04-10</span> ~ ozone: evdev: Filter devices by path
* <span style="font-weight: bold; color: #e42e16">33a7a74 </span><span style="color: #19c518"></span> <span style="color: #e7e71c">2014-04-10</span> ~ Always output seccomp error messages to stderr
<span style="font-weight: bold; color: #ffffff">$ git status</span>
-On branch fix_typo
-Your branch is ahead of 'origin/master' by 1 commit.
- (use "git push" to publish your local commits)
-
+# On branch fix_typo
+# Your branch is ahead of 'origin/master' by 1 commit.
+# (use "git push" to publish your local commits)
+#
nothing to commit, working directory clean
<span style="font-weight: bold; color: #ffffff">$ git cl upload -r domo@chromium.org --send-mail</span>
... truncated output ...
@@ -1271,15 +1273,15 @@
when the fan was last cleaned.
EOF
<span style="font-weight: bold; color: #ffffff">$ git status</span>
-On branch chap2
-Your branch is up-to-date with 'origin/master'.
-
-Changes not staged for commit:
- (use "git add <file>..." to update what will be committed)
- (use "git checkout -- <file>..." to discard changes in working directory)
-
- <span style="color: #e42e16">modified: build/whitespace_file.txt</span>
-
+# On branch chap2
+# Your branch is up-to-date with 'origin/master'.
+#
+# Changes not staged for commit:
+# (use "git add <file>..." to update what will be committed)
+# (use "git checkout -- <file>..." to discard changes in working directory)
+#
+# <span style="color: #e42e16">modified: build/whitespace_file.txt</span>
+#
no changes added to commit (use "git add" and/or "git commit -a")
</code></pre></div></div><p><div class="paragraph"> Someone on the code review pointed out that our typo-fix has a typo :( We're still working on 'chap2' but we really want to land 'fix_typo', so let's switch over and fix it.</p></div><div class="listingblock"><div class="content"><pre><code><span style="font-weight: bold; color: #ffffff">$ git freeze</span>
<span style="font-weight: bold; color: #ffffff">$ git checkout fix_typo</span>
@@ -1288,9 +1290,9 @@
(use "git push" to publish your local commits)
<span style="font-weight: bold; color: #ffffff">$ echo -e '/Kuun\ns/Kuun/Kun\nwq' | ed build/whitespace_file.txt</span>
1501
+1500
It was a Domo-Kuun.
It was a Domo-Kun.
-1500
<span style="font-weight: bold; color: #ffffff">$ git upstream-diff --wordwise</span>
<span style="font-weight: bold">diff --git a/build/whitespace_file.txt b/build/whitespace_file.txt</span>
<span style="font-weight: bold">index 3eba355..57cdcee 100644</span>
@@ -1579,7 +1581,7 @@
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2014-04-28 13:55:43 PDT
+Last updated 2014-05-09 17:43:43 PDT
</div>
</div>
</body>
diff --git a/man/man7/depot_tools_tutorial.7 b/man/man7/depot_tools_tutorial.7
index 1b57514..576370c 100644
--- a/man/man7/depot_tools_tutorial.7
+++ b/man/man7/depot_tools_tutorial.7
@@ -1,13 +1,13 @@
'\" t
.\" Title: depot_tools_tutorial
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 04/28/2014
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 05/09/2014
.\" Manual: Chromium depot_tools Manual
-.\" Source: depot_tools 32af7d9
+.\" Source: depot_tools 54dac93
.\" Language: English
.\"
-.TH "DEPOT_TOOLS_TUTORIAL" "7" "04/28/2014" "depot_tools 32af7d9" "Chromium depot_tools Manual"
+.TH "DEPOT_TOOLS_TUTORIAL" "7" "05/09/2014" "depot_tools 54dac93" "Chromium depot_tools Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -41,6 +41,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
Setting up
.RE
.sp
@@ -52,6 +53,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
Getting the code
.RE
.sp
@@ -63,6 +65,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
TL;DR
.RE
.sp
@@ -74,6 +77,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
Creating / Uploading a CL
.RE
.sp
@@ -85,6 +89,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
Updating the code
.RE
.sp
@@ -96,6 +101,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
Managing multiple CLs
.RE
.sp
@@ -107,6 +113,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
Managing dependent CLs
.RE
.sp
@@ -118,6 +125,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
Example Walkthrough
.RE
.sp
@@ -150,6 +158,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
\m[blue]\fBThink like (a) Git\fR\m[]\&\s-2\u[1]\d\s+2
\- A lighthearted overview of git\&. If you\(cqre sorta\-familiar with git, but not
\fIcomfortable\fR
@@ -164,6 +173,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
\m[blue]\fBGit Immersion Tutorial\fR\m[]\&\s-2\u[2]\d\s+2
\- An in\-depth git tutorial\&.
.RE
@@ -176,6 +186,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
\m[blue]\fBpcottle\(cqs Visual Git Branching\fR\m[]\&\s-2\u[3]\d\s+2
\- An excellent interactive/graphical demo on how git handles commits, branches, and shows the operations git performs on them\&.
.RE
@@ -188,6 +199,7 @@
.sp -1
.IP \(bu 2.3
.\}
+
\m[blue]\fBPro Git book\fR\m[]\&\s-2\u[4]\d\s+2
\- \(lqThe\(rq book for learning git from basics to advanced concepts\&. A bit dry, but very through\&.
.RE
@@ -267,7 +279,7 @@
\fB$ gclient sync\fR
\fB$\fR # Make a new change and upload it for review
-\fB$ git new\-branch branchname\fR
+\fB$ git new\-branch <branch_name>\fR
\fB$\fR # repeat: [edit, git add, git commit]
\fB$ git cl upload\fR
@@ -312,7 +324,7 @@
.\}
.sp
.sp
-If you are on linux, then you\(cqll need to run:
+If you are on linux and fetching the code for the first time, then you\(cqll need to run:
.sp
.if n \{\
.RS 4
@@ -338,7 +350,7 @@
.\}
.sp
.sp
-This will pull all dependencies of the Chromium src checkout\&. You will need to run this any time you update the main src checkout\&.
+This will pull all dependencies of the Chromium src checkout\&. You will need to run this any time you update the main src checkout, including when you switch branches\&.
.SH "CREATING / UPLOADING A CL"
.if n \{\
.sp
@@ -357,7 +369,7 @@
.sp .5v
.RE
.sp
-Each CL corresponds exactly with a single branch in git\&. Any time you want to begin a new CL, just:
+Each CL corresponds exactly with a single branch in git\&. Any time you want to begin a new CL:
.sp
.if n \{\
.RS 4
@@ -370,7 +382,7 @@
.\}
.sp
.sp
-This will create and checkout a new branch named branch_name which will track the default upstream (which is origin/master)\&. See \fBgit-new-branch\fR(1) for more features, such as the ability to track \fILKGR\fR\&.
+This will create and checkout a new branch named branch_name which will track the default upstream branch (origin/master)\&. See \fBgit-new-branch\fR(1) for more features\&.
.sp
Commit as many changes as you like to this branch\&. When you want to upload it for review, run:
.sp
@@ -385,7 +397,7 @@
.\}
.sp
.sp
-This will take the diff of your branch against its upstream (origin/master), and will post it to the \m[blue]\fBChromium code review site\fR\m[]\&\s-2\u[5]\d\s+2\&.
+This will take the diff of your branch against its upstream branch (in that case origin/master), and will post it to the \m[blue]\fBChromium code review site\fR\m[]\&\s-2\u[5]\d\s+2\&.
.SH "UPDATING THE CODE"
.sp
Inevitably, you\(cqll want to pull in changes from the main Chromium repo\&. This is pretty easy with \fIdepot_tools\fR:
@@ -426,7 +438,7 @@
.RE
.SH "MANAGING MULTIPLE CLS"
.sp
-Sometimes you want to work on more than one CL at once (say, you have a CL posted for review and want to work on something else)\&. For each CL that you want to work on, just use git new\-branch <branchname>\&.
+Sometimes you want to work on more than one CL at once (say, you have a CL posted for review and want to work on something else)\&. For each CL that you want to work on, just use git new\-branch <branch_name>\&.
.sp
Once you start to have more than one CL at a time, it can be easy to lose your bearings\&. Fortunately, \fIdepot_tools\fR has two tools to help you out:
.sp
@@ -473,7 +485,6 @@
.RE
.\}
.sp
-
.PP
\fBgit-map\fR(1)
.RS 4
@@ -482,7 +493,7 @@
.PP
\fBgit-map-branches\fR(1)
.RS 4
-This tool just shows you which branches you have in your repo, and thier upstream relationship to each other (as well as which branch you have checked out at the moment)\&.
+This tool just shows you which branches you have in your repo, and their upstream relationship to each other (as well as which branch you have checked out at the moment)\&.
.RE
.sp
Additionally, sometimes you need to switch between branches, but you\(cqve got work in progress\&. You could use \fBgit-stash\fR(1), but that can be tricky to manage because you need to remember which branches you stashed what changes on\&. Helpfully \fIdepot_tools\fR includes two tools which can greatly assist in case:
@@ -567,9 +578,9 @@
\fB$ git new\-branch fix_typo\fR
\fB$ echo \-e \*(Aq/Banana\ens/Banana/Kuun\enwq\*(Aq | ed build/whitespace_file\&.txt\fR
1503
+1501
It was a Domo\-Banana\&.
It was a Domo\-Kuun\&.
-1501
\fB$ git commit \-am \*(AqFix terrible typo\&.\*(Aq\fR
[fix_typo 615ffa7] Fix terrible typo\&.
1 file changed, 1 insertion(+), 1 deletion(\-)
@@ -583,10 +594,10 @@
* \fB2250f53 \fR 2014\-04\-10 ~ ozone: evdev: Filter devices by path
* \fB33a7a74 \fR 2014\-04\-10 ~ Always output seccomp error messages to stderr
\fB$ git status\fR
-On branch fix_typo
-Your branch is ahead of \*(Aqorigin/master\*(Aq by 1 commit\&.
- (use "git push" to publish your local commits)
-
+# On branch fix_typo
+# Your branch is ahead of \*(Aqorigin/master\*(Aq by 1 commit\&.
+# (use "git push" to publish your local commits)
+#
nothing to commit, working directory clean
\fB$ git cl upload \-r domo@chromium\&.org \-\-send\-mail\fR
\&.\&.\&. truncated output \&.\&.\&.
@@ -613,15 +624,15 @@
when the fan was last cleaned\&.
EOF
\fB$ git status\fR
-On branch chap2
-Your branch is up\-to\-date with \*(Aqorigin/master\*(Aq\&.
-
-Changes not staged for commit:
- (use "git add <file>\&.\&.\&." to update what will be committed)
- (use "git checkout \-\- <file>\&.\&.\&." to discard changes in working directory)
-
- modified: build/whitespace_file\&.txt
-
+# On branch chap2
+# Your branch is up\-to\-date with \*(Aqorigin/master\*(Aq\&.
+#
+# Changes not staged for commit:
+# (use "git add <file>\&.\&.\&." to update what will be committed)
+# (use "git checkout \-\- <file>\&.\&.\&." to discard changes in working directory)
+#
+# modified: build/whitespace_file\&.txt
+#
no changes added to commit (use "git add" and/or "git commit \-a")
.fi
.if n \{\
@@ -641,9 +652,9 @@
(use "git push" to publish your local commits)
\fB$ echo \-e \*(Aq/Kuun\ens/Kuun/Kun\enwq\*(Aq | ed build/whitespace_file\&.txt\fR
1501
+1500
It was a Domo\-Kuun\&.
It was a Domo\-Kun\&.
-1500
\fB$ git upstream\-diff \-\-wordwise\fR
\fBdiff \-\-git a/build/whitespace_file\&.txt b/build/whitespace_file\&.txt\fR
\fBindex 3eba355\&.\&.57cdcee 100644\fR
diff --git a/man/src/depot_tools_tutorial.txt b/man/src/depot_tools_tutorial.txt
index 91d65e9..64ad485 100644
--- a/man/src/depot_tools_tutorial.txt
+++ b/man/src/depot_tools_tutorial.txt
@@ -156,7 +156,7 @@
[white]**$ gclient sync**
[white]**$** # Make a new change and upload it for review
-[white]**$ git new-branch branchname**
+[white]**$ git new-branch <branch_name>**
[white]**$** # repeat: [edit, git add, git commit]
[white]**$ git cl upload**
@@ -188,7 +188,8 @@
[white]**src/** # Top-level Chromium source checkout.
----
-If you are on linux, then you'll need to run:
+If you are on linux and fetching the code for the first time, then you'll need
+to run:
[subs="specialcharacters,quotes"]
----
@@ -203,7 +204,8 @@
----
This will pull all dependencies of the Chromium src checkout. You will need
-to run this any time you update the main src checkout.
+to run this any time you update the main src checkout, including when you
+switch branches.
CREATING / UPLOADING A CL
@@ -212,7 +214,7 @@
is the `src/` folder mentioned in <<_getting_the_code,Getting the code>>.
Each CL corresponds exactly with a single branch in git. Any time you want to
-begin a new CL, just:
+begin a new CL:
[subs="specialcharacters,quotes"]
----
@@ -220,8 +222,8 @@
----
This will create and checkout a new branch named `branch_name` which will track
-the default upstream (which is `origin/master`). See linkgit:git-new-branch[1]
-for more features, such as the ability to track 'LKGR'.
+the default upstream branch (`origin/master`). See
+linkgit:git-new-branch[1] for more features.
Commit as many changes as you like to this branch. When you want to upload it
for review, run:
@@ -231,9 +233,9 @@
[white]**$ git cl upload**
----
-This will take the diff of your branch against its upstream (`origin/master`),
-and will post it to the link:https://codereview.chromium.org[Chromium code
-review site].
+This will take the diff of your branch against its upstream branch (in that
+case origin/master), and will post it to the
+link:https://codereview.chromium.org[Chromium code review site].
UPDATING THE CODE
@@ -286,7 +288,7 @@
---------------------
Sometimes you want to work on more than one CL at once (say, you have a CL
posted for review and want to work on something else). For each CL that you
-want to work on, just use `git new-branch <branchname>`.
+want to work on, just use `git new-branch <branch_name>`.
Once you start to have more than one CL at a time, it can be easy to lose your
bearings. Fortunately, 'depot_tools' has two tools to help you out:
@@ -329,7 +331,7 @@
doc for the full details.
linkgit:git-map-branches[1]::
- This tool just shows you which branches you have in your repo, and thier
+ This tool just shows you which branches you have in your repo, and their
upstream relationship to each other (as well as which branch you have checked
out at the moment).
