Update Changes and README
Chris Marshall [Sun, 13 Jun 2010 15:02:21 +0000 (11:02 -0400)]
Note that README is just the output of 'perldoc -t Devel::REPL'
so I that POD was updated to be consistent with the information
in README and then README was generated with perldoc.  If there
is no other information in README, maybe it should be generated
by the distribution process.

Changes
README
lib/Devel/REPL.pm

diff --git a/Changes b/Changes
index f9ea309..3b77c5d 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,5 +1,11 @@
+1.003010_01
+  - Add ReadLine file completion if no other matches, fixes rt.cpan#58351
+  - Add a bit more description of Turtle plugin to its POD
+  - Fix rt.cpan#43151 where _-> completion had error
+  - Add some missing functionality to t/load_core.t test coverage
+  - Added docs on quoting and history expansion addressing rt.cpan#48459
 1.3.10
-- Add exit_repl attribute as a non-signal related way to indicate the REPL should stop running.
+  - Add exit_repl attribute as a non-signal related way to indicate the REPL should stop running.
 1.3.9_02
   - resolve rt.cpan#45879 by implementing Term::ReadLine::Perl support for ReadLineHistory
   - resolve rt.cpan#55491 by skipping Interrupt test for win32
diff --git a/README b/README
index 6fb72cb..3853e94 100644 (file)
--- a/README
+++ b/README
@@ -27,13 +27,13 @@ USAGE
     given. If the code executes successfully you'll be shown the result,
     otherwise an error message will be returned. Here are a few examples:
 
