[Bps-public-commit] r15053 - in sd/branches/sd-help: . lib/App/SD/CLI/Command/Help

jesse at bestpractical.com jesse at bestpractical.com
Tue Aug 12 07:22:31 EDT 2008


Author: jesse
Date: Tue Aug 12 07:22:31 2008
New Revision: 15053

Added:
   sd/branches/sd-help/lib/App/SD/CLI/Command/Help/About.pm
   sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Authors.pm
   sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Copying.pm
Modified:
   sd/branches/sd-help/   (props changed)
   sd/branches/sd-help/lib/App/SD/CLI/Command/Help.pm
   sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Search.pm
   sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Sync.pm

Log:
 r43042 at PC0169:  jesse | 2008-08-12 01:35:55 +0100
 * help updates


Modified: sd/branches/sd-help/lib/App/SD/CLI/Command/Help.pm
==============================================================================
--- sd/branches/sd-help/lib/App/SD/CLI/Command/Help.pm	(original)
+++ sd/branches/sd-help/lib/App/SD/CLI/Command/Help.pm	Tue Aug 12 07:22:31 2008
@@ -10,9 +10,10 @@
 
 sub _get_cmd_name {
     my $self = shift;
-my $cmd = $0;
-$cmd =~ s{^(.*)/}{}g;
-return $cmd;
+    return '' if $self->cli->interactive_shell;
+    my $cmd = $0;
+    $cmd =~ s{^(.*)/}{}g;
+    return $cmd;
 }
 
 

Added: sd/branches/sd-help/lib/App/SD/CLI/Command/Help/About.pm
==============================================================================
--- (empty file)
+++ sd/branches/sd-help/lib/App/SD/CLI/Command/Help/About.pm	Tue Aug 12 07:22:31 2008
@@ -0,0 +1,39 @@
+package App::SD::CLI::Command::Help::About;
+use Moose;
+extends 'App::SD::CLI::Command::Help';
+
+sub run {
+    my $self = shift;
+    my $cmd = $self->_get_cmd_name;
+    $self->print_header('About SD');
+
+print <<EOF
+sd is a peer-to-peer replicated issue tracking system built on the
+Prophet dataabase 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)
+
+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
+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
+
+EOF
+
+}
+
+__PACKAGE__->meta->make_immutable;
+no Moose;
+
+1;
+

Added: sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Authors.pm
==============================================================================
--- (empty file)
+++ sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Authors.pm	Tue Aug 12 07:22:31 2008
@@ -0,0 +1,28 @@
+package App::SD::CLI::Command::Help::Authors;
+use Moose;
+extends 'App::SD::CLI::Command::Help';
+
+sub run {
+    my $self = shift;
+    my $cmd = $self->_get_cmd_name;
+    $self->print_header("Authors");
+
+print <<EOF
+(in alphabetical order)
+
+Chia-liang Kao <clkao\@clkao.org>
+Shawn Moore <sartak\@sartak.org>
+Christine Spang <spang\@mit.edu>
+Jesse Vincent <jesse\@fsck.com>
+Casey West <casey\@geeknest.com>
+Simon Wistow <simon\@thegestalt.org>
+
+EOF
+
+}
+
+__PACKAGE__->meta->make_immutable;
+no Moose;
+
+1;
+

Added: sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Copying.pm
==============================================================================
--- (empty file)
+++ sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Copying.pm	Tue Aug 12 07:22:31 2008
@@ -0,0 +1,36 @@
+package App::SD::CLI::Command::Help::Copying;
+use Moose;
+extends 'App::SD::CLI::Command::Help';
+
+sub run {
+    my $self = shift;
+    $self->print_header('License Terms (The MIT license)');
+
+print <<EOF
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+EOF
+
+}
+
+__PACKAGE__->meta->make_immutable;
+no Moose;
+
+1;
+

Modified: sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Search.pm
==============================================================================
--- sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Search.pm	(original)
+++ sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Search.pm	Tue Aug 12 07:22:31 2008
@@ -29,82 +29,6 @@
  
  $cmd ticket delete 1234
      Deletes ticket with local id 1234
- 
-
-= Working with tickets
-
- $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 update fad5849a-67f1-11dd-bde1-5b33d3ff2799 -- status=closed
-     Sets the status of the ticket with uuid 
-     fad5849a-67f1-11dd-bde1-5b33d3ff2799 to closed 
- 
-
-== Working with ticket comments
-
- $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
-
-
-== 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 resolve 123
-     Sets the status of the ticket with local id 123 to closed 
-
-
-= Sharing ticket databases
- 
- $cmd pull --from http://example.com/path/to/sd
-    Integrate changes from a published SD replica over http, ftp or 
-    file URL schemes.
- 
- $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 over
-    ssh.
-
- $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 over ssh.
-
- 
-= ENVIRONMENT
-
-  export SD_REPO=/path/to/sd/replica
-    Specify where the ticket database SD is using should reside
-
 EOF
 
 }

Modified: sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Sync.pm
==============================================================================
--- sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Sync.pm	(original)
+++ sd/branches/sd-help/lib/App/SD/CLI/Command/Help/Sync.pm	Tue Aug 12 07:22:31 2008
@@ -28,6 +28,18 @@
  $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 over ssh.
+
+ $comd 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.
+
+ $comd server --rest --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
 
 }



More information about the Bps-public-commit mailing list