PATCH RC4 IO::Dir
Mark-Jason Dominus [Thu, 14 Aug 2003 12:02:59 +0000 (08:02 -0400)]
Message-ID: <20030814160259.27586.qmail@plover.com>

p4raw-id: //depot/perl@20710

ext/IO/lib/IO/Dir.pm

index de736cc..e2551f1 100644 (file)
@@ -129,12 +129,13 @@ sub STORE {
 
 sub DELETE {
     my($dh,$key) = @_;
-    # Only unlink if unlink-ing is enabled
-    my $file = File::Spec->catfile(${*$dh}{io_dir_path}, $key);
 
+    # Only unlink if unlink-ing is enabled
     return 0
        unless ${*$dh}{io_dir_unlink};
 
+    my $file = File::Spec->catfile(${*$dh}{io_dir_path}, $key);
+
     -d $file
        ? rmdir($file)
        : unlink($file);
@@ -151,7 +152,7 @@ IO::Dir - supply object methods for directory handles
 =head1 SYNOPSIS
 
     use IO::Dir;
-    $d = new IO::Dir ".";
+    $d = IO::Dir->new(".");
     if (defined $d) {
         while (defined($_ = $d->read)) { something($_); }
         $d->rewind;
@@ -159,7 +160,7 @@ IO::Dir - supply object methods for directory handles
         undef $d;
     }
 
-    tie %dir, IO::Dir, ".";
+    tie %dir, 'IO::Dir', ".";
     foreach (keys %dir) {
        print $_, " " , $dir{$_}->size,"\n";
     }
@@ -203,24 +204,25 @@ for details of these functions.
 =back
 
 C<IO::Dir> also provides an interface to reading directories via a tied
-HASH. The tied HASH extends the interface beyond just the directory
+hash. The tied hash extends the interface beyond just the directory
 reading routines by the use of C<lstat>, from the C<File::stat> package,
 C<unlink>, C<rmdir> and C<utime>.
 
 =over 4
 
-=item tie %hash, IO::Dir, DIRNAME [, OPTIONS ]
+=item tie %hash, 'IO::Dir', DIRNAME [, OPTIONS ]
 
 =back
 
-The keys of the HASH will be the names of the entries in the directory. 
+The keys of the hash will be the names of the entries in the directory. 
 Reading a value from the hash will be the result of calling
-C<File::stat::lstat>. Deleting an element from the hash will call C<unlink>
-providing that C<DIR_UNLINK> is passed in the C<OPTIONS>.
+C<File::stat::lstat>.  Deleting an element from the hash will 
+delete the corresponding file or subdirectory,
+provided that C<DIR_UNLINK> is included in the C<OPTIONS>.
 
-Assigning to an entry in the HASH will cause the time stamps of the file
+Assigning to an entry in the hash will cause the time stamps of the file
 to be modified. If the file does not exist then it will be created. Assigning
-a single integer to a HASH element will cause both the access and 
+a single integer to a hash element will cause both the access and 
 modification times to be changed to that value. Alternatively a reference to
 an array of two values can be passed. The first array element will be used to
 set the access time and the second element will be used to set the modification
@@ -237,7 +239,7 @@ bugs to <perl5-porters@perl.org>.
 
 =head1 COPYRIGHT
 
-Copyright (c) 1997-8 Graham Barr <gbarr@pobox.com>. All rights reserved.
+Copyright (c) 1997-2003 Graham Barr <gbarr@pobox.com>. All rights reserved.
 This program is free software; you can redistribute it and/or
 modify it under the same terms as Perl itself.