-      $_ print "Hello, world!\n"
-      Hello, world!
-      1
-      $_ nosuchfunction
-      Compile error: Bareword "nosuchfunction" not allowed while "strict subs" in use at (eval 130) line 5.
-      
-      $_
+     $_ print "Hello, world!\n"
+     Hello, world!
+     1
+     $_ nosuchfunction
+     Compile error: Bareword "nosuchfunction" not allowed while "strict subs" in use at (eval 130) line 5.
+
+     $_
 
     In the first example above you see the output of the command ("Hello,
     world!"), if any, and then the return value of the statement (1).
@@ -56,25 +56,24 @@ USAGE
     When you "use" any Perl module, the "import()" will work as expected -
     the exported functions from that module are available for immediate use:
 
-      $_ carp "I'm dieeeing!\n"
-      String found where operator expected at (eval 129) line 5, near "carp "I'm dieeeing!\n""
-              (Do you need to predeclare carp?)
-      Compile error: syntax error at (eval 129) line 5, near "carp "I'm dieeeing!\n""
-      BEGIN not safe after errors--compilation aborted at (eval 129) line 5.
-      
-      $_ use Carp 
-       
-      $_ carp "I'm dieeeing!\n"
-      I'm dieeeing!
-       at /usr/share/perl5/Lexical/Persistence.pm line 327
-      1
-      $_
+     $_ carp "I'm dieeeing!\n"
+     String found where operator expected at (eval 129) line 5, near "carp "I'm dieeeing!\n""
+             (Do you need to predeclare carp?)
+     Compile error: syntax error at (eval 129) line 5, near "carp "I'm dieeeing!\n""
+     BEGIN not safe after errors--compilation aborted at (eval 129) line 5.
+
+     $_ use Carp
+
+     $_ carp "I'm dieeeing!\n"
+     I'm dieeeing!
+      at /usr/share/perl5/Lexical/Persistence.pm line 327
+     1
+     $_
 
     To quit from the shell, hit "Ctrl+D" or "Ctrl+C".
 
-    MSWin32 NOTE: control keys won't work if TERM=dumb
-                  because readline functionality will be
-                 disabled.
+      MSWin32 NOTE: control keys won't work if TERM=dumb
+      because readline functionality will be disabled.
 
   Run Control Files
     For particular projects you might well end up running the same commands
@@ -89,12 +88,12 @@ USAGE
     To set a new run control file that's also in that directory, pass it as
     a filename like so:
 
-      system$ re.pl --rcfile myproject.pc
+     system$ re.pl --rcfile myproject.pc
 
     If the filename happens to contain a forwardslash, then it's used
-    absolutely, or relative to the current working directory:
+    absolutely, or realive to the current working directory:
 
-      system$ re.pl --rcfile /path/to/my/project/repl.rc
+     system$ re.pl --rcfile /path/to/my/project/repl.rc
 
     Within the run control file you might want to load plugins. This is
     covered in "The REPL shell object" section, below.
@@ -131,9 +130,9 @@ USAGE
     the CPAN. Some of the shipped plugins are loaded in the default profile,
     mentioned above.
 
-    Writing your own plugins is not difficult once you understand all about
-    Moose and Moose Roles.  A Devel::REPL::Plugin manual page is planned but
-    not yet written.
+    Writing your own plugins is not difficult, and is discussed in the
+    Devel::REPL::Plugin manual page, along with links to the manual pages of
+    all the plugins shipped with "Devel::REPL".
 
   The REPL shell object
     From time to time you'll want to interact with or manipulate the
@@ -156,13 +155,13 @@ REQUIREMENTS
     In addition to the contents of the standard Perl distribution, you will
     need the following:
 
-    *   Moose >= 0.64
+    *   Moose >= 0.74
 
     *   MooseX::Object::Pluggable >= 0.0009
 
-    *   MooseX::Getopt >= 0.15
+    *   MooseX::Getopt >= 0.18
 
-    *   MooseX::AttributeHelpers >= 0.14
+    *   MooseX::AttributeHelpers >= 0.16
 
     *   namespace::clean
 
@@ -170,6 +169,12 @@ REQUIREMENTS
 
     *   Task::Weaken
 
+    *   B::Concise
+
+    *   Term::ANSIColor
+
+    *   Devel::Peek
+
     Optionally, some plugins if installed will require the following
     modules:
 
@@ -177,8 +182,12 @@ REQUIREMENTS
 
     *   Data::Dump::Streamer
 
+    *   Data::Dumper::Concise
+
     *   File::Next
 
+    *   Sys::SigAction
+
     *   B::Keywords
 
     *   Lexical::Persistence
@@ -192,12 +201,15 @@ AUTHOR
     (<http://www.shadowcatsystems.co.uk/>)
 
 CONTRIBUTORS
-    Stevan Little  - stevan (at) iinteractive.com
+    Stevan Little - stevan (at) iinteractive.com
     Alexis Sukrieh - sukria+perl (at) sukria.net
     epitaph
-    mgrimes        - mgrimes (at) cpan (dot) org
-    Shawn M Moore  - sartak (at) gmail.com
+    mgrimes - mgrimes (at) cpan dot org
+    Shawn M Moore - sartak (at) gmail.com
     Oliver Gorwits - oliver on irc.perl.org
+    Andrew Moore - "<amoore@cpan.org>"
+    Norbert Buchmuller "<norbi@nix.hu>"
+    Dave Houston "<dhouston@cpan.org>"
     Chris Marshall
 
 LICENSE
index a77dcaf..c46dcc6 100644 (file)
@@ -223,7 +223,11 @@ exported functions from that module are available for immediate use:
  1
  $_
 
-To quit from the shell, hit C<control+d> or C<control+c>.
+To quit from the shell, hit C<Ctrl+D> or C<Ctrl+C>.
+
+  MSWin32 NOTE: control keys won't work if TERM=dumb
+  because readline functionality will be disabled.
+
 
 =head2 Run Control Files
 
@@ -328,7 +332,7 @@ the following:
 
 =item *
 
-L<Moose> >= 0.64
+L<Moose> >= 0.74
 
 =item *
 
@@ -336,11 +340,11 @@ L<MooseX::Object::Pluggable> >= 0.0009
 
 =item *
 
-L<MooseX::Getopt> >= 0.15
+L<MooseX::Getopt> >= 0.18
 
 =item *
 
-L<MooseX::AttributeHelpers> >= 0.14
+L<MooseX::AttributeHelpers> >= 0.16
 
 =item *
 
@@ -354,6 +358,18 @@ L<File::HomeDir>
 
 L<Task::Weaken>
 
+=item *
+
+L<B::Concise>
+
+=item *
+
+L<Term::ANSIColor>
+
+=item *
+
+L<Devel::Peek>
+
 =back
 
 Optionally, some plugins if installed will require the following modules:
@@ -370,10 +386,18 @@ L<Data::Dump::Streamer>
 
 =item *
 
+L<Data::Dumper::Concise>
+
+=item *
+
 L<File::Next>
 
 =item *
 
+L<Sys::SigAction>
+
+=item *
+
 L<B::Keywords>
 
 =item *
@@ -416,6 +440,8 @@ Matt S Trout - mst (at) shadowcatsystems.co.uk (L<http://www.shadowcatsystems.co
 
 =item Dave Houston C<< <dhouston@cpan.org> >>
 
+=item Chris Marshall
+
 =back
 
 =head1 LICENSE