From 62e41c348722f85f3b04821787c218d8ff793bc9 Mon Sep 17 00:00:00 2001 From: "mmoss@chromium.org" Date: Wed, 20 Aug 2014 23:23:28 +0000 Subject: [PATCH] Add stub git-drover documentation. R=iannucci@google.com BUG=261738 Review URL: https://codereview.chromium.org/494873003 git-svn-id: svn://svn.chromium.org/chrome/trunk/tools/depot_tools@290946 0039d316-1c4b-4281-b951-d872f2087c98 --- man/html/git-drover.html | 828 ++++++++++++++++++++++++++++ man/man1/git-drover.1 | 95 ++++ man/src/_git-drover_desc.helper.txt | 2 + man/src/git-drover.demo.1.sh | 28 + man/src/git-drover.txt | 30 + 5 files changed, 983 insertions(+) create mode 100644 man/html/git-drover.html create mode 100644 man/man1/git-drover.1 create mode 100644 man/src/_git-drover_desc.helper.txt create mode 100755 man/src/git-drover.demo.1.sh create mode 100644 man/src/git-drover.txt diff --git a/man/html/git-drover.html b/man/html/git-drover.html new file mode 100644 index 000000000..2fc3ac000 --- /dev/null +++ b/man/html/git-drover.html @@ -0,0 +1,828 @@ + + + + + +git-drover(1) + + + + + +
+
+

SYNOPSIS

+
+
+
git drover
+
+
+
+
+
+

DESCRIPTION

+
+

git drover is NOT IMPLEMENTED yet. See the EXAMPLE section for the equivalent +sequence of commands to run.

+
+
+
+

EXAMPLE

+
+

Before working with branches, you must 'gclient sync --with_branch_heads' at least once to fetch the branches.

$ git log -n 1 --pretty=fuller
+commit 49fde8547a38bf27d38cbf3fac783cdf2ddc5f47
+Author:     some.committer <some.committer@chromium.org>
+AuthorDate: Thu Apr 10 08:54:46 2014 +0000
+Commit:     some.committer <some.committer@chromium.org>
+CommitDate: Thu Apr 10 08:54:46 2014 +0000
+
+    This change needs to go to branch 9999
+$ git checkout -b drover_9999 branch-heads/9999
+Branch drover_9999 set up to track remote ref refs/branch-heads/9999.
+# DO NOT leave off the '-x' flag
+$ git cherry-pick -x 49fde8547a38bf27d38cbf3fac783cdf2ddc5f47
+[drover_9999 1e33c2c] 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
+$ git log -n 1 --pretty=fuller
+commit 1e33c2ccf642703a6c1c582210fe63980dc6c45b
+Author:     some.committer <some.committer@chromium.org>
+AuthorDate: Thu Apr 10 08:54:46 2014 +0000
+Commit:     branch.maintainer <branch.maintainer@chromium.org>
+CommitDate: Thu Apr 10 09:11:36 2014 +0000
+
+    This change needs to go to branch 9999
+
+    (cherry picked from commit 49fde8547a38bf27d38cbf3fac783cdf2ddc5f47)
+$ git cl upload
+# Get LGTM or TBR.
+$ git cl land
+

+
+
+
+

SEE ALSO

+
+

git-cherry-pick(1)

+
+
+
+

CHROMIUM DEPOT_TOOLS

+
+

Part of the chromium depot_tools(7) suite. These tools are meant to +assist with the development of chromium and related projects. Download the tools +from here.

