From 6f9c7cfb79e13b2e990fa48eb8524b520962ac8d Mon Sep 17 00:00:00 2001 From: "mmoss@chromium.org" Date: Tue, 9 Sep 2014 21:06:30 +0000 Subject: [PATCH] Clear up some git-drover docs confusion. TBR=iannucci@chromium.org Review URL: https://codereview.chromium.org/561433002 git-svn-id: svn://svn.chromium.org/chrome/trunk/tools/depot_tools@291889 0039d316-1c4b-4281-b951-d872f2087c98 --- man/html/git-drover.html | 33 ++++++++++++++-------------- man/man1/git-drover.1 | 36 +++++++++++++++---------------- man/src/git-drover.demo.1.sh | 6 +++--- man/src/git-drover.demo.common.sh | 2 +- man/src/git-drover.txt | 3 +-- 5 files changed, 39 insertions(+), 41 deletions(-) diff --git a/man/html/git-drover.html b/man/html/git-drover.html index 0ffa5f25f3..fc5366d743 100644 --- a/man/html/git-drover.html +++ b/man/html/git-drover.html @@ -780,9 +780,9 @@ at least once to fetch the branches.

# Make sure we have the most up-to-date branch sources.
 $ git fetch
 
-# Here's the commit we want to 'drover'.
+# Here's a commit (from some.committer) that we want to 'drover'.
 $ git log -n 1 --pretty=fuller
-commit 1077c7acbc1f1881d5181f6b1eaf4d0c6cd92543
+commit 4a00a0c3c1bb01f11b42cb70f3ad587026cec02b
 Author:     some.committer <some.committer@chromium.org>
 AuthorDate: Thu Apr 10 08:54:46 2014 +0000
 Commit:     some.committer <some.committer@chromium.org>
@@ -796,25 +796,25 @@ Branch drover_9999 set up to track remote ref refs/branch-heads/9999.
 
 # Now do the 'drover'.
 # IMPORTANT!!! Do Not leave off the '-x' flag
-$ git cherry-pick -x 1077c7acbc1f1881d5181f6b1eaf4d0c6cd92543
-[drover_9999 1d9c1a1] This change needs to go to branch 9999
+$ git cherry-pick -x 4a00a0c3c1bb01f11b42cb70f3ad587026cec02b
+[drover_9999 19d3d0b] This change needs to go to branch 9999
  Author: some.committer <some.committer@chromium.org>
  Date: Thu Apr 10 08:54:46 2014 +0000
  1 file changed, 1 insertion(+)
  create mode 100644 modified_file
 
-# That took the code authored by some.commiter and commited it to the
-# branch by branch.maintainer (us).
+# That took the code authored by some.committer and committed it to
+# the branch by the person who drovered it (i.e. you).
 $ git log -n 1 --pretty=fuller
-commit 1d9c1a1b768f2248c884495f4d47739c2ff249f7
+commit 19d3d0b9d8f802df8e2fd563cbc919679d310ecd
 Author:     some.committer <some.committer@chromium.org>
 AuthorDate: Thu Apr 10 08:54:46 2014 +0000
-Commit:     branch.maintainer <branch.maintainer@chromium.org>
+Commit:     you <you@chromium.org>
 CommitDate: Thu Apr 10 09:11:36 2014 +0000
 
     This change needs to go to branch 9999
 
-    (cherry picked from commit 1077c7acbc1f1881d5181f6b1eaf4d0c6cd92543)
+    (cherry picked from commit 4a00a0c3c1bb01f11b42cb70f3ad587026cec02b)
 
 # Looks good. Ship it!
 $ git cl upload
@@ -834,24 +834,24 @@ Branch drover_9999 set up to track remote ref refs/branch-heads/9999.
 
 # Here's the commit we want to revert.
 $ git log -n 1
-commit aca17ebfc070673e98afb6d36f6028eae6b0b8ca
+commit 590b333cbc04d13da67b2a1c5282835d4f27e398
 Author: some.committer <some.committer@chromium.org>
 Date:   Thu Apr 10 08:54:46 2014 +0000
 
     This change is horribly broken.
 
 # Now do the revert.
-$ git revert aca17ebfc070673e98afb6d36f6028eae6b0b8ca
+$ git revert 590b333cbc04d13da67b2a1c5282835d4f27e398
 
 # That reverted the change and committed the revert.
 $ git log -n 1
