[Bps-public-commit] r17643 - in sd/trunk: lib/App/SD/CLI/Command/Help
spang at bestpractical.com
spang at bestpractical.com
Thu Jan 8 10:42:35 EST 2009
Author: spang
Date: Thu Jan 8 10:42:31 2009
New Revision: 17643
Modified:
sd/trunk/ (props changed)
sd/trunk/lib/App/SD/CLI/Command/Help/About.pm
sd/trunk/lib/App/SD/CLI/Command/Help/Attachments.pm
sd/trunk/lib/App/SD/CLI/Command/Help/Authors.pm
sd/trunk/lib/App/SD/CLI/Command/Help/Comments.pm
sd/trunk/lib/App/SD/CLI/Command/Help/Config.pm
sd/trunk/lib/App/SD/CLI/Command/Help/Environment.pm
sd/trunk/lib/App/SD/CLI/Command/Help/Intro.pm
sd/trunk/lib/App/SD/CLI/Command/Help/Search.pm
sd/trunk/lib/App/SD/CLI/Command/Help/Sync.pm
sd/trunk/lib/App/SD/CLI/Command/Help/Tickets.pm
sd/trunk/lib/App/SD/CLI/Command/Help/summary_format_ticket.pm
Log:
r53421 at loki: spang | 2009-01-08 16:47:06 +0200
clean up inconsistencies in help files to aid machine readability
Modified: sd/trunk/lib/App/SD/CLI/Command/Help/About.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/About.pm (original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/About.pm Thu Jan 8 10:42:31 2009
@@ -9,25 +9,24 @@
print <<EOF
sd is a peer-to-peer replicated ticket tracking system built on the
-Prophet dataabase and synchronization framework. sd is designed for
+Prophet database and synchronization framework. sd is designed for
inter-organization replication and sharing, as well as offline
-operation. For more information, join us at http://syncwith.us.
-
-AUTHORS: (in alphabetical order)
+operation. For more information, join us at http://syncwith.us/.
sd was originally conceived and designed by Jesse Vincent and Chia-liang
Kao at Best Practical Solutions. Many others have contributed to sd.
For a full author list, type:
+
$cmd help authors
sd is open-source software, distributed under the terms of the MIT
-license. You are free to use this software, modify it and redistribute
+license. You are free to use this software, modify it and redistribute
your changed version. You are not required to share your changes
to this software, however, the authors would appreciate it if you
would contribute improvements so that they may be shared with the
community. For license details, type:
- $cmd help copying
+ $cmd help copying
EOF
}
Modified: sd/trunk/lib/App/SD/CLI/Command/Help/Attachments.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/Attachments.pm (original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/Attachments.pm Thu Jan 8 10:42:31 2009
@@ -8,16 +8,15 @@
my $cmd = $self->_get_cmd_name;
print <<EOF
-== Working with ticket attachments
-
- $cmd ticket attachment create 456 --file bugfix.patch
- Create a new attachment on this ticket from the file 'bugfix.patch'.
-
- $cmd ticket attachment list 456
- Show all attachemnts on ticket 456
-
- $cmd ticket attachment content 567
- Send the content of attachment 567 to STDOUT
+
+ $cmd ticket attachment create 456 --file bugfix.patch
+ Create a new attachment on this ticket from the file 'bugfix.patch'.
+
+ $cmd ticket attachment list 456
+ Show all attachemnts on ticket 456.
+
+ $cmd ticket attachment content 567
+ Send the content of attachment 567 to STDOUT.
EOF
}
Modified: sd/trunk/lib/App/SD/CLI/Command/Help/Authors.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/Authors.pm (original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/Authors.pm Thu Jan 8 10:42:31 2009
@@ -8,6 +8,7 @@
$self->print_header("Authors");
print <<EOF
+
(in alphabetical order)
Chia-liang Kao <clkao\@clkao.org>
@@ -16,7 +17,6 @@
Jesse Vincent <jesse\@fsck.com>
Casey West <casey\@geeknest.com>
Simon Wistow <simon\@thegestalt.org>
-
EOF
}
Modified: sd/trunk/lib/App/SD/CLI/Command/Help/Comments.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/Comments.pm (original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/Comments.pm Thu Jan 8 10:42:31 2009
@@ -3,22 +3,23 @@
extends 'App::SD::CLI::Command::Help';
sub run {
- my $self = shift;
- $self->print_header('Working with ticket comments');
- my $cmd = $self->_get_cmd_name;
-
+ my $self = shift;
+ $self->print_header('Working with ticket comments');
+ my $cmd = $self->_get_cmd_name;
+
print <<EOF
- $cmd ticket comment 456
- Add a comment to the ticket with id 456, popping up a text editor
-
- $cmd ticket comment 456 --file=myfile
- Add a comment to the ticket with id 456, using the content of 'myfile'
-
- $cmd ticket comment list
- List all ticket comments
-
- $cmd ticket comment show 4
- Show ticket comment 4 and all metadata
+
+ $cmd ticket comment 456
+ Add a comment to the ticket with id 456, popping up a text editor.
+
+ $cmd ticket comment 456 --file=myfile
+ Add a comment to the ticket with id 456, using the content of 'myfile'.
+
+ $cmd ticket comment list
+ List all ticket comments.
+
+ $cmd ticket comment show 4
+ Show ticket comment 4 and all metadata.
EOF
}
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 Thu Jan 8 10:42:31 2009
@@ -5,21 +5,34 @@
sub run {
my $self = shift;
$self->print_header('Configuration Options');
+ my $cmd = $self->_get_cmd_name;
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:
-
- email_address = foo\@bar.com
- Specifies an email address to use as the default for tickets'
- reporter field.
-
- summary_format_ticket = %4s },\$luid | %-11.11s,status | %-60.60s,summary
- Specifies how to format ticket summaries (when listing tickets, e.g.).
- (See also: help summary_format_ticket.)
+SD supports both a user-wide configuration file (\$HOME/.sdrc and
+per-database configuration file (/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:
+
+ email_address = foo\@bar.com
+ Specifies an email address to use as the default for tickets'
+ reporter field. (Overrides the EMAIL environmental variable if
+ that is also set.)
+
+ summary_format_ticket = %4s },\$luid | %-11.11s,status | %-60.60s,summary
+ Specifies how to format ticket summaries (when listing tickets, e.g.).
+ (See also: help summary_format_ticket.)
+
+ default_sort_ticket_list =
+ Bug property to determine order of display when listing tickets. (Can
+ be any property; will be compared lexically.)
+
+ default_group_ticket_list = milestone
+ Bug property to group tickets by when displaying lists. (Can be any
+ property.)
+
+For information on environmental variables that can affect SD, see
+'$cmd help environment'.
EOF
}
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 Thu Jan 8 10:42:31 2009
@@ -5,39 +5,41 @@
sub run {
my $self = shift;
$self->print_header('Environment variables');
+ my $cmd = $self->_get_cmd_name;
print <<EOF
- export PROPHET_DEVEL=1
- Turn on various development mode checks, warnings and autoreloading
- of modules
+The following environmental variables can be set to affect SD's
+configuration. Example syntax is for bash-like shells.
- export PROPHET_USER=name
- Use 'name' as the creator of changesets
+ export PROPHET_DEVEL=1
+ Turn on various development mode checks, warnings and autoreloading
+ of modules.
- export EMAIL=jesse\@example.com
- Use jesse\@example.com as the default email address for reporting
- tickets
+ export PROPHET_USER=name
+ Use 'name' as the creator of changesets.
- export PROPHET_REPLICA_TYPE=prophet
- Use the prophet native replica type. In the future other backend
- replica types may be available
+ export EMAIL=jesse\@example.com
+ Use jesse\@example.com as the default email address for reporting
+ tickets.
- export SD_REPO=/path/to/sd/replica
- Specify where the ticket database SD is using should reside
+ export PROPHET_REPLICA_TYPE=prophet
+ Use the prophet native replica type. In the future other backend
+ replica types may be available.
- export SD_CONFIG=/path/to/sd/config/file
- Specify where the configuration file SD is using should reside
+ 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.
- export PROPHET_HISTFILE=~/.sd-history
- Specify where the interactive shell should store its history
-
- export PROPHET_HISTLENGTH=100
- Specify how much history the interactive shell should store
-
+ export PROPHET_HISTFILE=~/.sd-history
+ Specify where the interactive shell should store its history.
+ export PROPHET_HISTLENGTH=100
+ Specify how much history the interactive shell should store.
+For information on SD database configuration files, see '$cmd help config'.
EOF
}
Modified: sd/trunk/lib/App/SD/CLI/Command/Help/Intro.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/Intro.pm (original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/Intro.pm Thu Jan 8 10:42:31 2009
@@ -12,7 +12,7 @@
distributed database. SD is designed to make it easy to work with tickets
and to share ticket databases with your collaborators.
-To get started with SD, you need an ticket database. To get an ticket
+To get started with SD, you need a ticket database. To get an ticket
database, you have two options: You can clone an existing database
or start a new one.
@@ -20,7 +20,7 @@
home directory. You can override this behaviour by setting the SD_REPO
environment variable.
-To clone an ticket database:
+To clone a ticket database:
$cmd clone --from http://example.com/path/to/sd
@@ -37,9 +37,8 @@
$cmd publish --to joeuser\@myhost.example.com:public_html/mydb
To learn a bit more about what you can do with SD:
-
- $cmd help
+ $cmd help
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 Thu Jan 8 10:42:31 2009
@@ -8,31 +8,31 @@
my $cmd = $self->_get_cmd_name;
print <<EOF
- $cmd ticket search
- List all tickets with a status that does not match 'closed'
-
- $cmd ticket search --regex abc
- List all tickets with content matching 'abc'
-
- $cmd ticket search -- status!=closed summary =~ http
- List all tickets with a status that does match closed
- and a summary matching 'http'
-
- $cmd ticket search --group owner
- List all tickets with a status that does not match 'closed',
- grouped by owner
-
- $cmd ticket show 1234
- Show basic information for the ticket with local id 1234
-
- $cmd ticket details 1234
- Show basic information and history for the ticket with local id 1234
-
- $cmd ticket history 1234
- Show history for the ticket with local id 1234
-
- $cmd ticket delete 1234
- Deletes ticket with local id 1234
+ $cmd ticket search
+ List all tickets with a status that does not match 'closed'.
+
+ $cmd ticket search --regex abc
+ List all tickets with content matching 'abc'.
+
+ $cmd ticket search -- status!=closed summary =~ http
+ List all tickets with a status that does match closed
+ and a summary matching 'http'.
+
+ $cmd ticket search --group owner
+ List all tickets with a status that does not match 'closed',
+ grouped by owner.
+
+ $cmd ticket show 1234
+ Show basic information for the ticket with local id 1234.
+
+ $cmd ticket details 1234
+ Show basic information and history for the ticket with local id 1234.
+
+ $cmd ticket history 1234
+ Show history for the ticket with local id 1234.
+
+ $cmd ticket delete 1234
+ Deletes ticket with local id 1234.
EOF
}
Modified: sd/trunk/lib/App/SD/CLI/Command/Help/Sync.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/Sync.pm (original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/Sync.pm Thu Jan 8 10:42:31 2009
@@ -10,40 +10,39 @@
print <<EOF
- $cmd clone --from http://example.com/path/to/sd
- Create a new copy (replica) of a published SD replica from an
- http, ftp or file URL.
-
- $cmd pull --from http://example.com/path/to/sd
- Integrate changes from a published SD replica over http, ftp or
- file URL.
-
- $cmd pull --all
- Integrate changes from all replicas this replica has pulled from
- before.
-
- $cmd pull --local
- Integrate changes from all replicas currently announcing themselves
- on the local network using Bonjour
-
- $cmd publish --to jesse\@server:path/to/destination
- Publish a copy of this replica to a remote server using rsync.
-
- $cmd publish --html --replica --to jesse\@server:path/to/destination
- Publish a copy of this replica, including a static html representation,
- to a remote server using rsync.
-
- $cmd server --port 9876
- Start an sd replica server on port 9876. This command will make your
- replica browsable and pullable by anyone with remote access to your
- computer.
-
- $cmd server --writable --port 9876
- Start an sd replica server on port 9876, with UNAUTHENTICATED,
- PUBLIC WRITE ACCESS via HTTP POST. This command will make your
- replica modifiable, browsable and pullable by ANYONE with remote
- access to your computer.
-
+ $cmd clone --from http://example.com/path/to/sd
+ Create a new copy (replica) of a published SD replica from an
+ http, ftp or file URL.
+
+ $cmd pull --from http://example.com/path/to/sd
+ Integrate changes from a published SD replica over http, ftp or
+ file URL.
+
+ $cmd pull --all
+ Integrate changes from all replicas this replica has pulled from
+ before.
+
+ $cmd pull --local
+ Integrate changes from all replicas currently announcing themselves
+ on the local network using Bonjour
+
+ $cmd publish --to jesse\@server:path/to/destination
+ Publish a copy of this replica to a remote server using rsync.
+
+ $cmd publish --html --replica --to jesse\@server:path/to/destination
+ Publish a copy of this replica, including a static html representation,
+ to a remote server using rsync.
+
+ $cmd server --port 9876
+ Start an sd replica server on port 9876. This command will make your
+ replica browsable and pullable by anyone with remote access to your
+ computer.
+
+ $cmd server --writable --port 9876
+ Start an sd replica server on port 9876, with UNAUTHENTICATED,
+ PUBLIC WRITE ACCESS via HTTP POST. This command will make your
+ replica modifiable, browsable and pullable by ANYONE with remote
+ access to your computer.
EOF
}
Modified: sd/trunk/lib/App/SD/CLI/Command/Help/Tickets.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/Tickets.pm (original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/Tickets.pm Thu Jan 8 10:42:31 2009
@@ -3,26 +3,26 @@
extends 'App::SD::CLI::Command::Help';
sub run {
- my $self = shift;
- $self->print_header('Working with tickets');
- my $cmd = $self->_get_cmd_name;
-
+ my $self = shift;
+ $self->print_header('Working with tickets');
+ my $cmd = $self->_get_cmd_name;
+
print <<EOF
- $cmd ticket create
- Invokes a text editor with a ticket creation template
-
- $cmd ticket create -- summary="This is a summary" status=open
- Create a new ticket non-interactively
-
- $cmd ticket update 123 -- status=closed
- Sets the status of the ticket with local id 123 to closed
-
- $cmd ticket resolve 123
- Sets the status of the ticket with local id 123 to closed
-
- $cmd ticket update fad5849a-67f1-11dd-bde1-5b33d3ff2799 -- status=closed
- Sets the status of the ticket with uuid
- fad5849a-67f1-11dd-bde1-5b33d3ff2799 to closed
+ $cmd ticket create
+ Invokes a text editor with a ticket creation template
+
+ $cmd ticket create -- summary="This is a summary" status=open
+ Create a new ticket non-interactively
+
+ $cmd ticket update 123 -- status=closed
+ Sets the status of the ticket with local id 123 to closed
+
+ $cmd ticket resolve 123
+ Sets the status of the ticket with local id 123 to closed
+
+ $cmd ticket update fad5849a-67f1-11dd-bde1-5b33d3ff2799 -- status=closed
+ Sets the status of the ticket with uuid
+ fad5849a-67f1-11dd-bde1-5b33d3ff2799 to closed
EOF
}
Modified: sd/trunk/lib/App/SD/CLI/Command/Help/summary_format_ticket.pm
==============================================================================
--- sd/trunk/lib/App/SD/CLI/Command/Help/summary_format_ticket.pm (original)
+++ sd/trunk/lib/App/SD/CLI/Command/Help/summary_format_ticket.pm Thu Jan 8 10:42:31 2009
@@ -4,7 +4,7 @@
sub run {
my $self = shift;
- $self->print_header('The summary_format_ticket Configuration Option');
+ $self->print_header('The summary_format_ticket configuration option');
print <<EOF
The summary_format_ticket configuration directive consists of any number
@@ -14,7 +14,7 @@
Here is an example:
-summary_format_ticket = %5.5s },\$luid | %8.8s,status | %-52.52s,summary
+ summary_format_ticket = %5.5s },\$luid | %8.8s,status | %-52.52s,summary
Let's deconstruct this example. It consists of three pairs. The first pair is
'%5.5s },\$luid'. The first item of the pair should look somewhat familiar to
More information about the Bps-public-commit
mailing list