summaryrefslogtreecommitdiff
path: root/devel/p5-Data-Dump/DESCR
diff options
context:
space:
mode:
Diffstat (limited to 'devel/p5-Data-Dump/DESCR')
-rw-r--r--devel/p5-Data-Dump/DESCR12
1 files changed, 12 insertions, 0 deletions
diff --git a/devel/p5-Data-Dump/DESCR b/devel/p5-Data-Dump/DESCR
new file mode 100644
index 00000000000..72b285ef5cd
--- /dev/null
+++ b/devel/p5-Data-Dump/DESCR
@@ -0,0 +1,12 @@
+This module provides a single function called dump() that takes a
+list of values as its argument and produces a string as its result.
+The string contains Perl code that, when evaled, produces a deep
+copy of the original arguments. The string is formatted for easy
+reading.
+
+If dump() is called in a void context, then the dump is printed on
+STDERR instead of being returned.
+
+If you don't like importing a function that overrides Perl's
+not-so-useful builtin, then you can also import the same function
+as pp(), mnemonic for "pretty-print".