summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlexis Hildebrandt <afh@surryhill.net>2014-12-31 10:28:39 +0100
committerAlexis Hildebrandt <afh@surryhill.net>2015-01-05 14:13:37 +0100
commit0669ca9b403cace5c0156b7ab140b5490d897886 (patch)
tree083e240560adb23943419e98ac71f23b71205259 /doc
parent6bd2c0e3f6dc8ad4323b191b0f15483eab206188 (diff)
downloadfork-ledger-0669ca9b403cace5c0156b7ab140b5490d897886.tar.gz
fork-ledger-0669ca9b403cace5c0156b7ab140b5490d897886.tar.bz2
fork-ledger-0669ca9b403cace5c0156b7ab140b5490d897886.zip
[doc] Update explanation for validating doc examples
Diffstat (limited to 'doc')
-rw-r--r--doc/ledger3.texi9
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
index 6a1ddccd..0cc29254 100644
--- a/doc/ledger3.texi
+++ b/doc/ledger3.texi
@@ -22,8 +22,8 @@
@c How to make documented ledger examples validate automatically.
@c
-@c The test/DocTests.py script will be run along the with the other
-@c tests when using ctest or acprep check.
+@c The test/DocTests.py script will be run along with the other tests
+@c when using ctest or acprep check.
@c The script parses the texinfo file and looks for three kinds of
@c specially marked @smallexamples, then it will run the ledger
@c command from the example, and compare the results with the output
@@ -86,9 +86,8 @@
@c $ 36.84 Expenses:Food:Dining
@c @end smallexample
@c
-@c Additionally DocTests.py will pass --init-file /dev/null to ledger to
-@c ignore any default arguments to ledger the user running the tests
-@c has configured.
+@c Additionally DocTests.py will pass --args-only and --columns 80 to ledger
+@c to ignore any default arguments from the environment or .ledgerrc.
@c
@c To manually run the tests in this file run:
@c $ ./test/DocTests.py -vv --ledger ./ledger --file ./doc/ledger3.texi