diff options
author | Vanessasaurus <814322+vsoch@users.noreply.github.com> | 2021-06-14 14:17:35 -0600 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-06-14 13:17:35 -0700 |
commit | 39cdd085c913f1bb7571553f42749f9e30736176 (patch) | |
tree | 049a86f9105bbc2007c823036820c9366e0ca326 /lib | |
parent | 8793d93e8cd74af387ddc80e624670ad6b6c444c (diff) | |
download | spack-39cdd085c913f1bb7571553f42749f9e30736176.tar.gz spack-39cdd085c913f1bb7571553f42749f9e30736176.tar.bz2 spack-39cdd085c913f1bb7571553f42749f9e30736176.tar.xz spack-39cdd085c913f1bb7571553f42749f9e30736176.zip |
adding more description to binary caches (#23934)
It is currently kind of confusing to the reader to distinguish spack buildcache install
and spack install, and it is not clear how to use a build cache once a mirror is added.
Hopefully this little big of description can help (and I hope I got it right!)
Signed-off-by: vsoch <vsoch@users.noreply.github.com>
Co-authored-by: vsoch <vsoch@users.noreply.github.com>
Diffstat (limited to 'lib')
-rw-r--r-- | lib/spack/docs/binary_caches.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/lib/spack/docs/binary_caches.rst b/lib/spack/docs/binary_caches.rst index 17617b1491..2de1f897a4 100644 --- a/lib/spack/docs/binary_caches.rst +++ b/lib/spack/docs/binary_caches.rst @@ -57,6 +57,29 @@ Build caches are installed via: $ spack buildcache install +Note that the above command is intended to install a particular package to a +build cache you have created, and not to install a package from a build cache. +For the latter, once a mirror is added, by default when you do ``spack install`` the ``--use-cache`` +flag is set, and you will install a package from a build cache if it is available. +If you want to always use the cache, you can do: + +.. code-block:: console + + $ spack install --cache-only <package> + +For example, to combine all of the commands above to add the E4S build cache +and then install from it exclusively, you would do: + +.. code-block:: console + + $ spack mirror add E4S https://cache.e4s.io + $ spack buildcache keys --install --trust + $ spack install --cache-only <package> + +We use ``--install`` and ``--trust`` to say that we are installing keys to our +keyring, and trusting all downloaded keys. + + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ List of popular build caches ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |