This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document mkpath() return value in scalar context.
authorGisle Aas <gisle@activestate.com>
Thu, 7 Sep 2006 14:12:14 +0000 (14:12 +0000)
committerGisle Aas <gisle@activestate.com>
Thu, 7 Sep 2006 14:12:14 +0000 (14:12 +0000)
Document that rmtree() return value include deleted
directories.

p4raw-id: //depot/perl@28802

lib/File/Path.pm

index feaefad..793336e 100644 (file)
@@ -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