From dbd8dab8a0271adb9f8c1d563ff8bc76b05e4e5e Mon Sep 17 00:00:00 2001 From: relberger Date: Wed, 7 Oct 2015 18:26:40 -0400 Subject: [PATCH] change documentation regarding error handling on root nodes. bump version in prep for public release. --- Changes | 6 ++++++ lib/File/Path.pm | 13 ++++++++----- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/Changes b/Changes index d16309c..e5e46c7 100644 --- a/Changes +++ b/Changes @@ -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. diff --git a/lib/File/Path.pm b/lib/File/Path.pm index edde607..36f12cc 100644 --- a/lib/File/Path.pm +++ b/lib/File/Path.pm @@ -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); @@ -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 @@ -804,9 +804,12 @@ remove_tree(). =item B -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 or C, you should take additional precautions. =back