diff options
| author | David Pursehouse <david.pursehouse@sonymobile.com> | 2016-03-15 16:34:13 +0900 |
|---|---|---|
| committer | David Pursehouse <david.pursehouse@sonymobile.com> | 2016-03-15 16:34:13 +0900 |
| commit | b1ba92f0df914f778b69739bc3cb45252eb185ac (patch) | |
| tree | a676ccb15fd2e3fbbbfa209adb5d08f4dac56b49 | |
| parent | 6ce4fc981313222bee1cbaa2ca77013c7741b2a2 (diff) | |
ListCommand: Improve documentation and help text
Change-Id: Ic9883bf3ee820622df47ff6ff325a5acb6ca650c
| -rw-r--r-- | src/main/java/com/googlesource/gerrit/plugins/replication/ListCommand.java | 4 | ||||
| -rw-r--r-- | src/main/resources/Documentation/cmd-list.md | 15 |
2 files changed, 8 insertions, 11 deletions
diff --git a/src/main/java/com/googlesource/gerrit/plugins/replication/ListCommand.java b/src/main/java/com/googlesource/gerrit/plugins/replication/ListCommand.java index 3546b0d..7cf81b6 100644 --- a/src/main/java/com/googlesource/gerrit/plugins/replication/ListCommand.java +++ b/src/main/java/com/googlesource/gerrit/plugins/replication/ListCommand.java @@ -29,12 +29,12 @@ import com.googlesource.gerrit.plugins.replication.ReplicationConfig.FilterType; import org.kohsuke.args4j.Option; @RequiresCapability(GlobalCapability.ADMINISTRATE_SERVER) -@CommandMetaData(name = "list", description = "List specific remote destinations information") +@CommandMetaData(name = "list", description = "List remote destination information") final class ListCommand extends SshCommand { @Option(name = "--remote", metaVar = "PATTERN", usage = "pattern to match remote name on") private String remote; - @Option(name = "--detail", usage = "print remote destination detail information") + @Option(name = "--detail", usage = "output detailed information") private boolean detail; @Option(name = "--json", usage = "output in json format") diff --git a/src/main/resources/Documentation/cmd-list.md b/src/main/resources/Documentation/cmd-list.md index 84bb56b..9cc28a2 100644 --- a/src/main/resources/Documentation/cmd-list.md +++ b/src/main/resources/Documentation/cmd-list.md @@ -3,7 +3,7 @@ NAME ---- -@PLUGIN@ list - List specific remote destinations information +@PLUGIN@ list - List remote destination information. SYNOPSIS -------- @@ -16,8 +16,7 @@ ssh -p @SSH_PORT@ @SSH_HOST@ @PLUGIN@ list DESCRIPTION ----------- -List all remote destinations information, or only those whose -name match the pattern given on the command line. +Lists the name and URL for remote destinations. ACCESS ------ @@ -25,19 +24,17 @@ Caller must be a member of the privileged 'Administrators' group. SCRIPTING --------- -This command is intended to be used in scripts. It is very useful -for replication status check for administrators as well. +This command is intended to be used in scripts. OPTIONS ------- `--remote <PATTERN>` -: Only print destinations whose remote name contains - the substring `PATTERN`. +: Only print information for destinations whose remote name matches + the `PATTERN`. `--detail` -: Print remote detail information: Name, Url, AdminUrl, - AuthGroup and Project. +: Print additional detailed information: AdminUrl, AuthGroup and Project. `--json` : Output in json format. |