aboutsummaryrefslogtreecommitdiff
path: root/devel/p5-File-Slurp-Tree/pkg-descr
diff options
context:
space:
mode:
Diffstat (limited to 'devel/p5-File-Slurp-Tree/pkg-descr')
-rw-r--r--devel/p5-File-Slurp-Tree/pkg-descr14
1 files changed, 14 insertions, 0 deletions
diff --git a/devel/p5-File-Slurp-Tree/pkg-descr b/devel/p5-File-Slurp-Tree/pkg-descr
new file mode 100644
index 000000000000..146586c6f297
--- /dev/null
+++ b/devel/p5-File-Slurp-Tree/pkg-descr
@@ -0,0 +1,14 @@
+File::Slurp::Tree provides functions for slurping and emitting trees
+of files and directories.
+
+ # an example of use in a test suite
+ use Test::More tests => 1;
+ use File::Slurp::Tree;
+ is_deeply( slurp_tree( "t/some_path" ), { foo => {}, bar => "sample\n" },
+ "some_path contains a directory called foo, and a file bar" );
+
+The tree datastructure is a hash of hashes. The keys of each hash are
+names of directories or files. Directories have hash references as
+their value, files have a scalar which holds the contents of the file.
+
+WWW: http://search.cpan.org/dist/File-Slurp-Tree/