summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorHarmen Stoppels <harmenstoppels@gmail.com>2022-04-20 15:00:43 +0200
committerGitHub <noreply@github.com>2022-04-20 15:00:43 +0200
commitb7f8899d45119f37fafe8733d6ddef5d3efc57b5 (patch)
tree949ea43d2fdc7f8ddba2a2c05d02869bdc67dc23 /lib
parente47ec07ffce285f2d806e38a7cb88c60b7429dfd (diff)
downloadspack-b7f8899d45119f37fafe8733d6ddef5d3efc57b5.tar.gz
spack-b7f8899d45119f37fafe8733d6ddef5d3efc57b5.tar.bz2
spack-b7f8899d45119f37fafe8733d6ddef5d3efc57b5.tar.xz
spack-b7f8899d45119f37fafe8733d6ddef5d3efc57b5.zip
docs: add (config.yaml) to sections for faster lookup by config file (#30157)
Diffstat (limited to 'lib')
-rw-r--r--lib/spack/docs/build_settings.rst6
-rw-r--r--lib/spack/docs/config_yaml.rst6
-rw-r--r--lib/spack/docs/environments.rst6
-rw-r--r--lib/spack/docs/mirrors.rst6
-rw-r--r--lib/spack/docs/module_file_support.rst6
-rw-r--r--lib/spack/docs/repositories.rst6
6 files changed, 18 insertions, 18 deletions
diff --git a/lib/spack/docs/build_settings.rst b/lib/spack/docs/build_settings.rst
index 8de28f8a07..38eb078cbe 100644
--- a/lib/spack/docs/build_settings.rst
+++ b/lib/spack/docs/build_settings.rst
@@ -5,9 +5,9 @@
.. _build-settings:
-===================
-Build Customization
-===================
+================================
+Package Settings (packages.yaml)
+================================
Spack allows you to customize how your software is built through the
``packages.yaml`` file. Using it, you can make Spack prefer particular
diff --git a/lib/spack/docs/config_yaml.rst b/lib/spack/docs/config_yaml.rst
index 6fb673e461..8e47a30c85 100644
--- a/lib/spack/docs/config_yaml.rst
+++ b/lib/spack/docs/config_yaml.rst
@@ -5,9 +5,9 @@
.. _config-yaml:
-==============
-Basic Settings
-==============
+============================
+Spack Settings (config.yaml)
+============================
Spack's basic configuration options are set in ``config.yaml``. You can
see the default settings by looking at
diff --git a/lib/spack/docs/environments.rst b/lib/spack/docs/environments.rst
index b18648006e..65fe49e19a 100644
--- a/lib/spack/docs/environments.rst
+++ b/lib/spack/docs/environments.rst
@@ -5,9 +5,9 @@
.. _environments:
-============
-Environments
-============
+=========================
+Environments (spack.yaml)
+=========================
An environment is used to group together a set of specs for the
purpose of building, rebuilding and deploying in a coherent fashion.
diff --git a/lib/spack/docs/mirrors.rst b/lib/spack/docs/mirrors.rst
index af3394cb63..1070eab3eb 100644
--- a/lib/spack/docs/mirrors.rst
+++ b/lib/spack/docs/mirrors.rst
@@ -5,9 +5,9 @@
.. _mirrors:
-=======
-Mirrors
-=======
+======================
+Mirrors (mirrors.yaml)
+======================
Some sites may not have access to the internet for fetching packages.
These sites will need a local repository of tarballs from which they
diff --git a/lib/spack/docs/module_file_support.rst b/lib/spack/docs/module_file_support.rst
index 5aa57f95bf..45f9f74376 100644
--- a/lib/spack/docs/module_file_support.rst
+++ b/lib/spack/docs/module_file_support.rst
@@ -5,9 +5,9 @@
.. _modules:
-=======
-Modules
-=======
+======================
+Modules (modules.yaml)
+======================
The use of module systems to manage user environment in a controlled way
is a common practice at HPC centers that is often embraced also by
diff --git a/lib/spack/docs/repositories.rst b/lib/spack/docs/repositories.rst
index ff5a4db3fc..3691bdfebb 100644
--- a/lib/spack/docs/repositories.rst
+++ b/lib/spack/docs/repositories.rst
@@ -5,9 +5,9 @@
.. _repositories:
-=============================
-Package Repositories
-=============================
+=================================
+Package Repositories (repos.yaml)
+=================================
Spack comes with thousands of built-in package recipes in
``var/spack/repos/builtin/``. This is a **package repository** -- a