From 7569c539b315b845827f22f6b85031e2582ea4b2 Mon Sep 17 00:00:00 2001 From: Mika Hamalainen Date: Tue, 20 Sep 2011 10:08:43 +0300 Subject: Improved staging SSH command help texts MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added better descriptions and examples for different branches used by staging commands. Change-Id: I4e10c032a10129dfe282de42c8d0abd816fa8598 Reviewed-by: Mika Hämäläinen --- .../src/main/java/com/google/gerrit/sshd/commands/StagingApprove.java | 2 +- .../main/java/com/google/gerrit/sshd/commands/StagingListChanges.java | 4 ++-- .../main/java/com/google/gerrit/sshd/commands/StagingNewBuild.java | 2 +- .../src/main/java/com/google/gerrit/sshd/commands/StagingRebuild.java | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingApprove.java b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingApprove.java index 11361a811e..8167d713bc 100644 --- a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingApprove.java +++ b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingApprove.java @@ -161,7 +161,7 @@ public class StagingApprove extends BaseCommand { private String message; @Option(name = "--branch", aliases = {"-b"}, metaVar = "BRANCH", - required = true, usage = "destination branch") + required = true, usage = "destination branch, e.g. refs/heads/master or just master") private String branch; private Repository git; diff --git a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingListChanges.java b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingListChanges.java index 67f0007132..79ee1d00fc 100644 --- a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingListChanges.java +++ b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingListChanges.java @@ -47,11 +47,11 @@ public class StagingListChanges extends BaseCommand { private String project; @Option(name = "--branch", aliases = {"-b"}, - required = true, usage = "branch name, e.g. refs/staging/master") + required = true, usage = "any branch name, e.g. refs/staging/master or refs/builds/my_build") private String branch; @Option(name = "--destination", aliases = {"-d"}, - required = true, usage = "destination branch name, e.g. refs/heads/master") + required = true, usage = "destination branch filter, e.g. refs/heads/master or just master") private String destination; @Override diff --git a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingNewBuild.java b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingNewBuild.java index dd9ec56a77..38fdc82867 100644 --- a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingNewBuild.java +++ b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingNewBuild.java @@ -60,7 +60,7 @@ public class StagingNewBuild extends BaseCommand { private String stagingBranch; @Option(name = "--build-id", aliases = {"-i"}, - required = true, usage = "build id, e.g. 123 (refs/build/123)") + required = true, usage = "build id, e.g. refs/builds/my_build or just my_build") private String build; @Override diff --git a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingRebuild.java b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingRebuild.java index 90d542664d..f389ef6133 100644 --- a/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingRebuild.java +++ b/gerrit-sshd/src/main/java/com/google/gerrit/sshd/commands/StagingRebuild.java @@ -49,7 +49,7 @@ public class StagingRebuild extends BaseCommand { private String project; @Option(name = "--branch", aliases = {"-b"}, - required = true, usage = "branch name, e.g. refs/heads/master") + required = true, usage = "branch name, e.g. refs/heads/master or just master") private String branch; @Override -- cgit v1.2.3