[Bps-public-commit] SD branch, master, updated. 3d369fa1c0ccc678c54f9f1f9661454e6b722731

[spang at bestpractical.com]

The branch, master has been updated
       via  3d369fa1c0ccc678c54f9f1f9661454e6b722731 (commit)
      from  c84c991f838dc6c4cd0e2c46a6ca9a92cdf03b2d (commit)

Summary of changes:
 lib/App/SD/CLI/Command/Help/Config.pm |   24 ++++++++++++++++++------
 1 files changed, 18 insertions(+), 6 deletions(-)

- Log -----------------------------------------------------------------
commit 3d369fa1c0ccc678c54f9f1f9661454e6b722731
Author: Christine Spang <spang at bestpractical.com>
Date:   Thu Aug 13 15:26:37 2009 +0100

    Clarify part of 'help config'

diff --git a/lib/App/SD/CLI/Command/Help/Config.pm b/lib/App/SD/CLI/Command/Help/Config.pm
index 5201cf9..9808007 100644
--- a/lib/App/SD/CLI/Command/Help/Config.pm
+++ b/lib/App/SD/CLI/Command/Help/Config.pm
@@ -10,7 +10,7 @@ sub run {
 print <<EOF
 SD supports a layered configuration system with three configuration
 files: a global file (/etc/sdrc), a user-wide configuration file
-(\$HOME/.sdrc) and per-replica configuration file (/path/to/replica/config).
+(\$HOME/.sdrc) and a per-replica configuration file (/path/to/replica/config).
 Configuration variables in more local configuration files override
 those in more global ones.
 
@@ -35,14 +35,26 @@ Examples:
 The configuration file format is similar to that of the VCS 'Git'. See
 http://www.kernel.org/pub/software/scm/git/docs/git-config.html for
 specifics. The biggest thing you need to know is that the config file
-contains key/value variables, contained in sections. In the help
-documents, we'll refer to variables in the manner:
-"section.subsection.variable-name". In a configuration file, this
-would look like:
+contains key/value variables, contained in sections and subsections.
 
-    [section "subsection"]
+In the help documents, we'll refer to variables in the manner:
+"section-name.subsection-name.variable-name". In a configuration file,
+this would look like:
+
+    [section-name "subsection-name"]
         variable-name = value
 
+Here's an example of an actual configuration file, aimed at being
+a user-wide config file that affects all bug databases:
+
+    [user]
+        email-address = me\@example.com
+    [ticket]
+        summary-format = %5.5s,\$luid | %8.8s,status | %7.7s,component |%12.12s,owner| %-44.44s,summary
+        default-group = milestone
+    [alias]
+        mine = ticket list -- owner=~me status!~closed|rejected
+
 Currently, the following configuration variables are available (sorted
 by configuration file section):
 

-----------------------------------------------------------------------