Skip to content

Commit 4187138

Browse files
Apply suggestions from Adam's review
Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com>
1 parent 4d02c5a commit 4187138

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

tutorial_environments.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ So far in this tutorial, we've covered the basic commands for managing individua
1919
.. Customizing Spack's installation with configuration files, like
2020
`packages.yaml <https://spack.readthedocs.io/en/latest/build_settings.html#build-settings>`_, was also discussed.
2121
22-
Now we'll explore Spack Environments -- a powerful feature that let's us manage collections of packages together in a documented and reproducible way.
22+
Now we'll explore Spack Environments --- a powerful feature that let's us manage collections of packages together in a documented and reproducible way.
2323
Spack environments are similar to *virtual environments* in other package managers (e.g., `Python venv <https://docs.python.org/3/library/venv.html>`_ or `nix-env <https://nix.dev/manual/nix/2.24/command-ref/nix-env>`_).
2424

2525
-------------------------------
@@ -54,7 +54,7 @@ This tutorial will teach you the fundamentals of creating and using Spack enviro
5454
We'll cover:
5555
1. Command line basics -- Creating and managing environments with Spack commands.
5656
2. Configuration files -- Editing ``spack.yaml`` and understanding ``spack.lock``.
57-
3. Environment types -- Understanding Spack-managed vs independent environments.
57+
3. Environment types -- Understanding Spack-managed vs. independent environments.
5858
4. Reproducible builds -- Sharing and recreating environments across systems.
5959

6060
-------------------
@@ -148,7 +148,7 @@ Let's try it:
148148
:language: console
149149

150150
Now, ``tcl`` and ``trilinos`` have been registered as **root specs** in our environment. **Root specs** are packages that we've explicitly requested to be installed in an environment.
151-
They're called **"roots"** because they sit at the top of the dependency graphwhen Spack installs these packages, with their respective dependency packages sitting below them.
151+
They're called **"roots"** because they sit at the top of the dependency graph---when Spack installs these packages, with their respective dependency packages sitting below them.
152152

153153
Now, let's install:
154154

@@ -184,7 +184,7 @@ So, adding specs to an environment at a later point in time will not cause exist
184184

185185
Incrementally creating an environment may give us different package
186186
versions from an environment created all at once.
187-
We'll cover later in the tutorial this after we've discussed different
187+
We'll cover this later in the tutorial after we've discussed different
188188
concretization strategies.
189189

190190
Further, there are two other advantages of concretizing and installing an
@@ -216,7 +216,7 @@ This means that executables, libraries, and other files from your environment's
216216

217217
Let's explore how views work using the ``tcl`` package we just installed in our ``myproject`` environment. The Tcl package includes a shell-like application called ``tclsh``.
218218

219-
To can see the path to ``tclsh`` let's use the ``which`` command:
219+
To see the path to ``tclsh`` let's use the ``which`` command:
220220

221221
.. literalinclude:: outputs/environments/use-tcl-1.out
222222
:language: console
@@ -238,7 +238,7 @@ Removing Packages from Environments
238238
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
239239

240240
One of Spack's key features is that you can safely remove packages from specific environments without affecting other environments.
241-
This works because Spack environments only create links to shared package installationsthey don't contain the actual package files.
241+
This works because Spack environments only create links to shared package installations---they don't contain the actual package files.
242242

243243
Let's demonstrate this capability by creating a second environment.
244244
Imagine we have two projects:
@@ -291,7 +291,7 @@ We can see that ``myproject`` still has ``trilinos`` as a root spec.
291291
The ``spack.yaml`` file
292292
-----------------------
293293

294-
An environment is more than just a list of root specs -- it includes **configuration settings** that control how Spack behaves when the environment it activated.
294+
An environment is more than just a list of root specs --- it includes **configuration settings** that control how Spack behaves when the environment it activated.
295295
So far, ``myproject`` relies on configuration defaults, but these can be overridden to customize our environment's behavior.
296296

297297
In this section, we'll learn how to enforce that all the packages in our environment depending on ``mpi`` build with ``mpich`` by modifying our configuration.
@@ -313,7 +313,7 @@ There are several important parts of this file:
313313
* ``concretizer:unify:`` Determines how package specs in the environment are
314314
concretized together to reduce duplicated dependencies when possible.
315315

316-
The ``specs`` list should look familiar -- these are the package specs we've been modifying previously with ``spack add`` and ``spack install``.
316+
The ``specs`` list should look familiar --- these are the package specs we've been modifying previously with ``spack add`` and ``spack install``.
317317

318318
The ``concretizer:unify:true`` setting controls how Spack resolves dependencies across packages specs in an environment:
319319

@@ -322,7 +322,7 @@ The ``concretizer:unify:true`` setting controls how Spack resolves dependencies
322322
* ``false``: specs are concretized *independently* from each other,
323323
potentially allowing multiple versions of the package to appear in the
324324
environment twice.
325-
* ``when_possible``: A middle ground -- Spack attempts to unify dependencies
325+
* ``when_possible``: A middle ground --- Spack attempts to unify dependencies
326326
as possible but will backoff to allow duplicates when root specs require
327327
incompatible versions of dependencies.
328328

0 commit comments

Comments
 (0)