[Bps-public-commit] r15982 - Module-Install-RTx

[ruz at bestpractical.com]

Author: ruz
Date: Mon Sep 15 15:36:19 2008
New Revision: 15982

Modified:
   Module-Install-RTx/README

Log:
* regen README using pod2text

Modified: Module-Install-RTx/README
==============================================================================
--- Module-Install-RTx/README	(original)
+++ Module-Install-RTx/README	Mon Sep 15 15:36:19 2008
@@ -2,15 +2,11 @@
     Module::Install::RTx - RT extension installer
 
 SYNOPSIS
-    In the Makefile.PL of the "RTx-Foo" module:
+    In the Makefile.PL of the "RT-Extension-Foo" module:
 
         use inc::Module::Install;
-
-        RTx('Foo');
-        author('Your Name <your at email.com>');
-        license('perl');
-
-        &WriteAll;
+        RTx 'RT-Extension-Foo';
+        WriteAll();
 
 DESCRIPTION
     This Module::Install extension implements one function, "RTx", that
@@ -48,6 +44,17 @@
 
         perl Makefile.PL WITH_SUBDIRS=sbin
 
+CAVEATS
+    * Use full name when call RTx method in Makefile.PL, some magic has been
+    implemented in this installer to support RTx('Foo') for 'RTx-Foo'
+    extension, but life proved that it's bad idea. Code still there for
+    backwards compatibility. It will be deleted eventually.
+    * installer want work with RT 3.8.0, as it has some bugs new plugins
+    sub-system.
+    * layout of files has been changed between RT 3.6 and RT 3.8, old files
+    may influence behaviour of your extension. Recommend people use clean
+    dir on upgrade or guide how to remove old versions of your extension.
+
 ENVIRONMENT
     RTHOME
         Path to the RT installation that contains a valid lib/RT.pm.