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

[spang at bestpractical.com]

Author: spang
Date: Fri Jan  9 06:36:07 2009
New Revision: 17667

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

Log:
 r53428 at loki:  spang | 2009-01-09 11:16:58 +0200
 Doc ticket show args and config option


Modified: sd/trunk/lib/App/SD/CLI/Command/Help/Config.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/Config.pm	(original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/Config.pm	Fri Jan  9 06:36:07 2009
@@ -31,6 +31,11 @@
       Bug property to group tickets by when displaying lists. (Can be any
       property.)
 
+    disable_ticket_show_history_by_default = 1
+      Don't display ticket history when running '$cmd ticket show'. Can
+      be overridden by passing the '--show-history' arg to the
+      command.
+
 For information on environmental variables that can affect SD, see
 '$cmd help environment'.
 EOF

Modified: sd/trunk/lib/App/SD/CLI/Command/Help/Search.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/Search.pm	(original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/Search.pm	Fri Jan  9 06:36:07 2009
@@ -8,8 +8,10 @@
     my $cmd = $self->_get_cmd_name;
 
 print <<EOF
+
     $cmd ticket search
       List all tickets with a status that does not match 'closed'.
+      Note that 'list' is an alias for 'search'.
 
     $cmd ticket search --regex abc
       List all tickets with content matching 'abc'. Regular
@@ -24,11 +26,20 @@
        grouped by owner.
 
     $cmd ticket basics 1234
-      Show basic information for the ticket with local id 1234.
+      Show basic information (metadata only) for the ticket with local id 1234.
 
     $cmd ticket show 1234
-      Show basic information and history for the ticket with local id 1234.
-      ('details' is an alias for 'show')
+      Show basic information, comments, and history for the ticket with local
+      id 1234.  ('details' is an alias for 'show')
+
+    $cmd ticket show 1234 --skip-history
+      Show only metadata and comments for the ticket 1234 (but not
+      history).
+
+    $cmd ticket show 1234 --show-history
+      Override the disable_ticket_show_history_by_default config option
+      if it is set for this database. (See '$cmd help config' for
+      more info.)
 
     $cmd ticket history 1234
       Show history for the ticket with local id 1234.