RETIRED, Gerrit as used by OpenStack
Go to file
David Ostrovsky e51c428fe5 Display command description in ssh gerrit --help
Show one line description for each ssh command. Make COMMAND
argument optional, so that --help argument is not needed.

This approach is working for core gerrit commands, aliases, nested
commands and plugin's own ssh commands.

To provide a description ssh command must be annotated with
CommandMetaData annotation, i. e.:

@CommandMetaData(name="print", descr="Print greeting in different languages")
public final class PrintHelloWorldCommand extends SshCommand { ...

Syntactic sugar for command registration is provided to reflect the fact,
that both name and description are included in CommandMetaData annotation.

To register command and alias in plugin:
protected void configureCommands() {
  command(PrintHelloWorldCommand.class);
  alias("say-hello", PrintHelloWorldCommand.class);
[...]

With the outcome:
$ ssh gerrit helloworld
Available commands of helloworld are:

   print       Print greeting in different languages
   say-hello   Print greeting in different languages

Change-Id: I2e5440378023ecc5425092d8131f121da2f20a30
2013-02-15 20:51:21 +01:00
contrib Lightweight LDAP server for debugging 2012-12-19 22:28:34 -05:00
Documentation Cleanup /groups/ REST endpoints 2013-01-10 20:54:31 -08:00
gerrit-antlr Allow {} to be used for quoting in query expressions 2012-12-03 09:59:14 -08:00
gerrit-cache-h2 Fix various warnings 2012-10-18 13:38:51 +02:00
gerrit-common Fix sorting of included groups 2013-01-10 20:54:31 -08:00
gerrit-extension-api Suppress Eclipse warning "annotation should not be used as a superinterface" 2012-12-02 21:01:28 +09:00
gerrit-gwtdebug Import gwt-dev dependency as last in gerrit-gwtdebug 2012-11-19 14:35:34 +01:00
gerrit-gwtui Cleanup /groups/ REST endpoints 2013-01-10 20:54:31 -08:00
gerrit-httpd Fix caching rules by upgrading to gwtexpui 1.3 2013-01-11 12:39:45 -08:00
gerrit-launcher Remove servlet-api from WAR/lib 2012-10-21 21:25:25 -07:00
gerrit-main Update versions in pom's to start Gerrit 2.6 development 2012-08-22 14:09:52 +02:00
gerrit-openid Fix caching rules by upgrading to gwtexpui 1.3 2013-01-11 12:39:45 -08:00
gerrit-package-plugins Revert "Update replication plugin to 1.0-rc0 in package plugins" 2013-01-10 05:26:11 -08:00
gerrit-patch-commonsnet Update versions in pom's to start Gerrit 2.6 development 2012-08-22 14:09:52 +02:00
gerrit-patch-jgit Update versions in pom's to start Gerrit 2.6 development 2012-08-22 14:09:52 +02:00
gerrit-pgm Merge "gerrit.sh: Add 'status' as synonym for 'check' to be LSB compliant" 2013-01-01 09:33:39 -08:00
gerrit-plugin-api Allow plugins to contribute InitStep to Gerrit init. 2012-10-22 10:07:31 -07:00
gerrit-plugin-archetype Update versions in pom's to start Gerrit 2.6 development 2012-08-22 14:09:52 +02:00
gerrit-plugin-gwt-archetype Update plugin-gwt-archetype to match current implementation 2012-11-12 19:55:53 +01:00
gerrit-plugin-gwtui Bump GWT version to 2.5.0 2012-11-17 05:20:19 +01:00
gerrit-plugin-js-archetype Update plugin-js-archetype to match current implementation 2012-11-12 19:55:49 +01:00
gerrit-prettify Update versions in pom's to start Gerrit 2.6 development 2012-08-22 14:09:52 +02:00
gerrit-reviewdb Add new notify type that allows watching of new patch sets 2013-01-10 14:26:42 -08:00
gerrit-server Cleanup /groups/ REST endpoints 2013-01-10 20:54:31 -08:00
gerrit-sshd Display command description in ssh gerrit --help 2013-02-15 20:51:21 +01:00
gerrit-util-cli Suppress Eclipse warning "annotation should not be used as a superinterface" 2012-12-02 21:01:28 +09:00
gerrit-util-ssl Update versions in pom's to start Gerrit 2.6 development 2012-08-22 14:09:52 +02:00
gerrit-war Revert "Expand submodule subscription support" 2012-12-07 11:23:55 -08:00
ReleaseNotes Fix formatting of bullets in Gerrit 2.5.1 release notes 2012-12-12 15:48:48 +01:00
tools Exclude all pom.xml files that are archetype resources in version.sh 2012-12-06 17:41:54 +01:00
.gitignore Adding sublime project files to .gitignore 2012-11-02 10:20:21 -04:00
COPYING Initial project setup of Gerrit 2 2008-11-14 16:59:34 -08:00
INSTALL Remove Gerrit 1.x to 2.x import tools 2009-03-27 20:20:10 -07:00
pom.xml Fix caching rules by upgrading to gwtexpui 1.3 2013-01-11 12:39:45 -08:00
SUBMITTING_PATCHES Update push URL in SUBMITTING_PATCHES 2012-03-29 00:57:14 -04:00