Merge pull request #1092 from ocaml/doc-tests-use-stanza

Quickstart: use short test stanza
This commit is contained in:
Etienne Millon 2018-08-03 15:44:31 +02:00 committed by GitHub
commit 23e7273934
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 4 deletions

View File

@ -250,10 +250,7 @@ Write this in your ``dune`` file:
.. code:: scheme
(alias
(name runtest)
(deps (:my-prog my-test-program.exe))
(action (run %{my-prog})))
(test (name my_test_program))
And run the tests with:
@ -261,6 +258,18 @@ And run the tests with:
dune runtest
It will run the test program (the main module is ``my_test_program.ml``) and
error if it exits with a nonzero code.
In addition, if a ``my_test_program.expected`` file exists, it will be compared
to the standard output of the test program and the differences will be
displayed. It is possible to replace the ``.expected`` file with the last output
using:
.. code:: bash
dune promote
Building a custom toplevel
==========================