Skip to content

Commit b19f680

Browse files
authored
tutorial: typos / style (#514)
Signed-off-by: Harmen Stoppels <[email protected]>
1 parent 6c4717e commit b19f680

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

tutorial_configuration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Configuration from the command line
5555
-----------------------------------
5656

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

6161
.. code-block:: console
@@ -248,7 +248,7 @@ We can do this by adding creating a toolchain config:
248248
- spec: '%[email protected]'
249249
when: '%fortran'
250250
251-
We are essentially saying "use Clang for c/c++, and use GCC for Fortran".
251+
We are essentially saying "use Clang for C/C++, and use GCC for Fortran".
252252
You can use this new entry like so:
253253

254254
.. code-block:: spec

tutorial_developer_workflows.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ In this case, it will be the 2.0.0 release that we want to write a patch for:
147147

148148
The ``spack develop`` command marks the package as being a "development" package based on the supplied ``develop spec``.
149149
Develop specs are listed in their own ``develop`` section inside the ``spack.yaml``.
150-
The mechanics of how this section is used to enforce develpoment are as follows:
150+
The mechanics of how this section is used to enforce development are as follows:
151151

152152
1. Specs in the environment that ``satisfy`` the develop specs are selected for development.
153153
2. Any specs selected in step 1 receive a ``dev_path=`` variant.
@@ -156,8 +156,8 @@ The mechanics of how this section is used to enforce develpoment are as follows:
156156
3. Calls to ``spack install`` will now use the source code at ``dev_path`` when building that package.
157157
4. Spack doesn't clean this build up after a successful build so subsequent calls to ``spack install`` trigger incremental builds.
158158

159-
If the environment is already concretized ``spack develop`` performs step 1 and 2 in situ and updates the ``spack.lock`` file by default.
160-
If the environment is not yet concretized the selection of develop specs and assignment of ``dev_path`` are handled during concretization.
159+
If the environment is already concretized, ``spack develop`` performs step 1 and 2 in situ and updates the ``spack.lock`` file by default.
160+
If the environment is not yet concretized, the selection of develop specs and assignment of ``dev_path`` are handled during concretization.
161161

162162
So how does Spack determine the value of the ``dev_path`` variant?
163163
By default, the source code is downloaded into a subdirectory of the environment using Spack's staging functionality.
@@ -235,7 +235,7 @@ So far all of our calls to ``spack develop`` have been on a concretized environm
235235
If we don't want Spack to update the concrete environment's specs we can pass the ``---no-modify-concrete-spec``.
236236
Using ``---no-modify-concrete-spec`` will require you to force concretize an environment to have the develop specs take affect.
237237

238-
There are a limited set of use-cases where one might want to use this option.
238+
There is a limited set of use-cases where one might want to use this option.
239239
Some example cases include:
240240

241241
- Updating a develop spec before updating the environment to change a variant or version

tutorial_environments.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Using Packages
181181
Spack environments provide a convenient way to use your installed packages by automatically making them available in your shell environment.
182182
This is accomplished through a feature called **environment views**.
183183

184-
An environment view is a directory structure mirroring a standard linux root filesystem with directories like ``/bin`` and ``/usr`` that contain symbolic links to all the packages installed in your Spack environment.
184+
An environment view is a directory structure mirroring a standard Linux root filesystem with directories like ``/bin`` and ``/usr`` that contain symbolic links to all the packages installed in your Spack environment.
185185
When you activate an environment with ``spack env activate``, Spack automatically:
186186

187187
* Prepends the view's ``bin`` directory to your ``PATH`` environment variable

tutorial_modules.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Module Files Tutorial
1313
This tutorial illustrates how Spack can be used to generate module files for the software that has been installed.
1414
Both hierarchical and non-hierarchical deployments will be discussed in detail and we will show how to customize the content and naming of each module file.
1515

16-
At the end of the tutorial readers should have a clear understanding of:
16+
At the end of the tutorial, readers will have a clear understanding of:
1717

1818
* What module files are and how they are used on HPC clusters
1919
* How Spack generates module files for the software it installs
@@ -178,7 +178,7 @@ For further details we refer to its `documentation <https://modules.readthedocs.
178178
""""
179179
Lmod
180180
""""
181-
Lmod is a module system written in Lua, originally created at the "Texas Advanced Computing Center" (TACC) by Robert McLay.
181+
Lmod is a module system written in Lua, originally created at the Texas Advanced Computing Center (TACC) by Robert McLay.
182182
You can get it with:
183183

184184
.. code-block:: spec
@@ -210,7 +210,7 @@ Modules vs ``spack load``
210210
^^^^^^^^^^^^^^^^^^^^^^^^^
211211

212212
You may have noticed that we used ``spack load`` in the :ref:`module_file_tutorial_prerequisites` section above.
213-
This is a built-in mechanism of Spack's -- it's designed so that users on a cluster or a laptop can quickly get a package into their path, and it understands Spack's spec syntax.
213+
This is a built-in mechanism of Spack -- it's designed so that users on a cluster or a laptop can quickly get a package into their path, and it understands Spack's spec syntax.
214214
It does *not* require modules, as Spack needs to work regardless of whether modules are set up on the system.
215215

216216
As you might expect, you can see what is loaded via ``spack load`` using ``spack find``:
@@ -411,7 +411,7 @@ If you try to regenerate the module files now you will get an error:
411411
.. note::
412412
We try to check for errors up front!
413413

414-
In Spack we check for errors upfront whenever possible, so don't worry about your module files: as a name clash was detected nothing has been changed on disk.
414+
In Spack we check for errors up front whenever possible, so don't worry about your module files: as a name clash was detected nothing has been changed on disk.
415415

416416
The problem here is that without the hashes the four different flavors of ``netlib-scalapack`` map to the same module file name.
417417
We can change how the names are formatted to differentiate them:
@@ -859,7 +859,7 @@ Extend the default templates
859859
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
860860

861861
Let's assume one of our software is protected by group membership: allowed users belong to the same Linux group, and access is granted at the group level.
862-
Wouldn't it be nice if people that are not yet entitled to use it could receive a helpful message at module load time that tells them who to contact in your organization to be inserted in the group?
862+
Wouldn't it be nice if people who are not yet entitled to use it could receive a helpful message at module load time that tells them who to contact in your organization to be inserted in the group?
863863

864864
To automate the generation of module files with such site-specific behavior we'll start by extending the list of locations where Spack looks for module files.
865865
Let's create the file ``${SPACK_ROOT}/etc/spack/config.yaml`` with the content:

tutorial_packaging.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ Our options for proceeding are:
301301
Reviewing the Build Log
302302
~~~~~~~~~~~~~~~~~~~~~~~
303303

304-
The build log might yield some clues so let's look at the contents of the ``spack-build-out.txt`` file at the path recommended above by our failed installation:
304+
The build log might yield some clues, so let's look at the contents of the ``spack-build-out.txt`` file at the path recommended above by our failed installation:
305305

306306
.. literalinclude:: outputs/packaging/build-output.out
307307
:language: console
@@ -617,7 +617,7 @@ Spack has thousands of built-in packages that can serve as examples to guide the
617617
Multiple Build Systems
618618
----------------------
619619

620-
There are cases where software actively supports two build systems; changes build systems as it evolves; or needs different build systems on different platforms.
620+
There are cases where software actively supports two build systems, changes build systems as it evolves, or needs different build systems on different platforms.
621621
Spack allows you to write a single, concise recipe for these cases that generally require minor changes to the package structure.
622622

623623
Let's take a look at a *simplified* package for ``uncrustify``, which is a source code beautifier.

tutorial_stacks.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ Reusable definitions
181181
So far, we have seen how we can use spec matrices to generate cross-product specs from rows containing a list of constraints.
182182
A common situation you will encounter with large deployments is the necessity to add multiple matrices to the list of specs, that possibly share some of those rows.
183183

184-
To reduce the amount of duplication needed in the manifest file, and thus the maintenance burden for people maintaining it, Spack allows to *define* lists of constraints under the ``definitions`` attribute, and expand them later when needed.
184+
To reduce the amount of duplication needed in the manifest file, and thus the maintenance burden, Spack allows to *define* lists of constraints under the ``definitions`` attribute, and expand them later when needed.
185185
Let's rewrite our manifest accordingly:
186186

187187
.. literalinclude:: outputs/stacks/examples/3.spack.stack.yaml
@@ -220,7 +220,7 @@ Conditional definitions
220220
^^^^^^^^^^^^^^^^^^^^^^^
221221

222222
Spec list definitions can also be conditioned on a ``when`` clause.
223-
The ``when`` clause is a python conditional that is evaluated in a restricted environment.
223+
The ``when`` clause is a Python conditional that is evaluated in a restricted environment.
224224
The variables available in ``when`` clauses are:
225225

226226
================= ===========

0 commit comments

Comments
 (0)