From 617909819cd1b955647dd8584036fc7b2a014265 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Thu, 10 Apr 2014 18:58:10 -0400
Subject: [PATCH] Improve command help with formatting and usage examples
---
src/main/java/com/gitblit/transport/ssh/gitblit/ConfigCommand.java | 8 ++++++++
1 files changed, 8 insertions(+), 0 deletions(-)
diff --git a/src/main/java/com/gitblit/transport/ssh/gitblit/ConfigCommand.java b/src/main/java/com/gitblit/transport/ssh/gitblit/ConfigCommand.java
index 695f085..f674034 100644
--- a/src/main/java/com/gitblit/transport/ssh/gitblit/ConfigCommand.java
+++ b/src/main/java/com/gitblit/transport/ssh/gitblit/ConfigCommand.java
@@ -14,9 +14,17 @@
import com.gitblit.models.SettingModel;
import com.gitblit.transport.ssh.commands.CommandMetaData;
import com.gitblit.transport.ssh.commands.SshCommand;
+import com.gitblit.transport.ssh.commands.UsageExample;
+import com.gitblit.transport.ssh.commands.UsageExamples;
import com.google.common.collect.Maps;
@CommandMetaData(name = "config", description = "Administer Gitblit settings", admin = true)
+@UsageExamples(examples = {
+ @UsageExample(syntax = "${cmd} --list", description = "List all settings"),
+ @UsageExample(syntax = "${cmd} git.sshPort", description = "Describe the git.sshPort setting"),
+ @UsageExample(syntax = "${cmd} git.sshPort 29418", description = "Set git.sshPort to 29418"),
+ @UsageExample(syntax = "${cmd} git.sshPort --reset", description = "Reset git.sshPort to it's default value"),
+})
public class ConfigCommand extends SshCommand {
@Argument(index = 0, metaVar = "KEY", usage = "The setting to describe or update")
--
Gitblit v1.9.1