diff options
| author | Peter Scheibel <scheibel1@llnl.gov> | 2019-04-18 18:57:10 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-04-18 18:57:10 -0700 |
| commit | 8a23154755fda33525ab0e5ddf82d4f4a637a66c (patch) | |
| tree | dd80ea39c80ced837bcd5dbdbda3549ea93b049a /lib | |
| parent | 9cf650d2abf71ba4a41db0158f1b5090a37e5ead (diff) | |
| download | spack-8a23154755fda33525ab0e5ddf82d4f4a637a66c.tar.gz spack-8a23154755fda33525ab0e5ddf82d4f4a637a66c.tar.bz2 spack-8a23154755fda33525ab0e5ddf82d4f4a637a66c.tar.xz spack-8a23154755fda33525ab0e5ddf82d4f4a637a66c.zip | |
Spack chain docs: config should go in upstreams.yaml (#11225)
#11152 added documentation for #8772 but some details were based on
an earlier implementation that had changed by the time #8772 was
merged. In particular, #11152 mentioned that upstream Spack instances
were configured in config.yaml, when in fact they should be placed in
a separate upstreams.yaml config file; this PR updates the
documentation accordingly.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/spack/docs/chain.rst | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/lib/spack/docs/chain.rst b/lib/spack/docs/chain.rst index c76b53a488..ca6d0d4779 100644 --- a/lib/spack/docs/chain.rst +++ b/lib/spack/docs/chain.rst @@ -11,16 +11,15 @@ Chaining Spack Installations You can point your Spack installation to another installation to use any packages that are installed there. To register the other Spack instance, -you can add it as an entry to ``config.yaml``: +you can add it as an entry to ``upstreams.yaml``: .. code-block:: yaml - config: - upstreams: - spack-instance-1: - install_tree: /path/to/other/spack/opt/spack - spack-instance-2: - install_tree: /path/to/another/spack/opt/spack + upstreams: + spack-instance-1: + install_tree: /path/to/other/spack/opt/spack + spack-instance-2: + install_tree: /path/to/another/spack/opt/spack ``install_tree`` must point to the ``opt/spack`` directory inside of the Spack base directory. @@ -62,7 +61,7 @@ Using Multiple Upstream Spack Instances A single Spack instance can use multiple upstream Spack installations. Spack will search upstream instances in the order you list them in your configuration. If your installation refers to instances X and Y, in that order, -then instance X must list Y as an upstream in its own ``config.yaml``. +then instance X must list Y as an upstream in its own ``upstreams.yaml``. ----------------------------------- Using Modules for Upstream Packages @@ -80,12 +79,11 @@ configuration: .. code-block:: yaml - config: - upstreams: - spack-instance-1: - install_tree: /path/to/other/spack/opt/spack - modules: - tcl: /path/to/other/spack/share/spack/modules + upstreams: + spack-instance-1: + install_tree: /path/to/other/spack/opt/spack + modules: + tcl: /path/to/other/spack/share/spack/modules Each time new packages are installed in the upstream Spack instance, the upstream Spack maintainer should run ``spack module tcl refresh`` (or the |