From 96dc085dbe897dd19947d46809095fd1067b7e7f Mon Sep 17 00:00:00 2001 From: Aaron Gable Date: Mon, 27 Feb 2017 13:51:01 -0800 Subject: [PATCH] Add a manual page for git-cl The most important git subcommand in depot_tools never had a man page until today. And now "git help cl" and "git cl --help" will work. BUG=695623 Change-Id: Ic0d05fa8d70d2ef6e71d58e0d7d3e7adc4a2fa32 Reviewed-on: https://chromium-review.googlesource.com/447216 Reviewed-by: Robbie Iannucci Commit-Queue: Aaron Gable --- man/html/depot_tools.html | 10 +- man/html/git-cl.html | 1025 +++++++++++++++++++++++++++++++ man/html/git-squash-branch.html | 4 +- man/html/git-upstream-diff.html | 2 +- man/man1/git-cl.1 | 193 ++++++ man/man1/git-squash-branch.1 | 8 +- man/man1/git-upstream-diff.1 | 6 +- man/man7/depot_tools.7 | 11 +- man/src/_git-cl_desc.helper.txt | 1 + man/src/git-cl.txt | 116 ++++ 10 files changed, 1362 insertions(+), 14 deletions(-) create mode 100644 man/html/git-cl.html create mode 100644 man/man1/git-cl.1 create mode 100644 man/src/_git-cl_desc.helper.txt create mode 100644 man/src/git-cl.txt diff --git a/man/html/depot_tools.html b/man/html/depot_tools.html index 4c638dad5..c226e051f 100644 --- a/man/html/depot_tools.html +++ b/man/html/depot_tools.html @@ -779,6 +779,14 @@ Upload the diff between a revision and its parent to rietveld.

+git-cl(1) +
+
+

+Interact with code reviews on Gerrit and Rietveld +

+
+
git-drover(1)
@@ -927,7 +935,7 @@ Print a diff of the current branch, compared to its upstream.

diff --git a/man/html/git-cl.html b/man/html/git-cl.html new file mode 100644 index 000000000..328806dfe --- /dev/null +++ b/man/html/git-cl.html @@ -0,0 +1,1025 @@ + + + + + +git-cl(1) + + + + + +
+
+

SYNOPSIS

+
+
+
git cl <subcommand> [options]
+
+
+
+
+
+

DESCRIPTION

+
+

git cl is the home of all of the tools for interacting with changelists.

+

Run git cl help <subcommand> for a more detailed listing of that command +and its options.

+
+
+
+

SUBCOMMANDS

+
+
+
+archive +
+
+

+ archives and deletes branches associated with closed changelists +

+
+
+baseurl +
+
+

+ gets or sets base-url for this branch +

+
+
+checkout +
+
+

+ checks out a branch associated with a given Rietveld or Gerrit issue +

+
+
+comments +
+
+

+ shows or posts review comments for any changelist +

+
+
+config +
+
+

+ edits configuration for this tree +

+
+
+dcommit +
+
+

+ DEPRECATED: Used to commit the current changelist via git-svn +

+
+
+description +
+
+

+ brings up the editor for the current CL’s description +

+
+
+diff +
+
+

+ shows differences between local tree and last upload +

+
+
+format +
+
+

+ runs auto-formatting tools (clang-format etc.) on the diff +

+
+
+help +
+
+

+ prints list of commands or help for a specific command +

+
+
+issue +
+
+

+ sets or displays the current code review issue number +

+
+
+land +
+
+

+ commits the current changelist via git +

+
+
+lint +
+
+

+ runs cpplint on the current changelist +

+
+
+owners +
+
+

+ interactively find the owners for reviewing +

+
+
+patch +
+
+

+ patches in a code review +

+
+
+presubmit +
+
+

+ runs presubmit tests on the current changelist +

+
+
+set-close +
+
+

+ closes the issue +

+
+
+set-commit +
+
+

+ sets the commit bit to trigger the Commit Queue +

+
+
+status +
+
+

+ show status of changelists +

+
+
+tree +
+
+

+ shows the status of the tree +

+
+
+try +
+
+

+ triggers try jobs using either BuildBucket or CQ dry run +

+
+
+try-results +
+
+

+ prints info about try jobs associated with current CL +

+
+
+upload +
+
+

+ uploads the current changelist to codereview +

+
+
+upstream +
+
+

+ prints or sets the name of the upstream branch, if any +

+
+
+web +
+
+

+ opens the current CL in the web browser +

+
+
+
+
+
+

OPTIONS

+
+
+
+--version +
+
+

+ show program’s version number and exit +

+
+
+-h, --help +
+
+

+ show this help message and exit +

+
+
+-v, --verbose +
+
+

+ Use 2 times for more debugging info +

