LOGONLY mark 1b1ee2,065144 as NODOC since they're more test improvement thangs

[p5sagit/p5-mst-13.2.git] / lib / finddepth.pl

diff --git a/lib/finddepth.pl b/lib/finddepth.pl
index 5814a44..331247a 100644 (file)
--- a/lib/finddepth.pl
+++ b/lib/finddepth.pl
@@ -1,3 +1,8 @@
+# This library is deprecated and unmaintained. It is included for
+# compatibility with Perl 4 scripts which may use it, but it will be
+# removed in a future version of Perl. Please use the File::Find module
+# instead.
+
 # Usage:
 #      require "finddepth.pl";
 #
@@ -10,11 +15,11 @@
 #              to $dir when the function is called.  The function may
 #              set $prune to prune the tree.
 #
-# This library is primarily for find2perl, which, when fed
+# For example,
 #
-#   find2perl / -name .nfs\* -mtime +7 -exec rm -f {} \; -o -fstype nfs -prune
+#   find / -name .nfs\* -mtime +7 -exec rm -f {} \; -o -fstype nfs -prune
 #
-# spits out something like this
+# corresponds to this
 #
 #      sub wanted {
 #          /^\.nfs.*$/ &&
@@ -30,9 +35,14 @@
 
 use File::Find ();
 
-*name = *File::Find::name;
-*prune = *File::Find::prune;
-*dir = *File::Find::dir;
+*name          = *File::Find::name;
+*prune         = *File::Find::prune;
+*dir           = *File::Find::dir;
+*topdir                = *File::Find::topdir;
+*topdev                = *File::Find::topdev;
+*topino                = *File::Find::topino;
+*topmode       = *File::Find::topmode;
+*topnlink      = *File::Find::topnlink;
 
 sub finddepth {
     &File::Find::finddepth(\&wanted, @_);