[Bps-public-commit] r16543 - in sd/trunk: lib/App/SD/CLI/Command/Help

[spang at bestpractical.com]

Author: spang
Date: Sun Oct 26 17:08:27 2008
New Revision: 16543

Added:
   sd/trunk/lib/App/SD/CLI/Command/Help/Config.pm
Modified:
   sd/trunk/   (props changed)
   sd/trunk/lib/App/SD/CLI/Command/Help/Environment.pm

Log:
 r50901 at loki:  spang | 2008-10-25 22:39:35 -0400
 add help for configuration and update env var help


Added: sd/trunk/lib/App/SD/CLI/Command/Help/Config.pm
==============================================================================
--- (empty file)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/Config.pm	Sun Oct 26 17:08:27 2008
@@ -0,0 +1,30 @@
+package App::SD::CLI::Command::Help::Config;
+use Moose;
+extends 'App::SD::CLI::Command::Help';
+
+sub run {
+    my $self = shift;
+    $self->print_header('Configuration Options');
+
+print <<EOF
+  SD supports both a user-wide configuration (\$HOME/.sdrc and per-database
+  configuration (/path/to/repo/sdrc). If both configuration files are present,
+  the database-specific config file will be used.
+
+  Currently, the following configuration variables are available:
+
+  reporter_email = foo\@bar.com
+    Specifies an email address to use as the default for tickets'
+    reported_by field.
+
+  summary_format_ticket = %4s },\$luid | %-11.11s,status | %-60.60s,summary
+    Specifies how to format ticket summaries (when listing tickets, e.g.).
+EOF
+
+}
+
+__PACKAGE__->meta->make_immutable;
+no Moose;
+
+1;
+

Modified: sd/trunk/lib/App/SD/CLI/Command/Help/Environment.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/Environment.pm	(original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/Environment.pm	Sun Oct 26 17:08:27 2008
@@ -9,6 +9,9 @@
 print <<EOF
   export SD_REPO=/path/to/sd/replica
     Specify where the ticket database SD is using should reside
+
+  export SD_CONFIG=/path/to/sd/config/file
+    Specify where the configuration file SD is using should reside
 EOF
 
 }