Improve the help text for 'repo upload'

Signed-off-by: Shawn O. Pearce <sop@google.com>
This commit is contained in:
Shawn O. Pearce 2009-04-18 10:59:33 -07:00
parent 9bb9617858
commit 337fb9c7e9

View File

@ -38,22 +38,21 @@ class Upload(InteractiveCommand):
%prog [--re --cc] {[<project>]... | --replace <project>} %prog [--re --cc] {[<project>]... | --replace <project>}
""" """
helpDescription = """ helpDescription = """
The '%prog' command is used to send changes to the Gerrit code The '%prog' command is used to send changes to the Gerrit Code
review system. It searches for changes in local projects that do Review system. It searches for topic branches in local projects
not yet exist in the corresponding remote repository. If multiple that have not yet been published for review. If multiple topic
changes are found, '%prog' opens an editor to allow the branches are found, '%prog' opens an editor to allow the user to
user to choose which change to upload. After a successful upload, select which branches to upload.
repo prints the URL for the change in the Gerrit code review system.
'%prog' searches for uploadable changes in all projects listed '%prog' searches for uploadable changes in all projects listed at
at the command line. Projects can be specified either by name, or the command line. Projects can be specified either by name, or by
by a relative or absolute path to the project's local directory. If a relative or absolute path to the project's local directory. If no
no projects are specified, '%prog' will search for uploadable projects are specified, '%prog' will search for uploadable changes
changes in all projects listed in the manifest. in all projects listed in the manifest.
If the --reviewers or --cc options are passed, those emails are If the --reviewers or --cc options are passed, those emails are
added to the respective list of users, and emails are sent to any added to the respective list of users, and emails are sent to any
new users. Users passed to --reviewers must be already registered new users. Users passed as --reviewers must already be registered
with the code review system, or the upload will fail. with the code review system, or the upload will fail.
If the --replace option is passed the user can designate which If the --replace option is passed the user can designate which
@ -83,6 +82,11 @@ or in the .git/config within the project. For example:
[review "http://review.example.com/"] [review "http://review.example.com/"]
autoupload = true autoupload = true
References
----------
Gerrit Code Review: http://code.google.com/p/gerrit/
""" """
def _Options(self, p): def _Options(self, p):