aboutsummaryrefslogtreecommitdiffstats
path: root/lib/eunit/doc/overview.edoc
diff options
context:
space:
mode:
authorRichard Carlsson <[email protected]>2016-05-19 21:07:14 +0200
committerRichard Carlsson <[email protected]>2016-05-20 09:07:15 +0200
commit10e106229b5a2006f2e7cf337a048859011f8798 (patch)
tree1e76b7182cbef40286f813cc3cdc3e58bdd14c49 /lib/eunit/doc/overview.edoc
parent37b60d5b365e814c83974cdac0f1eed04dab0ad3 (diff)
downloadotp-10e106229b5a2006f2e7cf337a048859011f8798.tar.gz
otp-10e106229b5a2006f2e7cf337a048859011f8798.tar.bz2
otp-10e106229b5a2006f2e7cf337a048859011f8798.zip
Replace suggested debugValAll/1 macro with debugVal/2
Also make the default depth for debugVal/1 possible to override by defining the macro EUNIT_DEBUG_VAL_DEPTH.
Diffstat (limited to 'lib/eunit/doc/overview.edoc')
-rw-r--r--lib/eunit/doc/overview.edoc11
1 files changed, 6 insertions, 5 deletions
diff --git a/lib/eunit/doc/overview.edoc b/lib/eunit/doc/overview.edoc
index ca7ffb83a4..3a46e991cb 100644
--- a/lib/eunit/doc/overview.edoc
+++ b/lib/eunit/doc/overview.edoc
@@ -690,11 +690,12 @@ it like `debugMsg'. The result is always `ok'.</dd>
<dt>`debugVal(Expr)'</dt>
<dd>Prints both the source code for `Expr' and its current value. E.g.,
`?debugVal(f(X))' might be displayed as "`f(X) = 42'". (Large terms are
-shown truncated.) The result is always the value of `Expr', so this
-macro can be wrapped around any expression to display its value when
-the code is compiled with debugging enabled.</dd>
-<dt>`debugValAll(Expr)'</dt>
-<dd>This is almost same as `debugVal(Expr)`, but doesn't truncate terms to print.</dd>
+truncated to the depth given by the macro `EUNIT_DEBUG_VAL_DEPTH', which
+defaults to 15 but can be overridden by the user.) The result is always the
+value of `Expr', so this macro can be wrapped around any expression to
+display its value when the code is compiled with debugging enabled.</dd>
+<dt>`debugVal(Expr, Depth)'</dt>
+<dd>Like `debugVal(Expr)', but prints terms truncated to the given depth.</dd>
<dt>`debugTime(Text,Expr)'</dt>
<dd>Prints `Text' and the wall clock time for evaluation of `Expr'. The
result is always the value of `Expr', so this macro can be wrapped