spack/lib/spack/docs
Massimiliano Culpo 9ddc98e46a Separate setting build environment and run environment in packages (#11115)
* Methods setting the environment now do it separately for build and run

Before this commit the `*_environment` methods were setting
modifications to both the build-time and run-time environment
simultaneously. This might cause issues as the two environments
inherently rely on different preconditions:

1. The build-time environment is set before building a package, thus
the package prefix doesn't exist and can't be inspected

2. The run-time environment instead is set assuming the target package
has been already installed

Here we split each of these functions into two: one setting the
build-time environment, one the run-time.

We also adopt a fallback strategy that inspects for old methods and
executes them as before, but prints a deprecation warning to tty. This
permits to port packages to use the new methods in a distributed way,
rather than having to modify all the packages at once.

* Added a test that fails if any package uses the old API

Marked the test xfail for now as we have a lot of packages in that
state.

* Added a test to check that a package modified by a PR is up to date

This test can be used any time we deprecate a method call to ensure
that during the first modification of the package we update also
the deprecated calls.

* Updated documentation
2019-10-17 10:17:21 -07:00
..
_gh_pages_redirect Make gh-pages redirect to readthedocs.io 2016-08-31 19:40:22 -07:00
_static
build_systems Fix PyQt installation (#12479) 2019-09-08 10:48:50 -05:00
example_files Implement an optional compiler bootstrapping phase 2019-09-13 22:57:15 -07:00
tutorial Update Package Creation Tutorial for PEARC19 (#12209) 2019-07-31 12:54:09 -05:00
_spack_root docs: make docs build relocatable for localized builds 2019-05-26 18:23:44 -07:00
.gitignore Speed up doc builds with spack list --format=html (#6945) 2018-01-16 00:12:11 -08:00
basic_usage.rst Feature: installed file verification (#12841) 2019-10-15 14:24:52 -07:00
binary_caches.rst copyright: update license headers for 2013-2019 copyright. 2019-01-01 00:44:28 -08:00
build_settings.rst bugfix: use string keys to set preferred targets (#12921) 2019-09-24 10:18:48 +02:00
build_systems.rst Add SIPPackage base class (#12157) 2019-07-30 17:12:48 -05:00
chain.rst Spack chain docs: config should go in upstreams.yaml (#11225) 2019-04-18 18:57:10 -07:00
command_index.in Rework command reference in docs, add spack commands command 2018-02-12 20:25:17 -08:00
conf.py Fix Sphinx deprecation warning when building docs (#12205) 2019-07-31 10:23:56 +02:00
config_yaml.rst Bugfix: stage directory permissions and cleaning (#12733) 2019-10-16 14:55:37 -07:00
configuration.rst Remove support for generating dotkit files (#11986) 2019-10-02 22:15:01 -07:00
contribution_guide.rst copyright: update license headers for 2013-2019 copyright. 2019-01-01 00:44:28 -08:00
developer_guide.rst docs: Use HDF5 as the example package for spack graph 2019-05-26 18:23:44 -07:00
docker_for_developers.rst copyright: update license headers for 2013-2019 copyright. 2019-01-01 00:44:28 -08:00
environments.rst Spack environments can concretize specs together (#11372) 2019-10-07 09:53:23 -07:00
extensions.rst Command extensions can import code from modules in root or cmd folder (#11209) 2019-05-16 17:27:42 -07:00
features.rst doc: fix #12245 non-functional libdwarf dependency (#12515) 2019-10-05 21:07:18 -05:00
getting_started.rst Update compilers.yaml location in Getting Started docs (#13029) 2019-10-03 10:31:32 -05:00
index.rst docs: initial documentation for environments 2019-07-18 19:28:50 -07:00
known_issues.rst copyright: update license headers for 2013-2019 copyright. 2019-01-01 00:44:28 -08:00
Makefile docs: match ReadTheDocs; use -W (warnings as errors) with Sphinx 2019-05-26 18:23:44 -07:00
mirrors.rst copyright: update license headers for 2013-2019 copyright. 2019-01-01 00:44:28 -08:00
module_file_generation.svg SC17: reworked module file tutorial section (#5657) 2017-11-12 00:27:20 -08:00
module_file_support.rst Separate setting build environment and run environment in packages (#11115) 2019-10-17 10:17:21 -07:00
package_list.rst copyright: update license headers for 2013-2019 copyright. 2019-01-01 00:44:28 -08:00
packaging_guide.rst Separate setting build environment and run environment in packages (#11115) 2019-10-17 10:17:21 -07:00
repositories.rst copyright: update license headers for 2013-2019 copyright. 2019-01-01 00:44:28 -08:00
requirements.txt docs: set gettext_uuid to False to reduce churn (#11567) 2019-05-27 13:42:27 -07:00
tutorial_advanced_packaging.rst Separate setting build environment and run environment in packages (#11115) 2019-10-17 10:17:21 -07:00
tutorial_basics.rst tutorial basics section: fix gcc install version (#10298) 2019-01-09 17:37:37 -06:00
tutorial_buildsystems.rst docs: make docs build relocatable for localized builds 2019-05-26 18:23:44 -07:00
tutorial_configuration.rst Bugfix: stage directory permissions and cleaning (#12733) 2019-10-16 14:55:37 -07:00
tutorial_environments.rst should not need bin prefix on spack command (#12215) 2019-07-31 12:58:01 -05:00
tutorial_modules.rst docs: make docs build relocatable for localized builds 2019-05-26 18:23:44 -07:00
tutorial_packaging.rst Update Package Creation Tutorial for PEARC19 (#12209) 2019-07-31 12:54:09 -05:00
tutorial.rst docs: update tutorial slides for PEARC19 2019-07-31 12:55:59 -05:00
workflows.rst Features: Improve Spec format strings (#10556) 2019-04-17 18:21:40 -07:00