[Bps-public-commit] r12904 - in Shipwright: .

[spang at bestpractical.com]

Author: spang
Date: Wed Jun  4 20:22:45 2008
New Revision: 12904

Modified:
   Shipwright/   (props changed)
   Shipwright/trunk/lib/Shipwright/Backend.pm

Log:
 r40815 at loki:  spang | 2008-06-04 18:10:09 -0400
 Initial cleanup of Backend.pm pod. Not done yet; need to figure out which backend methods are actually required in all backends


Modified: Shipwright/trunk/lib/Shipwright/Backend.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Backend.pm	(original)
+++ Shipwright/trunk/lib/Shipwright/Backend.pm	Wed Jun  4 20:22:45 2008
@@ -5,13 +5,6 @@
 use Carp;
 use UNIVERSAL::require;
 
-=head2 new
-
-returns the the corresponding Backend object by the type of $args{repository}.
-now only supports SVK and SVN
-
-=cut
-
 sub new {
     my $class = shift;
     my %args  = @_;
@@ -41,40 +34,58 @@
 
 =head1 NAME
 
-Shipwright::Backend - backend part
-
-=head1 DESCRIPTION
+Shipwright::Backend - VCS repository backends
 
+=head1 SYNOPSIS
 
+use Shipwright::Backend;
+$backend = Shipwright::Backend->new (repository => $args{repository});
 
 =head1 INTERFACE
 
+A backend must support the following methods:
+
+=head2 initialize
 
+=head2 import
 
-=head1 DEPENDENCIES
+=head2 export
 
+=head2 checkout
 
-None.
+=head2 commit
 
+=head2 update_order
 
-=head1 INCOMPATIBILITIES
+=head2 order
 
-None reported.
+=head2 map
 
+=head2 source
 
-=head1 BUGS AND LIMITATIONS
+=head2 delete
 
-No bugs have been reported.
+=head2 info
 
-=head1 AUTHOR
+=head2 propset
 
-sunnavy  C<< <sunnavy at bestpractical.com> >>
+=head2 test_script
 
+=head2 requires
 
-=head1 LICENCE AND COPYRIGHT
+=head2 flags
 
-Copyright 2007 Best Practical Solutions.
+=head2 version
 
-This program is free software; you can redistribute it and/or modify it
-under the same terms as Perl itself.
+=head2 check_repository
 
+=head2 update
+
+=head1 CONSTRUCTOR
+
+The constructor returns the Backend object that corresponds to the type in
+$args{repository}.
+
+Currently, the only supported backends are SVN and SVK.
+
+=cut