lots more doc

[dbsrgits/DBIx-Class-DeploymentHandler.git] / lib / DBIx / Class / DeploymentHandler / DeployMethod / SQL / Translator / Deprecated.pm

diff --git a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm
index 96fb073..db0a1a4 100644 (file)
--- a/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm
+++ b/lib/DBIx/Class/DeploymentHandler/DeployMethod/SQL/Translator/Deprecated.pm
@@ -47,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
@@ -66,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
+