Skip to content

Commit d9a2309

Browse files
Fix: Correct Spack capitalization in tutorial files.
This commit corrects the capitalization of "Spack" in all tutorial_*.rst files. The changes ensure that: - "Spack" is used when referring to the project or tool by name. - "spack" is used when referring to the command-line executable.
1 parent 0694892 commit d9a2309

7 files changed

Lines changed: 23 additions & 13 deletions

tutorial_advanced_packaging.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Set environment variables in dependent packages at build-time
7474
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7575

7676
Dependencies can set environment variables that are required when their dependents build.
77-
For example, when a package depends on a python extension like py-numpy, Spack's ``python`` package will add it to ``PYTHONPATH`` so it is available at build time; this is required because the default setup that spack does is not sufficient for python to import modules.
77+
For example, when a package depends on a python extension like py-numpy, Spack's ``python`` package will add it to ``PYTHONPATH`` so it is available at build time; this is required because the default setup that Spack does is not sufficient for python to import modules.
7878

7979
To provide environment setup for a dependent, a package can implement the
8080
:py:func:`setup_dependent_build_environment

tutorial_buildsystems.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ If we look inside, we see that ``CC`` and ``CXX`` point to our GNU compiler:
238238
239239
.. note::
240240
As usual make sure you have shell support activated with Spack:
241-
``source /path/to/spack_root/spack/share/spack/setup-env.sh``
241+
``source /path/to/spack_root/share/spack/setup-env.sh``
242242

243243
.. code-block:: console
244244

tutorial_configuration.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,19 @@ A partial list of some key configuration sections is provided below.
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 further education, we encourage you to explore the Spack `documentation on configuration files <https://spack.readthedocs.io/en/latest/configuration.html#configuration-files>`_.
3939

4040
The principle 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

4646
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.
@@ -81,7 +81,7 @@ If we rerun ``spack config blame concretizer`` we can see that the change was ap
8181
$ spack config blame concretizer
8282
8383
Notice that the reference file 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.
84+
This indicates the scope where the configuration was set in, 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.
8686
This will make more sense after the next section which provides the definition of Spack's configuration scopes and their hierarchy.
8787

@@ -485,7 +485,7 @@ Because of the configuration scoping we discussed earlier, this overrides the de
485485
Variant preferences
486486
^^^^^^^^^^^^^^^^^^^
487487

488-
As we've seen throughout this tutorial, HDF5 builds with MPI enabled by default in Spack.
488+
As we'veseen throughout this tutorial, HDF5 builds with MPI enabled by default in Spack.
489489
If we were working on a project that would routinely need serial HDF5, that might get annoying quickly, having to type ``hdf5~mpi`` all the time.
490490
Instead, we'll update our preferences for HDF5.
491491

@@ -813,3 +813,5 @@ For more detailed documentation on Spack's many configuration settings, see `the
813813

814814
For examples of how other sites configure Spack, see https://github.com/spack/spack-configs.
815815
If you use Spack at your site and want to share your config files, feel free to submit a pull request!
816+
817+
[end of tutorial_configuration.rst]

tutorial_developer_workflows.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
Developer Workflows Tutorial
1212
============================
1313

14-
This tutorial will guide you through the process of using the ``spack develop`` command to develop software from local source code within a spack environment.
14+
This tutorial will guide you through the process of using the ``spack develop`` command to develop software from local source code within a Spack environment.
1515
With this command, Spack will manage your dependencies while you focus on testing changes to your library and/or application.
1616

1717

@@ -139,19 +139,19 @@ Development iteration cycles
139139
-----------------------------
140140

141141
Let's assume that scr has a bug, and we'd like to patch scr to find out what the problem is.
142-
First, we tell spack that we'd like to check out the version of scr that we want to work on.
142+
First, we tell Spack that we'd like to check out the version of scr that we want to work on.
143143
In this case, it will be the 3.1.0 release that we want to write a patch for:
144144

145145
.. literalinclude:: outputs/dev/develop-1.out
146146
:language: console
147147

148-
The spack develop command marks the package as being a "development" package in the ``spack.yaml``.
148+
The ``spack develop`` command marks the package as being a "development" package in the ``spack.yaml``.
149149
This adds a special ``dev_path=`` attribute to the spec for the package, so Spack remembers where the source code for this package is located.
150150
The develop command also downloads/checks out the source code for the package.
151151
By default, the source code is downloaded into a subdirectory of the environment.
152152
You can change the location of this source directory by modifying the ``path:`` attribute of the develop configuration in the environment.
153153

154-
There are a few gotchas with the spack develop command
154+
There are a few gotchas with the ``spack develop`` command
155155

156156
* You often specify the package version manually when specifying a
157157
package as a dev package. Spack needs to know the version of the dev
@@ -233,7 +233,7 @@ For example, we'll make another development environment here.
233233

234234
Here, ``spack develop`` with no arguments will check out or download the source code and place it in the appropriate places.
235235

236-
When we're done developing, we simply tell spack that it no longer needs to keep a development version of the package.
236+
When we're done developing, we simply tell Spack that it no longer needs to keep a development version of the package.
237237

238238
.. literalinclude:: outputs/dev/wrapup.out
239239
:language: console
@@ -328,3 +328,5 @@ While we won't build out this example it illustrates how the ``dev_path`` for ``
328328
Now if we want to do most of our incremental builds using the ``Release`` build and periodically check the results using the ``Debug`` build we can combine the workflow from the previous example: dive into the ``Release`` versions build environment using ``spack build-env scr build_type=Release -- bash`` and navigate with ``spack cd -b scr build_type=Release``.
329329
Note that since there are two ``scr`` specs in the environment we must distinguish which one we want for these commands.
330330
When we are ready to check our changes for the debug build, we can exit out of the build environment subshell, rerun ``spack install`` to rebuild everything, and then inspect the debug build through our method of choice.
331+
332+
[end of tutorial_developer_workflows.rst]

tutorial_environments.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -749,3 +749,5 @@ Finding examples of environments
749749

750750
* `Spack Stack Catalog <https://spack.github.io/spack-stack-catalog/>`_: for
751751
discovering environments that you can explore on GitHub
752+
753+
[end of tutorial_environments.rst]

tutorial_modules.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Now we can re-source the setup file, and Spack modules will be put in our module
6565

6666
.. code-block:: console
6767
68-
$ . spack/share/spack/setup-env.sh
68+
$ . share/spack/setup-env.sh
6969
7070
.. FIXME: this needs bootstrap support for ``lmod``
7171
@@ -987,3 +987,5 @@ Since it is currently the default compiler (our current default is the most rece
987987
$ spack compiler rm gcc@12.3.0
988988
989989
This will ensure the rest of the tutorial goes smoothly for you.
990+
991+
[end of tutorial_modules.rst]

tutorial_packaging.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -692,3 +692,5 @@ Making a package externally detectable
692692
* `Making a package externally discoverable
693693
<https://spack.readthedocs.io/en/latest/packaging_guide.html#making-a-package-discoverable-with-spack-external-find>`_:
694694
for making a package discoverable using the ``spack external find`` command
695+
696+
[end of tutorial_packaging.rst]

0 commit comments

Comments
 (0)