From: Gisle Aas <gisle@activestate.com>
Date: Thu, 7 Sep 2006 14:12:14 +0000 (+0000)
Subject: Document mkpath() return value in scalar context.
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=cc61921f0ae7ed05d56abbd690cb97eea560d4a9;p=p5sagit%2Fp5-mst-13.2.git

Document mkpath() return value in scalar context.
Document that rmtree() return value include deleted
directories.

p4raw-id: //depot/perl@28802
---

diff --git a/lib/File/Path.pm b/lib/File/Path.pm
index feaefad..793336e 100644
--- a/lib/File/Path.pm
+++ b/lib/File/Path.pm
@@ -38,7 +38,8 @@ the numeric mode to use when creating the directories
 =back
 
 It returns a list of all directories (including intermediates, determined
-using the Unix '/' separator) created.
+using the Unix '/' separator) created.  In scalar context it returns
+the number of directories created.
 
 If a system error prevents a directory from being created, then the
 C<mkpath> function throws a fatal error with C<Carp::croak>. This error
@@ -81,8 +82,8 @@ than VMS is settled.  (defaults to FALSE)
 
 =back
 
-It returns the number of files successfully deleted.  Symlinks are
-simply deleted and not followed.
+It returns the number of files, directories and symlinks successfully
+deleted.  Symlinks are simply deleted and not followed.
 
 B<NOTE:> There are race conditions internal to the implementation of
 C<rmtree> making it unsafe to use on directory trees which may be