-commit d27f8f3fd56621c5e3a92cb5e64100e2bc2137a2
-Author: branch.maintainer <branch.maintainer@chromium.org>
+commit 6f541155a9adf98f4e7f94dd561d022fb022d43f
+Author: you <you@chromium.org>
 Date:   Thu Apr 10 09:11:36 2014 +0000
 
     Revert "This change is horribly broken."
 
-    This reverts commit aca17ebfc070673e98afb6d36f6028eae6b0b8ca.
+    This reverts commit 590b333cbc04d13da67b2a1c5282835d4f27e398.
 
 # As with old drover, reverts are generally OK to commit without LGTM.
 $ git cl upload -r some.committer@chromium.org --send-mail
@@ -864,8 +864,7 @@ Date:   Thu Apr 10 09:11:36 2014 +0000
 

 
SEE ALSO

 

-
git-cherry-pick(1)
-git-revert(1)

+
git-cherry-pick(1), git-revert(1)

 

 

 

@@ -880,7 +879,7 @@ from 
 

 
 
diff --git a/man/man1/git-drover.1 b/man/man1/git-drover.1
index b9532c65f3..17779cc869 100644
--- a/man/man1/git-drover.1
+++ b/man/man1/git-drover.1
@@ -2,12 +2,12 @@
 .\"     Title: git-drover
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 
-.\"      Date: 09/05/2014
+.\"      Date: 09/09/2014
 .\"    Manual: Chromium depot_tools Manual
-.\"    Source: depot_tools 2171f9c
+.\"    Source: depot_tools 6e7202b
 .\"  Language: English
 .\"
-.TH "GIT\-DROVER" "1" "09/05/2014" "depot_tools 2171f9c" "Chromium depot_tools Manual"
+.TH "GIT\-DROVER" "1" "09/09/2014" "depot_tools 6e7202b" "Chromium depot_tools Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -60,9 +60,9 @@ Before working with branches, you must \fIgclient sync \-\-with_branch_heads\fR
 # Make sure we have the most up\-to\-date branch sources\&.
 \fB$ git fetch\fR
 
-# Here\*(Aqs the commit we want to \*(Aqdrover\*(Aq\&.
+# Here\*(Aqs a commit (from some\&.committer) that we want to \*(Aqdrover\*(Aq\&.
 \fB$ git log \-n 1 \-\-pretty=fuller\fR
-commit 14293306d7969cff815969e2502f47794a63fbc5
+commit 0421d3583f73220c8f88b1a96898fcd81222fe73
 Author:     some\&.committer 
 AuthorDate: Thu Apr 10 08:54:46 2014 +0000
 Commit:     some\&.committer 
@@ -76,25 +76,25 @@ Branch drover_9999 set up to track remote ref refs/branch\-heads/9999\&.
 
 # Now do the \*(Aqdrover\*(Aq\&.
 # IMPORTANT!!! Do Not leave off the \*(Aq\-x\*(Aq flag
-\fB$ git cherry\-pick \-x 14293306d7969cff815969e2502f47794a63fbc5\fR
-[drover_9999 3200a8c] This change needs to go to branch 9999
+\fB$ git cherry\-pick \-x 0421d3583f73220c8f88b1a96898fcd81222fe73\fR
+[drover_9999 5c0a17d] This change needs to go to branch 9999
  Author: some\&.committer 
  Date: Thu Apr 10 08:54:46 2014 +0000
  1 file changed, 1 insertion(+)
  create mode 100644 modified_file
 
-# That took the code authored by some\&.commiter and commited it to the
-# branch by branch\&.maintainer (us)\&.
+# That took the code authored by some\&.committer and committed it to
+# the branch by the person who drovered it (i\&.e\&. you)\&.
 \fB$ git log \-n 1 \-\-pretty=fuller\fR
-commit 3200a8cb2072a7c84aaba52baaecbf5e4d17ad00
+commit 5c0a17dd382cd098182ac9f486ccd6b86c28d96e
 Author:     some\&.committer 
 AuthorDate: Thu Apr 10 08:54:46 2014 +0000
-Commit:     branch\&.maintainer 
+Commit:     you 
 CommitDate: Thu Apr 10 09:11:36 2014 +0000
 
     This change needs to go to branch 9999
 
-    (cherry picked from commit 14293306d7969cff815969e2502f47794a63fbc5)
+    (cherry picked from commit 0421d3583f73220c8f88b1a96898fcd81222fe73)
 
 # Looks good\&. Ship it!
 \fB$ git cl upload\fR
