summaryrefslogtreecommitdiff
path: root/pod/modpods/CheckTree.pod
diff options
context:
space:
mode:
Diffstat (limited to 'pod/modpods/CheckTree.pod')
-rw-r--r--pod/modpods/CheckTree.pod37
1 files changed, 37 insertions, 0 deletions
diff --git a/pod/modpods/CheckTree.pod b/pod/modpods/CheckTree.pod
new file mode 100644
index 0000000000..cc06eeeda3
--- /dev/null
+++ b/pod/modpods/CheckTree.pod
@@ -0,0 +1,37 @@
+=head1 NAME
+
+validate - run many filetest checks on a tree
+
+=head1 SYNOPSIS
+
+ use File::CheckTree;
+
+ $warnings += validate( q{
+ /vmunix -e || die
+ /boot -e || die
+ /bin cd
+ csh -ex
+ csh !-ug
+ sh -ex
+ sh !-ug
+ /usr -d || warn "What happened to $file?\n"
+ });
+
+=head1 DESCRIPTION
+
+The validate() routine takes a single multiline string consisting of
+lines containing a filename plus a file test to try on it. (The
+file test may also be a "cd", causing subsequent relative filenames
+to be interpreted relative to that directory.) After the file test
+you may put C<|| die> to make it a fatal error if the file test fails.
+The default is C<|| warn>. The file test may optionally have a "!' prepended
+to test for the opposite condition. If you do a cd and then list some
+relative filenames, you may want to indent them slightly for readability.
+If you supply your own die() or warn() message, you can use $file to
+interpolate the filename.
+
+Filetests may be bunched: "-rwx" tests for all of C<-r>, C<-w>, and C<-x>.
+Only the first failed test of the bunch will produce a warning.
+
+The routine returns the number of warnings issued.
+