diff options
Diffstat (limited to 'lib/spack/docs/basic_usage.rst')
| -rw-r--r-- | lib/spack/docs/basic_usage.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/spack/docs/basic_usage.rst b/lib/spack/docs/basic_usage.rst index db69ba42e9..cf1fc28614 100644 --- a/lib/spack/docs/basic_usage.rst +++ b/lib/spack/docs/basic_usage.rst @@ -1730,6 +1730,39 @@ This issue typically manifests with the error below: A nicer error message is TBD in future versions of Spack. +--------------- +Troubleshooting +--------------- + +The ``spack audit`` command: + +.. command-output:: spack audit -h + +can be used to detect a number of configuration issues. This command detects +configuration settings which might not be strictly wrong but are not likely +to be useful outside of special cases. + +It can also be used to detect dependency issues with packages - for example +cases where a package constrains a dependency with a variant that doesn't +exist (in this case Spack could report the problem ahead of time but +automatically performing the check would slow down most runs of Spack). + +A detailed list of the checks currently implemented for each subcommand can be +printed with: + +.. command-output:: spack -v audit list + +Depending on the use case, users might run the appropriate subcommands to obtain +diagnostics. Issues, if found, are reported to stdout: + +.. code-block:: console + + % spack audit packages lammps + PKG-DIRECTIVES: 1 issue found + 1. lammps: wrong variant in "conflicts" directive + the variant 'adios' does not exist + in /home/spack/spack/var/spack/repos/builtin/packages/lammps/package.py + ------------ Getting Help |