Skip to content

Commit

Permalink
change documentation regarding error handling on root nodes. bump ver…
Browse files Browse the repository at this point in the history
…sion in prep for public release.
  • Loading branch information
relberger committed Oct 7, 2015
1 parent 28f9f6b commit dbd8dab
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
6 changes: 6 additions & 0 deletions Changes
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
Revision history for Perl extension File::Path.

2.12 2015-10-07
- Change ERROR HANDLING doc section to be very clear about the error
handling mechanism for root nodes.
- Change ERROR HANDLING doc section to remove the EXPERIMENTAL note; the
error handling mechanism has been in place for several versions.

2.11_004 2015-10-01
- Revert change made in 2.10_001 to carp on failure to find root directory
when performing an rmtree.
Expand Down
13 changes: 8 additions & 5 deletions lib/File/Path.pm
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ BEGIN {

use Exporter ();
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
$VERSION = '2.11_004';
$VERSION = '2.12';
$VERSION = eval $VERSION;
@ISA = qw(Exporter);
@EXPORT = qw(mkpath rmtree);
Expand Down Expand Up @@ -576,7 +576,7 @@ File::Path - Create or remove directory trees
=head1 VERSION
This document describes version 2.11_003 of File::Path.
This document describes version 2.12 of File::Path.
=head1 SYNOPSIS
Expand Down Expand Up @@ -804,9 +804,12 @@ remove_tree().
=item B<NOTE:>
The following error handling mechanism is considered
experimental and is subject to change pending feedback from
users.
The following error handling mechanism is consistent throughout all
code paths EXCEPT in cases where the ROOT node is nonexistent. In
version 2.11 the maintainers attempted to rectify this inconsistency
but too many downstream modules encountered problems. In such case,
if you require root node evaluation or error checking prior to calling
C<make_path> or C<remove_tree>, you should take additional precautions.
=back
Expand Down

0 comments on commit dbd8dab

Please sign in to comment.