Update documentation and help text for the review ssh command
The review command can be applied to multiple changes, but the
help text is written in singular tense.
Update the documentation and help text accordingly, and also fix
a couple of other typos.
Change-Id: I9bceecbc7a7683b0a9483362419268742654c6e2
diff --git a/Documentation/cmd-review.txt b/Documentation/cmd-review.txt
index ac613e5..eed6902 100644
--- a/Documentation/cmd-review.txt
+++ b/Documentation/cmd-review.txt
@@ -52,7 +52,7 @@
--force-message::
Option which allows Gerrit to publish the --message, even
- when the labels could not be applied due to change being
+ when the labels could not be applied due to the change being
closed).
+
Used by some scripts/CI-systems, where the results (or links
@@ -69,11 +69,11 @@
complete listing of supported approval categories and values.
--abandon::
- Abandon the specified patch set(s).
+ Abandon the specified change(s).
(option is mutually exclusive with --submit and --restore)
--restore::
- Restore the specified abandoned patch set(s).
+ Restore the specified abandoned change(s).
(option is mutually exclusive with --abandon)
--submit::
diff --git a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/ReviewCommand.java b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/ReviewCommand.java
index 8ce1e82..5ebb6c7 100644
--- a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/ReviewCommand.java
+++ b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/ReviewCommand.java
@@ -68,7 +68,8 @@
private final Set<PatchSet.Id> patchSetIds = new HashSet<PatchSet.Id>();
- @Argument(index = 0, required = true, multiValued = true, metaVar = "{COMMIT | CHANGE,PATCHSET}", usage = "patch to review")
+ @Argument(index = 0, required = true, multiValued = true, metaVar = "{COMMIT | CHANGE,PATCHSET}",
+ usage = "list of commits or patch sets to review")
void addPatchSetId(final String token) {
try {
patchSetIds.addAll(parsePatchSetId(token));
@@ -79,29 +80,29 @@
}
}
- @Option(name = "--project", aliases = "-p", usage = "project containing the patch set")
+ @Option(name = "--project", aliases = "-p", usage = "project containing the specified patch set(s)")
private ProjectControl projectControl;
- @Option(name = "--message", aliases = "-m", usage = "cover message to publish on change", metaVar = "MESSAGE")
+ @Option(name = "--message", aliases = "-m", usage = "cover message to publish on change(s)", metaVar = "MESSAGE")
private String changeComment;
- @Option(name = "--abandon", usage = "abandon the patch set")
+ @Option(name = "--abandon", usage = "abandon the specified change(s)")
private boolean abandonChange;
- @Option(name = "--restore", usage = "restore an abandoned the patch set")
+ @Option(name = "--restore", usage = "restore the specified abandoned change(s)")
private boolean restoreChange;
- @Option(name = "--submit", aliases = "-s", usage = "submit the patch set")
+ @Option(name = "--submit", aliases = "-s", usage = "submit the specified patch set(s)")
private boolean submitChange;
@Option(name = "--force-message", usage = "publish the message, "
- + "even if the label score cannot be applied due to change being closed")
+ + "even if the label score cannot be applied due to the change being closed")
private boolean forceMessage = false;
- @Option(name = "--publish", usage = "publish a draft patch set")
+ @Option(name = "--publish", usage = "publish the specified draft patch set(s)")
private boolean publishPatchSet;
- @Option(name = "--delete", usage = "delete a draft patch set")
+ @Option(name = "--delete", usage = "delete the specified draft patch set(s)")
private boolean deleteDraftPatchSet;
@Inject
@@ -266,7 +267,7 @@
errMsg += "rule error";
break;
case NOT_A_DRAFT:
- errMsg += "change is not a draft";
+ errMsg += "change/patch set is not a draft";
break;
case GIT_ERROR:
errMsg += "error writing change to git repository";