+
+
+
+
+
+

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/html/git-squash-branch.html b/man/html/git-squash-branch.html index ef8b33a7f..2773afc8c 100644 --- a/man/html/git-squash-branch.html +++ b/man/html/git-squash-branch.html @@ -791,7 +791,7 @@ verify that the conflict diff is what you expected (and then skip it with

Optional message to use for the first line of the squashed commit. If omitted, - it defaults to "git squash commit.". + it defaults to "git squash commit for <branch>.".

@@ -874,7 +874,7 @@ from

diff --git a/man/html/git-upstream-diff.html b/man/html/git-upstream-diff.html index 1c15adb7a..0bedb9861 100644 --- a/man/html/git-upstream-diff.html +++ b/man/html/git-upstream-diff.html @@ -891,7 +891,7 @@ from

diff --git a/man/man1/git-cl.1 b/man/man1/git-cl.1 new file mode 100644 index 000000000..549d659f0 --- /dev/null +++ b/man/man1/git-cl.1 @@ -0,0 +1,193 @@ +'\" t +.\" Title: git-cl +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 02/27/2017 +.\" Manual: Chromium depot_tools Manual +.\" Source: depot_tools a6ba28f5 +.\" Language: English +.\" +.TH "GIT\-CL" "1" "02/27/2017" "depot_tools a6ba28f5" "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-cl \- Interact with code reviews on Gerrit and Rietveld +.SH "SYNOPSIS" +.sp +.nf +\fIgit cl [options]\fR +.fi +.sp +.SH "DESCRIPTION" +.sp +git cl is the home of all of the tools for interacting with changelists\&. +.sp +Run git cl help for a more detailed listing of that command and its options\&. +.SH "SUBCOMMANDS" +.PP +archive +.RS 4 +archives and deletes branches associated with closed changelists +.RE +.PP +baseurl +.RS 4 +gets or sets base\-url for this branch +.RE +.PP +checkout +.RS 4 +checks out a branch associated with a given Rietveld or Gerrit issue +.RE +.PP +comments +.RS 4 +shows or posts review comments for any changelist +.RE +.PP +config +.RS 4 +edits configuration for this tree +.RE +.PP +dcommit +.RS 4 +DEPRECATED: Used to commit the current changelist via git\-svn +.RE +.PP +description +.RS 4 +brings up the editor for the current CL\(cqs description +.RE +.PP +diff +.RS 4 +shows differences between local tree and last upload +.RE +.PP +format +.RS 4 +runs auto\-formatting tools (clang\-format etc\&.) on the diff +.RE +.PP +help +.RS 4 +prints list of commands or help for a specific command +.RE +.PP +issue +.RS 4 +sets or displays the current code review issue number +.RE +.PP +land +.RS 4 +commits the current changelist via git +.RE +.PP +lint +.RS 4 +runs cpplint on the current changelist +.RE +.PP +owners +.RS 4 +interactively find the owners for reviewing +.RE +.PP +patch +.RS 4 +patches in a code review +.RE +.PP +presubmit +.RS 4 +runs presubmit tests on the current changelist +.RE +.PP +set\-close +.RS 4 +closes the issue +.RE +.PP +set\-commit +.RS 4 +sets the commit bit to trigger the Commit Queue +.RE +.PP +status +.RS 4 +show status of changelists +.RE +.PP +tree +.RS 4 +shows the status of the tree +.RE +.PP +try +.RS 4 +triggers try jobs using either BuildBucket or CQ dry run +.RE +.PP +try\-results +.RS 4 +prints info about try jobs associated with current CL +.RE +.PP +upload +.RS 4 +uploads the current changelist to codereview +.RE +.PP +upstream +.RS 4 +prints or sets the name of the upstream branch, if any +.RE +.PP +web +.RS 4 +opens the current CL in the web browser +.RE +.SH "OPTIONS" +.PP +\-\-version +.RS 4 +show program\(cqs version number and exit +.RE +.PP +\-h, \-\-help +.RS 4 +show this help message and exit +.RE +.PP +\-v, \-\-verbose +.RS 4 +Use 2 times for more debugging info +.RE +.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/man1/git-squash-branch.1 b/man/man1/git-squash-branch.1 index be14afe25..db3be2591 100644 --- a/man/man1/git-squash-branch.1 +++ b/man/man1/git-squash-branch.1 @@ -2,12 +2,12 @@ .\" Title: git-squash-branch .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 12/15/2016 +.\" Date: 02/27/2017 .\" Manual: Chromium depot_tools Manual -.\" Source: depot_tools f72f1ad +.\" Source: depot_tools a6ba28f5 .\" Language: English .\" -.TH "GIT\-SQUASH\-BRANCH" "1" "12/15/2016" "depot_tools f72f1ad" "Chromium depot_tools Manual" +.TH "GIT\-SQUASH\-BRANCH" "1" "02/27/2017" "depot_tools a6ba28f5" "Chromium depot_tools Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -44,7 +44,7 @@ Squashing branches is useful when trying to rebase\-update over branches which w .PP \-m , \-\-message= .RS 4 -Optional message to use for the first line of the squashed commit\&. If omitted, it defaults to "git squash commit\&."\&. +Optional message to use for the first line of the squashed commit\&. If omitted, it defaults to "git squash commit for \&."\&. .RE .SH "EXAMPLE" .sp diff --git a/man/man1/git-upstream-diff.1 b/man/man1/git-upstream-diff.1 index 44621c8e7..231e696c9 100644 --- a/man/man1/git-upstream-diff.1 +++ b/man/man1/git-upstream-diff.1 @@ -2,12 +2,12 @@ .\" Title: git-upstream-diff .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 12/15/2016 +.\" Date: 02/27/2017 .\" Manual: Chromium depot_tools Manual -.\" Source: depot_tools f72f1ad +.\" Source: depot_tools a6ba28f5 .\" Language: English .\" -.TH "GIT\-UPSTREAM\-DIFF" "1" "12/15/2016" "depot_tools f72f1ad" "Chromium depot_tools Manual" +.TH "GIT\-UPSTREAM\-DIFF" "1" "02/27/2017" "depot_tools a6ba28f5" "Chromium depot_tools Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/man7/depot_tools.7 b/man/man7/depot_tools.7 index a67c98623..7c89197d5 100644 --- a/man/man7/depot_tools.7 +++ b/man/man7/depot_tools.7 @@ -2,12 +2,12 @@ .\" Title: depot_tools .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 12/15/2016 +.\" Date: 02/27/2017 .\" Manual: Chromium depot_tools Manual -.\" Source: depot_tools f72f1ad +.\" Source: depot_tools a6ba28f5 .\" Language: English .\" -.TH "DEPOT_TOOLS" "7" "12/15/2016" "depot_tools f72f1ad" "Chromium depot_tools Manual" +.TH "DEPOT_TOOLS" "7" "02/27/2017" "depot_tools a6ba28f5" "Chromium depot_tools Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -47,6 +47,11 @@ A tutorial for these tools can be found at \fBdepot_tools_tutorial\fR(7)\&. Upload the diff between a revision and its parent to rietveld\&. .RE .PP +\fBgit-cl\fR(1) +.RS 4 +Interact with code reviews on Gerrit and Rietveld +.RE +.PP \fBgit-drover\fR(1) .RS 4 Apply a commit from the trunk to a release branch, or from one release branch to another\&. diff --git a/man/src/_git-cl_desc.helper.txt b/man/src/_git-cl_desc.helper.txt new file mode 100644 index 000000000..bf3a53088 --- /dev/null +++ b/man/src/_git-cl_desc.helper.txt @@ -0,0 +1 @@ +Interact with code reviews on Gerrit and Rietveld diff --git a/man/src/git-cl.txt b/man/src/git-cl.txt new file mode 100644 index 000000000..400dee06e --- /dev/null +++ b/man/src/git-cl.txt @@ -0,0 +1,116 @@ +git-cl(1) +========= + +NAME +---- +git-cl - +include::_git-cl_desc.helper.txt[] + +SYNOPSIS +-------- +[verse] +'git cl [options]' + +DESCRIPTION +----------- + +`git cl` is the home of all of the tools for interacting with changelists. + +Run `git cl help ` for a more detailed listing of that command +and its options. + +SUBCOMMANDS +----------- + +archive:: + archives and deletes branches associated with closed changelists + +baseurl:: + gets or sets base-url for this branch + +checkout:: + checks out a branch associated with a given Rietveld or Gerrit issue + +comments:: + shows or posts review comments for any changelist + +config:: + edits configuration for this tree + +dcommit:: + DEPRECATED: Used to commit the current changelist via git-svn + +description:: + brings up the editor for the current CL's description + +diff:: + shows differences between local tree and last upload + +format:: + runs auto-formatting tools (clang-format etc.) on the diff + +help:: + prints list of commands or help for a specific command + +issue:: + sets or displays the current code review issue number + +land:: + commits the current changelist via git + +lint:: + runs cpplint on the current changelist + +owners:: + interactively find the owners for reviewing + +patch:: + patches in a code review + +presubmit:: + runs presubmit tests on the current changelist + +set-close:: + closes the issue + +set-commit:: + sets the commit bit to trigger the Commit Queue + +status:: + show status of changelists + +tree:: + shows the status of the tree + +try:: + triggers try jobs using either BuildBucket or CQ dry run + +try-results:: + prints info about try jobs associated with current CL + +upload:: + uploads the current changelist to codereview + +upstream:: + prints or sets the name of the upstream branch, if any + +web:: + opens the current CL in the web browser + + +OPTIONS +------- + +--version:: + show program's version number and exit + +-h, --help:: + show this help message and exit + +-v, --verbose:: + Use 2 times for more debugging info + + +include::_footer.txt[] + +// vim: ft:asciidoc: