[Bps-public-commit] r12905 - in Shipwright: trunk/lib/Shipwright/Backend
spang at bestpractical.com
spang at bestpractical.com
Wed Jun 4 20:23:37 EDT 2008
Author: spang
Date: Wed Jun 4 20:23:34 2008
New Revision: 12905
Modified:
Shipwright/ (props changed)
Shipwright/trunk/lib/Shipwright/Backend/SVK.pm
Shipwright/trunk/lib/Shipwright/Backend/SVN.pm
Log:
r40816 at loki: spang | 2008-06-04 19:22:04 -0400
Cleanup pod in Backend/SVN.pm and Backend/SVK.pm
Modified: Shipwright/trunk/lib/Shipwright/Backend/SVK.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Backend/SVK.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Backend/SVK.pm Wed Jun 4 20:23:34 2008
@@ -14,8 +14,17 @@
use base qw/Class::Accessor::Fast/;
__PACKAGE__->mk_accessors(qw/repository log/);
-=head2 new
+=head1 NAME
+
+Shipwright::Backend::SVK - SVK repository backend
+
+=head1 DESCRIPTION
+
+=head1 CONSTRUCTOR
+=head1 METHODS
+
+=over
=cut
sub new {
@@ -27,9 +36,9 @@
return $self;
}
-=head2 initialize
+=item initialize
-initialize a project
+Initialize a project.
=cut
@@ -56,9 +65,9 @@
);
}
-=head2 import
+=item import
-import a dist
+Import a dist.
=cut
@@ -113,9 +122,9 @@
}
}
-=head2 export
+=item export
-export a project, partly or as a whole
+A wrapper around svk's export command. Export a project, partly or as a whole.
=cut
@@ -129,10 +138,10 @@
Shipwright::Util->run( $self->_cmd( checkout => %args, detach => 1 ) );
}
-=head2 checkout
+=item checkout
-a wrapper of checkout cmd of svk
-checkout a project, partly or as a whole
+A wrapper around svk's checkout command. Checkout a project, partly or as a
+whole.
=cut
@@ -145,9 +154,9 @@
Shipwright::Util->run( $self->_cmd( checkout => %args ) );
}
-=head2 commit
+=item commit
-a wrapper of commit cmd of svk
+A wrapper around svk's commit command.
=cut
@@ -263,9 +272,9 @@
}
}
-=head2 update_order
+=item update_order
-regenate order
+Regenerate the dependency order.
=cut
@@ -331,9 +340,9 @@
}
}
-=head2 order
+=item order
-get or set order
+Get or set the dependency order.
=cut
@@ -360,9 +369,9 @@
}
}
-=head2 map
+=item map
-get or set map
+Get or set the map.
=cut
@@ -389,9 +398,9 @@
}
}
-=head2 source
+=item source
-get or set source
+Get or set the sources map.
=cut
@@ -418,9 +427,9 @@
}
}
-=head2 delete
+=item delete
-wrapper of delete cmd of svk
+A wrapper around svk's delete command.
=cut
@@ -434,9 +443,9 @@
}
}
-=head2 info
+=item info
-wrapper of info cmd of svk
+A wrapper around svk's info command.
=cut
@@ -458,9 +467,9 @@
}
}
-=head2 propset
+=item propset
-wrapper of propset cmd of svk
+A wrapper around svk's propset command.
=cut
@@ -472,9 +481,9 @@
$self->log->warn($err) if $err;
}
-=head2 test_script
+=item test_script
-set test_script for a project, aka. udpate t/test script
+Set test_script for a project, i.e. update the t/test script.
=cut
@@ -497,8 +506,10 @@
$self->checkout( detach => 1, target => $file );
}
-=head2 requires
-return hashref to require.yml for a dist
+=item requires
+
+Return the hashref of require.yml for a dist.
+
=cut
sub requires {
@@ -511,9 +522,9 @@
return Shipwright::Util::Load($string) || {};
}
-=head2 flags
+=item flags
-get or set flags
+Get or set flags.
=cut
@@ -541,9 +552,9 @@
}
}
-=head2 version
+=item version
-get or set version
+Get or set version.
=cut
@@ -574,7 +585,9 @@
}
}
-=head2 check_repository
+=item check_repository
+
+Check if the given repository is valid.
=cut
@@ -611,9 +624,9 @@
return 0;
}
-=head2 update
+=item update
-update shipwright's own files, e.g. bin/shipwright-builder
+Update shipwright's own files, e.g. bin/shipwright-builder.
=cut
@@ -646,42 +659,7 @@
$self->checkout( detach => 1, target => $file );
}
-1;
-
-__END__
-
-=head1 NAME
-
-Shipwright::Backend::SVK - svk backend
-
-
-=head1 DESCRIPTION
-
-
-=head1 DEPENDENCIES
-
-
-None.
-
-
-=head1 INCOMPATIBILITIES
-
-None reported.
-
-
-=head1 BUGS AND LIMITATIONS
-
-No bugs have been reported.
-
-=head1 AUTHOR
-
-sunnavy C<< <sunnavy at bestpractical.com> >>
-
-
-=head1 LICENCE AND COPYRIGHT
-
-Copyright 2007 Best Practical Solutions.
-
-This program is free software; you can redistribute it and/or modify it
-under the same terms as Perl itself.
+=back
+=cut
+1;
Modified: Shipwright/trunk/lib/Shipwright/Backend/SVN.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Backend/SVN.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Backend/SVN.pm Wed Jun 4 20:23:34 2008
@@ -14,7 +14,15 @@
use base qw/Class::Accessor::Fast/;
__PACKAGE__->mk_accessors(qw/repository log/);
-=head2 new
+=head1 NAME
+
+Shipwright::Backend::SVN - SVN repository backend
+
+=head1 DESCRIPTION
+
+=head1 CONSTRUCTOR
+
+=head1 METHODS
=cut
@@ -27,9 +35,9 @@
return $self;
}
-=head2 initialize
+=item initialize
-initialize a project
+Initialize a project.
=cut
@@ -56,9 +64,9 @@
}
-=head2 import
+=item import
-import a dist
+Import a dist.
=cut
@@ -118,10 +126,9 @@
}
}
-=head2 export
+=item export
-a wrapper of export cmd of svn
-export a project, partly or as a whole
+A wrapper around svn's export command. Export a project, partly or as a whole.
=cut
@@ -134,10 +141,10 @@
Shipwright::Util->run( $self->_cmd( export => %args ) );
}
-=head2 checkout
+=item checkout
-a wrapper of checkout cmd of svn
-checkout a project, partly or as a whole
+A wrapper around svn's checkout command. Checkout a project, partly or as a
+whole.
=cut
@@ -150,9 +157,9 @@
Shipwright::Util->run( $self->_cmd( checkout => @_ ) );
}
-=head2 commit
+=item commit
-a wrapper of commit cmd of svn
+A wrapper around svn's commit command.
=cut
@@ -259,9 +266,9 @@
}
}
-=head2 update_order
+=item update_order
-regenate order
+Regenerate the dependency order.
=cut
@@ -326,9 +333,9 @@
}
}
-=head2 order
+=item order
-get or set order
+Get or set the dependency order.
=cut
@@ -355,9 +362,9 @@
}
}
-=head2 map
+=item map
-get or set map
+Get or set the map.
=cut
@@ -384,9 +391,9 @@
}
}
-=head2 source
+=item source
-get or set source
+Get or set the sources map.
=cut
@@ -413,9 +420,9 @@
}
}
-=head2 delete
+=item delete
-wrapper of delete cmd of svn
+A wrapper around svn's delete command.
=cut
@@ -430,9 +437,9 @@
}
}
-=head2 info
+=item info
-wrapper of info cmd of svn
+A wrapper around svn's info command.
=cut
@@ -457,9 +464,9 @@
}
}
-=head2 propset
+=item propset
-wrapper of propset cmd of svn
+A wrapper around svn's propset command.
=cut
@@ -482,9 +489,9 @@
);
}
-=head2 test_script
+=item test_script
-set test_script for a project, aka. udpate t/test script
+Set test_script for a project, i.e. update the t/test script.
=cut
@@ -507,8 +514,10 @@
$self->commit( path => $file, comment => "update test script" );
}
-=head2 requires
-return hashref to require.yml for a dist
+=item requires
+
+Return the hashref of require.yml for a dist.
+
=cut
sub requires {
@@ -521,9 +530,9 @@
return Shipwright::Util::Load($string) || {};
}
-=head2 flags
+=item flags
-get or set flags
+Get or set flags.
=cut
@@ -550,9 +559,9 @@
}
}
-=head2 version
+=item version
-get or set version
+Get or set version.
=cut
@@ -583,7 +592,9 @@
}
}
-=head2 check_repository
+=item check_repository
+
+Check if the given repository is valid.
=cut
@@ -609,9 +620,9 @@
return 0;
}
-=head2 update
+=item update
-update shipwright's own files, e.g. bin/shipwright-builder
+Update shipwright's own files, e.g. bin/shipwright-builder.
=cut
@@ -645,43 +656,7 @@
);
}
}
+=back
+=cut
1;
-
-__END__
-
-=head1 NAME
-
-Shipwright::Backend::SVN - svn backend
-
-
-=head1 DESCRIPTION
-
-
-=head1 DEPENDENCIES
-
-
-None.
-
-
-=head1 INCOMPATIBILITIES
-
-None reported.
-
-
-=head1 BUGS AND LIMITATIONS
-
-No bugs have been reported.
-
-=head1 AUTHOR
-
-sunnavy C<< <sunnavy at bestpractical.com> >>
-
-
-=head1 LICENCE AND COPYRIGHT
-
-Copyright 2007 Best Practical Solutions.
-
-This program is free software; you can redistribute it and/or modify it
-under the same terms as Perl itself.
-
More information about the Bps-public-commit
mailing list