+
+
+
+
+ + + diff --git a/man/man1/git-drover.1 b/man/man1/git-drover.1 new file mode 100644 index 000000000..a38703ff3 --- /dev/null +++ b/man/man1/git-drover.1 @@ -0,0 +1,95 @@ +'\" t +.\" Title: git-drover +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 08/20/2014 +.\" Manual: Chromium depot_tools Manual +.\" Source: depot_tools b2c2b1c +.\" Language: English +.\" +.TH "GIT\-DROVER" "1" "08/20/2014" "depot_tools b2c2b1c" "Chromium depot_tools Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +git-drover \- Apply a commit from the trunk to a release branch, or from one release branch to another\&. +.SH "SYNOPSIS" +.sp +.nf +\fIgit drover\fR +.fi +.sp +.SH "DESCRIPTION" +.sp +git drover is NOT IMPLEMENTED yet\&. See the EXAMPLE section for the equivalent sequence of commands to run\&. +.SH "EXAMPLE" +.sp +Before working with branches, you must \*(Aqgclient sync \-\-with_branch_heads\*(Aq at least once to fetch the branches\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB$ git log \-n 1 \-\-pretty=fuller\fR +commit d4bdf220b1b8d616ae71ab2d539f106f167c03e1 +Author: some\&.committer +AuthorDate: Thu Apr 10 08:54:46 2014 +0000 +Commit: some\&.committer +CommitDate: Thu Apr 10 08:54:46 2014 +0000 + + This change needs to go to branch 9999 +\fB$ git checkout \-b drover_9999 branch\-heads/9999\fR +Branch drover_9999 set up to track remote ref refs/branch\-heads/9999\&. +# DO NOT leave off the \*(Aq\-x\*(Aq flag +\fB$ git cherry\-pick \-x d4bdf220b1b8d616ae71ab2d539f106f167c03e1\fR +[drover_9999 6356f5a] 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 +\fB$ git log \-n 1 \-\-pretty=fuller\fR +commit 6356f5a94785197320d59639e794b83783094329 +Author: some\&.committer +AuthorDate: Thu Apr 10 08:54:46 2014 +0000 +Commit: branch\&.maintainer +CommitDate: Thu Apr 10 09:11:36 2014 +0000 + + This change needs to go to branch 9999 + + (cherry picked from commit d4bdf220b1b8d616ae71ab2d539f106f167c03e1) +\fB$ git cl upload\fR +# Get LGTM or TBR\&. +\fB$ git cl land\fR +.fi +.if n \{\ +.RE +.\} +.sp +.SH "SEE ALSO" +.sp +\fBgit-cherry-pick\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\&. +.SH "NOTES" +.IP " 1." 4 +here +.RS 4 +\%https://chromium.googlesource.com/chromium/tools/depot_tools.git +.RE diff --git a/man/src/_git-drover_desc.helper.txt b/man/src/_git-drover_desc.helper.txt new file mode 100644 index 000000000..0af6691c9 --- /dev/null +++ b/man/src/_git-drover_desc.helper.txt @@ -0,0 +1,2 @@ +Apply a commit from the trunk to a release branch, or from one release branch to +another. diff --git a/man/src/git-drover.demo.1.sh b/man/src/git-drover.demo.1.sh new file mode 100755 index 000000000..f0e026775 --- /dev/null +++ b/man/src/git-drover.demo.1.sh @@ -0,0 +1,28 @@ +#!/usr/bin/env bash +. demo_repo.sh + +silent git push origin refs/remotes/origin/master:refs/branch-heads/9999 +silent git config --add remote.origin.fetch \ + +refs/branch-heads/*:refs/remotes/branch-heads/* +silent git fetch origin + +silent git checkout -b master origin/master +add modified_file +set_user some.committer +c "This change needs to go to branch 9999" +silent git tag pick_commit + +comment Before working with branches, you must \'gclient sync \ + --with_branch_heads\' at least once to fetch the branches. + +set_user branch.maintainer +tick 1000 + +run git log -n 1 --pretty=fuller +run git checkout -b drover_9999 branch-heads/9999 +echo "# DO NOT leave off the '-x' flag" +run git cherry-pick -x $(git show-ref -s pick_commit) +run git log -n 1 --pretty=fuller +pcommand git cl upload +echo "# Get LGTM or TBR." +run git cl land diff --git a/man/src/git-drover.txt b/man/src/git-drover.txt new file mode 100644 index 000000000..0c2afffb0 --- /dev/null +++ b/man/src/git-drover.txt @@ -0,0 +1,30 @@ +git-drover(1) +============= + +NAME +---- +git-drover - +include::_git-drover_desc.helper.txt[] + +SYNOPSIS +-------- +[verse] +'git drover' + +DESCRIPTION +----------- + +`git drover` is NOT IMPLEMENTED yet. See the EXAMPLE section for the equivalent +sequence of commands to run. + +EXAMPLE +------- +demo:1[] + +SEE ALSO +-------- +linkgit:git-cherry-pick[1] + +include::_footer.txt[] + +// vim: ft=asciidoc: