Skip to content

Commit 15342f4

Browse files
committed
harmen/google suggestions applied
1 parent 7af58f1 commit 15342f4

2 files changed

Lines changed: 147 additions & 173 deletions

File tree

tutorial_configuration.rst

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,30 @@ A partial list of some key configuration sections is provided below.
2424
* - config
2525
- General settings (install location, number of build jobs, etc)
2626
* - concretizer
27-
- Specializaiton of the concretizer behavior (reuse, unification, etc)
27+
- Specialization of the concretizer behavior (reuse, unification, etc)
2828
* - compilers
2929
- Define the compilers that Spack can use (required and system specific)
3030
* - mirrors
31-
- Locations where spack can look for stashed source or binary distributions
31+
- Locations where Spack can look for stashed source or binary distributions
3232
* - packages
3333
- Specific settings and rules for packages
3434
* - modules
3535
- Naming, location and additional configuration of Spack generated modules
3636

3737
The full list of sections can be viewed with ``spack config list``.
38-
For further education we encourage you to explore the spack `documentation on configuration files <https://spack.readthedocs.io/en/latest/configuration.html#configuration-files>`_.
38+
For more details, we encourage you to explore the Spack `documentation on configuration files <https://spack.readthedocs.io/en/latest/configuration.html#configuration-files>`_.
3939

40-
The principle goals of this section of the tutorial are:
40+
The principal goals of this section of the tutorial are:
4141

4242
1. Introduce the configuration sections and scope hierarchy
4343
2. Demonstrate how to manipulate configurations
44-
3. Show how to configure system assets with spack (compilers and packages)
44+
3. Show how to configure system assets with Spack (compilers and packages)
4545

46-
As such we will primarily focus on the ``compilers`` and ``packages`` configuration sections in this portion of the tutorial.
46+
As such, we will primarily focus on the ``compilers`` and ``packages`` configuration sections in this portion of the tutorial.
4747

4848
We will explain this by first covering how to manipulate configurations from the command line and then show how this impacts the configuration file hierarchy.
4949
We will then move into compiler and package configurations to help you develop skills for getting the builds you want on your system.
50-
Finally, we will give some brief attention to more generalized spack configurations in the ``config`` section.
50+
Finally, we will give some brief attention to more generalized Spack configurations in the ``config`` section.
5151

5252
For all of these features, we will demonstrate how we build up a full configuration file.
5353
For some, we will then demonstrate how the configuration affects the install command, and for others we will use the ``spack spec`` command to demonstrate how the configuration changes have affected Spack's concretization algorithm.
@@ -58,7 +58,7 @@ Configuration from the command line
5858
-----------------------------------
5959

6060
You can run ``spack config blame [section]`` at any point in time to see what your current configuration is.
61-
If you omit the section then spack will dump all the configurations settings to your screen.
61+
If you omit the section, Spack will show all configuration settings.
6262
Let's go ahead and run this for the ``concretizer`` section.
6363

6464
.. code-block:: console
@@ -80,10 +80,10 @@ If we rerun ``spack config blame concretizer`` we can see that the change was ap
8080
8181
$ spack config blame concretizer
8282
83-
Notice that the reference file on for this option is now different.
84-
This indicates the scope where the configuration was set in, and we will discuss how spack chooses the default scope shortly.
83+
Notice that the reference file for this option is now different.
84+
This indicates the scope where the configuration was set, and we will discuss how Spack chooses the default scope shortly.
8585
For now, it is important to note that the ``spack config`` command accepts an optional ``--scope`` flag so we can be more precise in the configuration process.
86-
This will make more sense after the next section which provides the definition of spack's configuration scopes and their hierarchy.
86+
This will make more sense after the next section, which provides the definition of Spack's configuration scopes and their hierarchy.
8787

8888
.. _configs-tutorial-scopes:
8989

@@ -131,14 +131,14 @@ Some facilities manage multiple platforms from a single shared file system.
131131
In order to handle this, each of the configuration scopes listed above has two *sub-scopes*: platform-specific and platform-independent.
132132
For example, compiler settings can be stored in the following locations:
133133

134-
#. ``$ENVIRONMENT_ROOT/spack.yaml``
135-
#. ``~/.spack/<platform>/compilers.yaml``
136-
#. ``~/.spack/compilers.yaml``
137-
#. ``$SPACK_ROOT/etc/spack/<platform>/compilers.yaml``
138-
#. ``$SPACK_ROOT/etc/spack/compilers.yaml``
134+
#. ``$ENVIRONMENT_ROOT/spack.yaml``
135+
#. ``~/.spack/<platform>/compilers.yaml``
136+
#. ``~/.spack/compilers.yaml``
137+
#. ``$SPACK_ROOT/etc/spack/<platform>/compilers.yaml``
138+
#. ``$SPACK_ROOT/etc/spack/compilers.yaml``
139139
#. ``/etc/spack/<platform>/compilers.yaml``
140-
#. ``/etc/spack/compilers.yaml``
141-
#. ``$SPACK_ROOT/etc/defaults/<platform>/compilers.yaml``
140+
#. ``/etc/spack/compilers.yaml``
141+
#. ``$SPACK_ROOT/etc/defaults/<platform>/compilers.yaml``
142142
#. ``$SPACK_ROOT/etc/defaults/compilers.yaml``
143143

144144
These files are listed in decreasing order of precedence, so files in ``~/.spack/<platform>`` will override settings in ``~/.spack``.
@@ -243,8 +243,8 @@ We start with no active environment, so this will open a ``compilers.yaml`` file
243243
paths:
244244
cc: /usr/bin/gcc-10
245245
cxx: /usr/bin/g++-10
246-
f77: usr/bin/gfortran-10
247-
fc: usr/bin/gfortran-10
246+
f77: /usr/bin/gfortran-10
247+
fc: /usr/bin/gfortran-10
248248
flags: {}
249249
operating_system: ubuntu22.04
250250
target: x86_64
@@ -308,7 +308,7 @@ We can verify that our new compiler works by invoking it now:
308308
309309
310310
This new compiler also works on Fortran codes.
311-
We'll show it by compiling a small package using as a build dependency ``cmake%gcc@11.4.0`` since it is already available in our binary cache:
311+
We'll show it by compiling a small package using ``cmake%gcc@11.4.0`` as a build dependency since it is already available in our binary cache:
312312

313313
.. code-block:: console
314314
@@ -793,7 +793,7 @@ If we uninstall and reinstall zlib-ng, we see that it now uses only 2 cores:
793793
794794
Obviously, if you want to build everything in serial for whatever reason, you would set ``build_jobs`` to 1.
795795

796-
Last we'll unset ``concretizer:reuse:false`` since we'll want to enable concretizer reuse for the rest of this tutorial.
796+
Last, we'll unset ``concretizer:reuse:false``, as we'll want to enable concretizer reuse for the rest of this tutorial.
797797

798798
.. code-block:: yaml
799799

0 commit comments

Comments
 (0)