Document how to add perltidy markers via filter_generated_code

diff --git a/Changes b/Changes
index 6a4191e..7893b35 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,6 +1,7 @@
 Revision history for Perl extension DBIx::Class::Schema::Loader
 
         - Fix many_to_many bridges with overlapping foreign keys
+        - Document how to add perltidy markers via filter_generated_code
 
 0.07042  2014-08-20
         - Fix unescaped left braces in regexes in tests

diff --git a/lib/DBIx/Class/Schema/Loader.pm b/lib/DBIx/Class/Schema/Loader.pm
index d3ee1ef..55b1398 100644 (file)
--- a/lib/DBIx/Class/Schema/Loader.pm
+++ b/lib/DBIx/Class/Schema/Loader.pm
@@ -679,6 +679,8 @@ Dag-Erling Smørgrav <des@des.no>
 
 moritz: Moritz Lenz <moritz@faui2k3.org>
 
+oalders: Olaf Alders <olaf@wundersolutions.com>
+
 ... and lots of other folks. If we forgot you, please write the current
 maintainer or RT.
 

diff --git a/lib/DBIx/Class/Schema/Loader/Base.pm b/lib/DBIx/Class/Schema/Loader/Base.pm
index 29c11b1..ab03a98 100644 (file)
--- a/lib/DBIx/Class/Schema/Loader/Base.pm
+++ b/lib/DBIx/Class/Schema/Loader/Base.pm
@@ -1013,6 +1013,17 @@ be generated.
         return $new_code;
     }
 
+You can also use this option to set L<perltidy markers|perltidy/Skipping
+Selected Sections of Code> in your generated classes.  This will leave
+the generated code in the default format, but will allow you to tidy
+your classes at any point in future, without worrying about changing the
+portions of the file which are checksummed, since C<perltidy> will just
+ignore all text between the markers.
+
+    filter_generated_code => sub {
+        return "#<<<\n$_[2]\n#>>>";
+    }
+
 =head1 METHODS
 
 None of these methods are intended for direct invocation by regular