summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark C. Miller <miller86@llnl.gov>2021-01-27 09:08:27 -0800
committerGitHub <noreply@github.com>2021-01-27 09:08:27 -0800
commitf7665858828b3b936e3d8375efd69f3d7b7ff29d (patch)
tree03f218dae4f339a316b452306932ee2ef7fac324
parent6ba2e3ee5dbd2a3a9119a0176dedf76dde3c3a32 (diff)
downloadspack-f7665858828b3b936e3d8375efd69f3d7b7ff29d.tar.gz
spack-f7665858828b3b936e3d8375efd69f3d7b7ff29d.tar.bz2
spack-f7665858828b3b936e3d8375efd69f3d7b7ff29d.tar.xz
spack-f7665858828b3b936e3d8375efd69f3d7b7ff29d.zip
Doc default behavior of install tests (#21309)
Co-authored-by: Tamara Dahlgren <35777542+tldahlgren@users.noreply.github.com>
-rw-r--r--lib/spack/docs/packaging_guide.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/spack/docs/packaging_guide.rst b/lib/spack/docs/packaging_guide.rst
index 1d25dda2fd..c989a48f92 100644
--- a/lib/spack/docs/packaging_guide.rst
+++ b/lib/spack/docs/packaging_guide.rst
@@ -4016,8 +4016,11 @@ the package being tested when ``installed`` is ``True``.
The executable runs in ``work_dir``, when specified, using the provided
``options``. The return code is checked against the ``status`` argument,
which can be an integer or list of integers representing status codes
-corresponding to successful execution. Spack also checks that every string
-in ``expected`` is a regex matching part of the output from the test run.
+corresponding to successful execution (e.g. ``status=[0,3,7]``).
+Spack also checks that every string in ``expected`` is a regex matching
+part of the output from the test run (e.g.
+``expected=['completed successfully', 'converged in']``). Default behavior
+is to behave as though ``status=[0]`` and ``expected=[]`` are specified.
Output from the test is written to its log file. The ``purpose`` argument
serves as the heading in text logs to highlight the start of each test part.