hlrs-software-stack/spack
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Spack chain docs: config should go in upstreams.yaml (#11225)

Browse source 
#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.
This commit is contained in:
Peter Scheibel 2019-04-18 18:57:10 -07:00 committed by GitHub
parent 9cf650d2ab
commit 8a23154755
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
lib/spack/docs/chain.rst
View file

@ -11,16 +11,15 @@ Chaining Spack Installations
You can point your Spack installation to another installation to use any You can point your Spack installation to another installation to use any
packages that are installed there. To register the other Spack instance, 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 .. code-block:: yaml
config: upstreams:
upstreams: spack-instance-1:
spack-instance-1: install_tree: /path/to/other/spack/opt/spack
install_tree: /path/to/other/spack/opt/spack spack-instance-2:
spack-instance-2: install_tree: /path/to/another/spack/opt/spack
install_tree: /path/to/another/spack/opt/spack
``install_tree`` must point to the ``opt/spack`` directory inside of the ``install_tree`` must point to the ``opt/spack`` directory inside of the
Spack base directory. Spack base directory.
@ -62,7 +61,7 @@ Using Multiple Upstream Spack Instances
A single Spack instance can use multiple upstream Spack installations. Spack A single Spack instance can use multiple upstream Spack installations. Spack
will search upstream instances in the order you list them in your 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, 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 Using Modules for Upstream Packages
@ -80,12 +79,11 @@ configuration:
.. code-block:: yaml .. code-block:: yaml
config: upstreams:
upstreams: spack-instance-1:
spack-instance-1: install_tree: /path/to/other/spack/opt/spack
install_tree: /path/to/other/spack/opt/spack modules:
modules: tcl: /path/to/other/spack/share/spack/modules
tcl: /path/to/other/spack/share/spack/modules
Each time new packages are installed in the upstream Spack instance, the Each time new packages are installed in the upstream Spack instance, the
upstream Spack maintainer should run ``spack module tcl refresh`` (or the upstream Spack maintainer should run ``spack module tcl refresh`` (or the