@@ -131,24 +131,24 @@ Branch drover_9999 set up to track remote ref refs/branch\-heads/9999\&.
 
 # Here\*(Aqs the commit we want to revert\&.
 \fB$ git log \-n 1\fR
-commit 4803efead17077ecd40440caef2e78d1c66098cf
+commit 28bb44fa7f9d5e19b73a670ae923d3a96dec250a
 Author: some\&.committer 
 Date:   Thu Apr 10 08:54:46 2014 +0000
 
     This change is horribly broken\&.
 
 # Now do the revert\&.
-\fB$ git revert 4803efead17077ecd40440caef2e78d1c66098cf\fR
+\fB$ git revert 28bb44fa7f9d5e19b73a670ae923d3a96dec250a\fR
 
 # That reverted the change and committed the revert\&.
 \fB$ git log \-n 1\fR
-commit 52350f2809ce71352326f1518feae57ac5152f18
-Author: branch\&.maintainer 
+commit 4618467de1407aa159624015c8c8461ec35fbaf1
+Author: you 
 Date:   Thu Apr 10 09:11:36 2014 +0000
 
     Revert "This change is horribly broken\&."
 
-    This reverts commit 4803efead17077ecd40440caef2e78d1c66098cf\&.
+    This reverts commit 28bb44fa7f9d5e19b73a670ae923d3a96dec250a\&.
 
 # As with old drover, reverts are generally OK to commit without LGTM\&.
 \fB$ git cl upload \-r some\&.committer@chromium\&.org \-\-send\-mail\fR
@@ -161,7 +161,7 @@ Date:   Thu Apr 10 09:11:36 2014 +0000
 .RE
 .SH "SEE ALSO"
 .sp
-\fBgit-cherry-pick\fR(1) \fBgit-revert\fR(1)
+\fBgit-cherry-pick\fR(1), \fBgit-revert\fR(1)
 .SH "CHROMIUM DEPOT_TOOLS"
 .sp
 Part of the chromium \fBdepot_tools\fR(7) suite\&. These tools are meant to assist with the development of chromium and related projects\&. Download the tools from \m[blue]\fBhere\fR\m[]\&\s-2\u[1]\d\s+2\&.
diff --git a/man/src/git-drover.demo.1.sh b/man/src/git-drover.demo.1.sh
index 84876c49ae..29a8cb043f 100755
--- a/man/src/git-drover.demo.1.sh
+++ b/man/src/git-drover.demo.1.sh
@@ -6,7 +6,7 @@ drover_c "This change needs to go to branch 9999"
 echo "# Make sure we have the most up-to-date branch sources."
 run git fetch
 echo
-echo "# Here's the commit we want to 'drover'."
+echo "# Here's a commit (from some.committer) that we want to 'drover'."
 run git log -n 1 --pretty=fuller
 echo
 echo "# Checkout the branch we want to 'drover' to."
@@ -16,8 +16,8 @@ echo "# Now do the 'drover'."
 echo "# IMPORTANT!!! Do Not leave off the '-x' flag"
 run git cherry-pick -x $(git show-ref -s pick_commit)
 echo
-echo "# That took the code authored by some.commiter and commited it to the"
-echo "# branch by branch.maintainer (us)."
+echo "# That took the code authored by some.committer and committed it to"
+echo "# the branch by the person who drovered it (i.e. you)."
 run git log -n 1 --pretty=fuller
 echo
 echo "# Looks good. Ship it!"
diff --git a/man/src/git-drover.demo.common.sh b/man/src/git-drover.demo.common.sh
index 006e99de2b..cbe6576c74 100755
--- a/man/src/git-drover.demo.common.sh
+++ b/man/src/git-drover.demo.common.sh
@@ -7,7 +7,7 @@ drover_c() {
   set_user some.committer
   c "$1"
   silent git tag -f pick_commit
-  set_user branch.maintainer
+  set_user you
   tick 1000
 }
 
diff --git a/man/src/git-drover.txt b/man/src/git-drover.txt
index f01b5cdbb6..2dde5821c3 100644
--- a/man/src/git-drover.txt
+++ b/man/src/git-drover.txt
@@ -41,8 +41,7 @@ demo:2[]
 
 SEE ALSO
 --------
-linkgit:git-cherry-pick[1]
-linkgit:git-revert[1]
+linkgit:git-cherry-pick[1], linkgit:git-revert[1]
 
 include::_footer.txt[]