spack/lib/spack/docs
Massimiliano Culpo 32f1aa607c
Add an audit system to Spack (#23053)
Add a new "spack audit" command. This command can check for issues
with configuration or with packages and is intended to help a
user debug a failed Spack build. 

In some cases the reported issues are always errors but are too
costly to check for (e.g. packages that specify missing variants on
dependencies). In other cases the issues may be legitimate but
uncommon usage of Spack and we want to be sure the user intended the
behavior (e.g. duplicate compiler definitions).

Audits are grouped by theme, and for now the two themes are packages
and configuration. For example you can run all available audits
on packages with "spack audit packages". It is intended that in
the future users will be able to define their own audits.

The package audits are good candidates for running in package_sanity
(i.e. they could catch bugs in user-submitted packages before they
are merged) but that is left for a later PR.
2021-06-18 07:52:08 -06:00
..
_gh_pages_redirect Use https for links (#19244) 2020-10-09 11:24:09 -05:00
_static make empty _static directory "exist" to git 2014-01-09 14:03:32 +01:00
build_systems Fix cross references in inteloneapipackage doc (#23744) 2021-05-25 09:57:49 -07:00
example_files Implement an optional compiler bootstrapping phase 2019-09-13 22:57:15 -07:00
images docs: document releases and branches in Spack 2020-07-06 11:39:19 -07:00
_spack_root docs: make docs build relocatable for localized builds 2019-05-26 18:23:44 -07:00
.gitignore tutorial: move tutorial to standalone site (#13450) 2019-10-25 21:49:27 -07:00
analyze.rst Merge pull request #21930 from vsoch/add/spack-monitor 2021-04-15 00:38:36 -07:00
basic_usage.rst Add an audit system to Spack (#23053) 2021-06-18 07:52:08 -06:00
binary_caches.rst extending example for buildcaches (#22504) 2021-06-14 21:46:27 -07:00
build_settings.rst copyrights: update all files with license headers for 2021 2021-01-02 12:12:00 -08:00
build_systems.rst Oneapi packages: update URLs, environment management, and dependencies (#22202) 2021-03-22 17:35:45 -07:00
chain.rst copyrights: update all files with license headers for 2021 2021-01-02 12:12:00 -08:00
command_index.in Rework command reference in docs, add spack commands command 2018-02-12 20:25:17 -08:00
conf.py Update the docs footer copyright (#20741) 2021-01-11 08:00:08 +01:00
config_yaml.rst Make -j flag less exceptional (#22360) 2021-03-30 12:03:50 -07:00
configuration.rst Document cli syntax for environment scopes (#20344) 2021-03-21 10:14:13 +00:00
containers.rst containerize: fix typo in documentation (#22331) 2021-03-16 21:02:26 +00:00
contribution_guide.rst copyrights: update all files with license headers for 2021 2021-01-02 12:12:00 -08:00
developer_guide.rst adding json export for spack blame (#23417) 2021-05-25 12:40:08 -06:00
dockerhub_spack.png spack containerize generates containers from envs (#14202) 2020-01-30 17:19:55 -08:00
environments.rst Docs: fix missing backtick in Environments docs (#24109) 2021-06-07 19:05:09 +02:00
extensions.rst copyrights: update all files with license headers for 2021 2021-01-02 12:12:00 -08:00
features.rst copyrights: update all files with license headers for 2021 2021-01-02 12:12:00 -08:00
getting_started.rst setup-env: allow users to skip module function setup (#24236) 2021-06-11 19:19:24 +00:00
index.rst Merge pull request #21930 from vsoch/add/spack-monitor 2021-04-15 00:38:36 -07:00
known_issues.rst copyrights: update all files with license headers for 2021 2021-01-02 12:12:00 -08:00
Makefile docs: match ReadTheDocs; use -W (warnings as errors) with Sphinx 2019-05-26 18:23:44 -07:00
mirrors.rst Add doc for mirror of env (#22525) 2021-03-24 20:55:15 +00:00
module_file_generation.svg SC17: reworked module file tutorial section (#5657) 2017-11-12 00:27:20 -08:00
module_file_support.rst Separable module configuration -- without the bugs this time (#23703) 2021-05-28 14:12:05 -07:00
monitoring.rst Adding support for spack monitor with containerize (#23777) 2021-06-17 17:15:22 -07:00
package_list.rst copyrights: update all files with license headers for 2021 2021-01-02 12:12:00 -08:00
packaging_guide.rst Stand-alone/Smoke tests: copy cached test sources to test stage (#23713) 2021-05-25 07:24:32 -07:00
pipelines.rst Pipelines: reproducible builds (#22887) 2021-05-28 09:38:07 -07:00
repositories.rst Package Repositories docs: num packages has grown (#20735) 2021-01-11 11:00:14 +01:00
requirements.txt Docs: unlock requirement versions (#13384) 2019-10-31 14:21:05 -05:00
spack.yaml copyrights: update all files with license headers for 2021 2021-01-02 12:12:00 -08:00
workflows.rst copyrights: update all files with license headers for 2021 2021-01-02 12:12:00 -08:00