X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FDeploymentHandler%2FDeployMethod%2FSQL%2FTranslator%2FDeprecated.pm;h=db0a1a4949ccd50e94852e216dee0ea803c38909;hb=e80ef6bcfb241e2ab6969e6e8f36259e0bd485c8;hp=d8cf07214beac585fa2f9e0cd69149053ee9f277;hpb=e52174e31b95fe335f6ab8cfdbf23cc2a0c05673;p=dbsrgits%2FDBIx-Class-DeploymentHandler.git

diff --git a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm
index d8cf072..db0a1a4 100644
--- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm
+++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm
@@ -1,5 +1,8 @@
 package DBIx::Class::DeploymentHandler::DeployMethod::SQL::Translator::Deprecated;
 use Moose;
+
+# ABSTRACT: (DEPRECATED) Use this if you are stuck in the past
+
 use Method::Signatures::Simple;
 
 use File::Spec::Functions;
@@ -44,6 +47,22 @@ __PACKAGE__->meta->make_immutable;
 
 __END__
 
+=head1 DESCRIPTION
+
+All this module does is override a few parts of
+L<DBIx::Class::DeployMethd::SQL::Translator> so that the files generated with
+L<DBIx::Class::Schema::Versioned> will work with this out of the box.
+
+=head1 DEPRECATED
+
+I begrudgingly made this module (and other related modules) to keep porting
+from L<DBIx::Class::Schema::Versioned> relatively simple.  I will make changes
+to ensure that it works with output from L<DBIx::Class::Schema::Versioned> etc,
+but I will not add any new features to it.
+
+Once I hit major version 1 usage of this module will emit a warning.
+On version 2 it will be removed entirely.
+
 =head1 THIS SUCKS
 
 Yeah, this old Deprecated thing is a drag.  It can't do downgrades, it can only
@@ -63,3 +82,25 @@ totally switch!  Here's how:
   }
  }
 
+=head1 OVERRIDDEN METHODS
+
+=over
+
+=item *
+
+L<DBIx::Class::DeployMethod::SQL::Translator/_ddl_schema_consume_filenames>
+
+=item *
+
+L<DBIx::Class::DeployMethod::SQL::Translator/_ddl_schema_produce_filename>
+
+=item *
+
+L<DBIx::Class::DeployMethod::SQL::Translator/_ddl_schema_up_produce_filename>
+
+=item *
+
+L<DBIx::Class::DeployMethod::SQL::Translator/_ddl_schema_up_consume_filenames>
+
+=back
+