Skip to content

Commit ae72520

Browse files
committed
Update Testing Docs
- document `abort_on_unused_inputs` - remove duplicate superfluous argument in regtest call
1 parent cc3cd14 commit ae72520

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

Docs/sphinx_documentation/source/Testing.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ application codes that use it as a framework. We use an in-house test runner scr
1818
operation, originally developed by Michael Zingale for the Castro code, and later expanded to other
1919
application codes as well. The results for each night are collected and stored on a web page; see
2020
https://ccse.lbl.gov/pub/RegressionTesting/ for the latest set of results.
21+
The runtime option ``amrex.abort_on_unused_inputs`` (``0`` or ``1``; default is ``0`` for false) is useful for making sure that tests always stay up to date with API changes as it will abort the application after the test run if any unused input parameters were detected.
2122

2223
Running the test suite locally
2324
==============================
@@ -73,7 +74,7 @@ re-run the script without the :cpp:`--make_benchmarks` option:
7374

7475
::
7576

76-
python regtest.py --make_benchmarks 'generating initial benchmarks' AMReX-tests.ini
77+
python regtest.py AMReX-tests.ini
7778

7879
The script will generate a set of html pages in the directory specified in your :cpp:`AMReX-tests.ini`
7980
file that you can examine using the browser of your choice.

0 commit comments

Comments
 (0)