From 7de7105850c660445d28866a1f6ea17a47e4542c Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Sun, 22 May 2011 14:55:11 +0200 Subject: [PATCH] added usage text --- .../src/main/java/sonia/scm/cli/App.java | 2 +- .../scm/cli/cmd/AddMembersSubCommand.java | 6 ++++- .../scm/cli/cmd/AddPermissionSubCommand.java | 6 ++++- .../main/java/sonia/scm/cli/cmd/Command.java | 2 +- .../scm/cli/cmd/CreateGroupSubCommand.java | 6 ++++- .../cli/cmd/CreateRepositorySubCommand.java | 6 ++++- .../scm/cli/cmd/CreateUserSubCommand.java | 6 ++++- .../scm/cli/cmd/DeleteConfigSubCommand.java | 6 ++++- .../scm/cli/cmd/DeleteGroupSubCommand.java | 6 ++++- .../scm/cli/cmd/DeleteMembersSubCommand.java | 6 ++++- .../cli/cmd/DeletePermissionSubCommand.java | 6 ++++- .../cli/cmd/DeleteRepositorySubCommand.java | 6 ++++- .../scm/cli/cmd/DeleteUserSubCommand.java | 6 ++++- .../sonia/scm/cli/cmd/GetGroupSubCommand.java | 6 ++++- .../scm/cli/cmd/GetRepositorySubCommand.java | 6 ++++- .../sonia/scm/cli/cmd/GetUserSubCommand.java | 6 ++++- .../scm/cli/cmd/ListGroupsSubCommand.java | 6 ++++- .../cli/cmd/ListRepositoriesSubCommand.java | 6 ++++- .../scm/cli/cmd/ListUsersSubCommand.java | 6 ++++- .../scm/cli/cmd/ModifyGroupSubCommand.java | 6 ++++- .../cli/cmd/ModifyRepositorySubCommand.java | 6 ++++- .../scm/cli/cmd/ModifyUserSubCommand.java | 6 ++++- .../scm/cli/cmd/StoreConfigSubCommand.java | 6 ++++- .../resources/sonia/resources/i18n.properties | 25 ++++++++++++++++++- 24 files changed, 131 insertions(+), 24 deletions(-) diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/App.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/App.java index 3beaf70789..ed80eeb1ab 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/App.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/App.java @@ -220,7 +220,7 @@ public class App } } - length += 2; + length += 5; for (CommandDescriptor desc : SubCommandHandler.getInstance().getDescriptors()) diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/AddMembersSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/AddMembersSubCommand.java index f97b2d2a84..2538367fb0 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/AddMembersSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/AddMembersSubCommand.java @@ -45,7 +45,11 @@ import java.util.List; * * @author Sebastian Sdorra */ -@Command(name = "add-members", group = "group") +@Command( + name = "add-members", + usage = "usageAddMember", + group = "group" +) public class AddMembersSubCommand extends MembersSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/AddPermissionSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/AddPermissionSubCommand.java index e1b481d7c5..bdd7dbb91c 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/AddPermissionSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/AddPermissionSubCommand.java @@ -48,7 +48,11 @@ import java.util.List; * * @author Sebastian Sdorra */ -@Command(name="add-permission", group="repository") +@Command( + name = "add-permission", + usage = "usageAddPermission", + group = "repository" +) public class AddPermissionSubCommand extends PermissionSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/Command.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/Command.java index 227356d47d..ea6e988dae 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/Command.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/Command.java @@ -47,7 +47,7 @@ import java.lang.annotation.RetentionPolicy; @Retention(RetentionPolicy.RUNTIME) public @interface Command { - String name() default ""; + String name() default ""; String usage() default ""; String group() default "misc"; } diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateGroupSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateGroupSubCommand.java index 6cdff00cd2..e7df16e20f 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateGroupSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateGroupSubCommand.java @@ -50,7 +50,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="create-group", group="group") +@Command( + name = "create-group", + usage = "usageCreateGroup", + group = "group" +) public class CreateGroupSubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateRepositorySubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateRepositorySubCommand.java index 8a97b0cfdc..2b739fe872 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateRepositorySubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateRepositorySubCommand.java @@ -49,7 +49,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="create-repository",group="repository") +@Command( + name = "create-repository", + usage = "usageCreateRepository", + group = "repository" +) public class CreateRepositorySubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateUserSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateUserSubCommand.java index bf01ee556f..d3a0559f9a 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateUserSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/CreateUserSubCommand.java @@ -49,7 +49,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="create-user", group="user") +@Command( + name = "create-user", + usage = "usageCreateUser", + group = "user" +) public class CreateUserSubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteConfigSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteConfigSubCommand.java index 48da75f87c..93c2ad253e 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteConfigSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteConfigSubCommand.java @@ -41,7 +41,11 @@ import sonia.scm.cli.config.ScmClientConfig; * * @author Sebastian Sdorra */ -@Command(name="delete-config", group="config") +@Command( + name = "delete-config", + usage = "usageDeleteConfig", + group = "config" +) public class DeleteConfigSubCommand extends SubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteGroupSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteGroupSubCommand.java index 9cc7bc8e9c..0f183aeaf7 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteGroupSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteGroupSubCommand.java @@ -43,7 +43,11 @@ import sonia.scm.client.ScmClientSession; * * @author Sebastian Sdorra */ -@Command(name="delete-group",group="group") +@Command( + name = "delete-group", + usage = "usageDeleteGroup", + group = "group" +) public class DeleteGroupSubCommand extends SubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteMembersSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteMembersSubCommand.java index 4b717bc4da..449fab5181 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteMembersSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteMembersSubCommand.java @@ -45,7 +45,11 @@ import java.util.List; * * @author Sebastian Sdorra */ -@Command(name="delete-members",group="group") +@Command( + name = "delete-members", + usage = "usageDeleteMembers", + group = "group" +) public class DeleteMembersSubCommand extends MembersSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeletePermissionSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeletePermissionSubCommand.java index f4559032af..fe01b3ff24 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeletePermissionSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeletePermissionSubCommand.java @@ -48,7 +48,11 @@ import java.util.List; * * @author Sebastian Sdorra */ -@Command(name="delete-permission",group="repository") +@Command( + name = "delete-permission", + usage = "usageDeletePermission", + group = "repository" +) public class DeletePermissionSubCommand extends PermissionSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteRepositorySubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteRepositorySubCommand.java index 4706666369..706607d7a3 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteRepositorySubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteRepositorySubCommand.java @@ -43,7 +43,11 @@ import sonia.scm.client.ScmClientSession; * * @author Sebastian Sdorra */ -@Command(name="delete-repository",group="repository") +@Command( + name = "delete-repository", + usage = "usageDeleteRepository", + group = "repository" +) public class DeleteRepositorySubCommand extends SubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteUserSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteUserSubCommand.java index a450902508..50dee0d58d 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteUserSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/DeleteUserSubCommand.java @@ -43,7 +43,11 @@ import sonia.scm.client.ScmClientSession; * * @author Sebastian Sdorra */ -@Command(name="delete-user",group="user") +@Command( + name = "delete-user", + usage = "usageDeleteUser", + group = "user" +) public class DeleteUserSubCommand extends SubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetGroupSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetGroupSubCommand.java index 0877249a29..7eb7f71212 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetGroupSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetGroupSubCommand.java @@ -50,7 +50,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="get-group",group="group") +@Command( + name = "get-group", + usage = "usageGetGroup", + group = "group" +) public class GetGroupSubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetRepositorySubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetRepositorySubCommand.java index c39b9262ef..61d6f1529a 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetRepositorySubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetRepositorySubCommand.java @@ -50,7 +50,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="get-repository",group="repository") +@Command( + name = "get-repository", + usage = "usageGetRepository", + group = "repository" +) public class GetRepositorySubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetUserSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetUserSubCommand.java index 377aca86b1..53d41ac0c1 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetUserSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/GetUserSubCommand.java @@ -50,7 +50,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="get-user",group="user") +@Command( + name = "get-user", + usage = "usageGetUser", + group = "user" +) public class GetUserSubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListGroupsSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListGroupsSubCommand.java index 350f5d0a12..24e700c457 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListGroupsSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListGroupsSubCommand.java @@ -48,7 +48,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="list-groups",group="group") +@Command( + name = "list-groups", + usage = "usageListGroups", + group = "group" +) public class ListGroupsSubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListRepositoriesSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListRepositoriesSubCommand.java index 92399eff9e..f7cb200049 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListRepositoriesSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListRepositoriesSubCommand.java @@ -48,7 +48,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="list-repositories",group="repository") +@Command( + name = "list-repositories", + usage = "usageListRepositories", + group = "repository" +) public class ListRepositoriesSubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListUsersSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListUsersSubCommand.java index 934ce4f8bc..ae7a5628b1 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListUsersSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListUsersSubCommand.java @@ -48,7 +48,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="list-users",group="user") +@Command( + name = "list-users", + usage = "usageListUsers", + group = "user" +) public class ListUsersSubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyGroupSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyGroupSubCommand.java index e43e1ff9c6..4214f4e518 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyGroupSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyGroupSubCommand.java @@ -53,7 +53,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="modify-group",group="group") +@Command( + name = "modify-group", + usage = "usageModifyGroup", + group = "group" +) public class ModifyGroupSubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyRepositorySubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyRepositorySubCommand.java index 2bd9c81c32..8c88efc9a4 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyRepositorySubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyRepositorySubCommand.java @@ -53,7 +53,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="modify-repository",group="repository") +@Command( + name = "modify-repository", + usage = "usageModifyRepository", + group = "repository" +) public class ModifyRepositorySubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyUserSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyUserSubCommand.java index 59268e0f8d..d19ec75c52 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyUserSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ModifyUserSubCommand.java @@ -53,7 +53,11 @@ import java.util.Map; * * @author Sebastian Sdorra */ -@Command(name="modify-user",group="user") +@Command( + name = "modify-user", + usage = "usageModifyUser", + group = "user" +) public class ModifyUserSubCommand extends TemplateSubCommand { diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/StoreConfigSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/StoreConfigSubCommand.java index 649bbfdd12..3fcd06e479 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/StoreConfigSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/StoreConfigSubCommand.java @@ -41,7 +41,11 @@ import sonia.scm.cli.config.ScmClientConfig; * * @author Sebastian Sdorra */ -@Command(name = "store-config", group = "config") +@Command( + name = "store-config", + usage = "usageStoreConfig", + group = "config" +) public class StoreConfigSubCommand extends SubCommand { diff --git a/scm-clients/scm-cli-client/src/main/resources/sonia/resources/i18n.properties b/scm-clients/scm-cli-client/src/main/resources/sonia/resources/i18n.properties index c37aa3d6d4..e708ace8ae 100644 --- a/scm-clients/scm-cli-client/src/main/resources/sonia/resources/i18n.properties +++ b/scm-clients/scm-cli-client/src/main/resources/sonia/resources/i18n.properties @@ -75,4 +75,27 @@ config = Configuration misc = Miscellaneous repository = Repository group = Group -user = User \ No newline at end of file +user = User + +# usages +usageAddMember = Add members to a existing group +usageAddPermission = Add permission to a existing repository +usageCreateGroup = Create a new group +usageCreateRepository = Create a new repository +usageCreateUser = Create a new user +usageDeleteConfig = Delete all stored configurations +usageDeleteGroup = Delete a group +usageDeleteMembers = Delete members of a group +usageDeletePermission = Delete a permission of a repository +usageDeleteRepository = Delete a repository +usageDeleteUser = Delete a user +usageGetGroup = Print a group +usageGetRepository = Print a repository +usageGetUser = Print a user +usageListGroups= Print a list of all groups +usageListUsers= Print a list of all users +usageListRepositories= Print a list of all repositories +usageModifyGroup = Modify a group +usageModifyUser = Modify a user +usageModifyRepository = Modify a repository +usageStoreConfig = Stores the current configuration \ No newline at end of file