Skip to content

Commit 5eb7e46

Browse files
committed
Spell check docs
1 parent 447e295 commit 5eb7e46

File tree

5 files changed

+48
-48
lines changed

5 files changed

+48
-48
lines changed

lib/spack/docs/basic_usage.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Listing available packages
1313

1414
The first thing you likely want to do with spack is to install some
1515
software. Before that, you need to know what's available. You can
16-
see avaialble package names either using the :ref:`package-list`, or
16+
see available package names either using the :ref:`package-list`, or
1717
using the commands below.
1818

1919
.. _spack-list:
@@ -27,7 +27,7 @@ Spack can install:
2727
.. command-output:: spack list
2828

2929
The packages are listed by name in alphabetical order. You can also
30-
do wildcard searches using ``*``:
30+
do wildcats searches using ``*``:
3131

3232
.. command-output:: spack list m*
3333

@@ -64,14 +64,14 @@ There are two sections in the output. *Safe versions* are ones that
6464
have already been checksummed. Spack goes a step further, though, and
6565
also shows you what versions are available out on the web---these are
6666
*remote versions*. Spack gets this information by scraping it
67-
directly from webpages. Depending on the package, Spack may or may
67+
directly from web pages. Depending on the package, Spack may or may
6868
not be able to find any remote versions.
6969

7070

7171
Installing and uninstalling
7272
------------------------------
7373

74-
Now that you know how to list avaiable packages and versions, you're
74+
Now that you know how to list available packages and versions, you're
7575
ready to start installing things.
7676

7777
.. _spack-install:
@@ -80,7 +80,7 @@ ready to start installing things.
8080
~~~~~~~~~~~~~~~~~~~~~
8181

8282
``spack install`` will install any package shown by ``spack list``.
83-
To install the latest version of a pacakge, along with all of its
83+
To install the latest version of a package, along with all of its
8484
dependencies, simply give it a package name:
8585

8686
.. code-block:: sh
@@ -227,7 +227,7 @@ Packages are divided into groups according to their architecture and
227227
compiler. Within each group, Spack tries to keep the view simple, and
228228
only shows the version of installed packages.
229229

230-
In some cases, there may be differnt configurations of the *same*
230+
In some cases, there may be different configurations of the *same*
231231
version of a package installed. For example, there are two
232232
installations of of ``libdwarf@20130729`` above. We can look at them
233233
in more detail using ``spack find -d``, and by asking only to show
@@ -362,7 +362,7 @@ where the compiler is installed. For example::
362362
intel@13.0.079
363363

364364
Or you can run ``spack compiler add`` with no arguments to force
365-
autodetection. This is useful if you do not know where compilers are
365+
auto-detection. This is useful if you do not know where compilers are
366366
installed, but you know that new compilers have been added to your
367367
``PATH``. For example, using dotkit, you might do this::
368368

@@ -398,7 +398,7 @@ matching Intel compiler was displayed.
398398
Manual compiler configuration
399399
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
400400

401-
If autodetection fails, you can manually conigure a compiler by
401+
If auto-detection fails, you can manually configure a compiler by
402402
editing your ``~/.spackconfig`` file. You can do this by running
403403
``spack config edit``, which will open the file in your ``$EDITOR``.
404404

@@ -1021,7 +1021,7 @@ You can find extensions for your Python installation like this:
10211021
==> None activated.
10221022
10231023
The extensions are a subset of what's returned by ``spack list``, and
1024-
they are packages like any ohter. They are installed into their own
1024+
they are packages like any other. They are installed into their own
10251025
prefixes, and you can see this with ``spack find -p``:
10261026

10271027
.. code-block:: sh
@@ -1098,7 +1098,7 @@ Several things have happened here. The user requested that
10981098
``py-numpy`` be activated in the ``python`` installation it was built
10991099
with. Spack knows that ``py-numpy`` depends on ``py-nose`` and
11001100
``py-setuptools``, so it activated those packages first. Finally,
1101-
once all dpeendencies were activated in the ``python`` installation,
1101+
once all dependencies were activated in the ``python`` installation,
11021102
``py-numpy`` was activated as well.
11031103

11041104
If we run ``spack extensions`` again, we now see the three new
@@ -1130,7 +1130,7 @@ packages listed as activated:
11301130
py-nose@1.3.4 py-numpy@1.9.1 py-setuptools@11.3.1
11311131
11321132
1133-
Now, when a user runs python, ``numpy`` will be avaiable for import
1133+
Now, when a user runs python, ``numpy`` will be available for import
11341134
*without* the user having to explicitly loaded. ``python@2.7.8`` now
11351135
acts like a system Python installation with ``numpy`` installed inside
11361136
of it.

lib/spack/docs/developer_guide.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ as a descriptor for one or more instances of that template. Users
5050
express the configuration they want using a spec, and a package turns
5151
the spec into a complete build.
5252

53-
The obvious difficulty with this design is that users underspecify
53+
The obvious difficulty with this design is that users under-specify
5454
what they want. To build a software package, the package object needs
5555
a *complete* specification. In Spack, if a spec describes only one
5656
instance of a package, then we say it is **concrete**. If a spec
57-
could describes many instances, (i.e. it is underspecified in one way
57+
could describes many instances, (i.e. it is under-specified in one way
5858
or another), then we say it is **abstract**.
5959

6060
Spack's job is to take an *abstract* spec from the user, find a
@@ -92,7 +92,7 @@ with a high level view of Spack's directory structure::
9292
Spack is designed so that it could live within a `standard UNIX
9393
directory hierarchy <http://linux.die.net/man/7/hier>`_, so ``lib``,
9494
``var``, and ``opt`` all contain a ``spack`` subdirectory in case
95-
Spack is installed alongside other software. Most of the insteresting
95+
Spack is installed alongside other software. Most of the interesting
9696
parts of Spack live in ``lib/spack``. Files under ``var`` are created
9797
as needed, so there is no ``var`` directory when you initially clone
9898
Spack from the repository.
@@ -123,13 +123,13 @@ Package-related modules
123123
Contains the :class:`Package <spack.package.Package>` class, which
124124
is the superclass for all packages in Spack. Methods on ``Package``
125125
implement all phases of the :ref:`package lifecycle
126-
<pacakge-lifecycle>` and manage the build process.
126+
<package-lifecycle>` and manage the build process.
127127

128128
:mod:`spack.packages`
129129
Contains all of the packages in Spack and methods for managing them.
130130
Functions like :func:`packages.get <spack.packages.get>` and
131131
:func:`class_name_for_package_name
132-
<packages.class_name_for_package_name>` handle mapping packge module
132+
<packages.class_name_for_package_name>` handle mapping package module
133133
names to class names and dynamically instantiating packages by name
134134
from module files.
135135

lib/spack/docs/mirrors.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ contains tarballs for each package, named after each package.
4747
In order to make mirror creation reasonably fast, we copy the
4848
tarball in its original format to the mirror directory, but we do
4949
not standardize on a particular compression algorithm, because this
50-
would potentially require expanding and recompressing each archive.
50+
would potentially require expanding and re-compressing each archive.
5151

5252
.. _spack-mirror:
5353

@@ -161,7 +161,7 @@ your site.
161161
``spack mirror add``
162162
----------------------------
163163

164-
Once you have a mirrror, you need to let spack know about it. This is
164+
Once you have a mirror, you need to let spack know about it. This is
165165
relatively simple. First, figure out the URL for the mirror. If it's
166166
a file, you can use a file URL like this one::
167167

lib/spack/docs/packaging_guide.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Packaging Guide
55

66
This guide is intended for developers or administrators who want to
77
package software so that Spack can install it. It assumes that you
8-
have at least some familiarty with Python, and that you've read the
8+
have at least some familiarity with Python, and that you've read the
99
:ref:`basic usage guide <basic-usage>`, especially the part about
1010
:ref:`specs <sec-specs>`.
1111

@@ -459,7 +459,7 @@ example for ``libelf``:
459459
How many would you like to checksum? (default is 5, q to abort)
460460
461461
This does the same thing that ``spack create`` does, but it allows you
462-
to go back and add new vesrions easily as you need them (e.g., as
462+
to go back and add new versions easily as you need them (e.g., as
463463
they're released). It fetches the tarballs you ask for and prints out
464464
a list of ``version`` commands ready to copy/paste into your package
465465
file:
@@ -479,7 +479,7 @@ in ``http://example.com/downloads/`` for links to additional versions.
479479
If you need to search another path for download links, you can supply
480480
some extra attributes that control how your package finds new
481481
versions. See the documentation on `attribute_list_url`_ and
482-
`attributee_list_depth`_.
482+
`attribute_list_depth`_.
483483

484484
.. note::
485485

@@ -490,7 +490,7 @@ versions. See the documentation on `attribute_list_url`_ and
490490
manually add ``version`` calls yourself.
491491

492492
* For ``spack checksum`` to work, Spack needs to be able to
493-
``import`` your pacakge in Python. That means it can't have any
493+
``import`` your package in Python. That means it can't have any
494494
syntax errors, or the ``import`` will fail. Use this once you've
495495
got your package in working order.
496496

@@ -643,7 +643,7 @@ Revisions
643643
revisions, you can use ``revision`` for branches, tags, and commits
644644
when you fetch with Mercurial.
645645

646-
As wtih git, you can fetch these versions using the ``spack install
646+
As with git, you can fetch these versions using the ``spack install
647647
example@<version>`` command-line syntax.
648648

649649
.. _svn-fetch:
@@ -927,7 +927,7 @@ the ``list_url``, because that is where links to old versions are:
927927
~~~~~~~~~~~~~~~~~~~~~
928928

929929
``libdwarf`` and many other packages have a listing of available
930-
verisons on a single webpage, but not all do. For example, ``mpich``
930+
versions on a single webpage, but not all do. For example, ``mpich``
931931
has a tarball URL that looks like this:
932932

933933
url = "http://www.mpich.org/static/downloads/3.0.4/mpich-3.0.4.tar.gz"
@@ -1095,7 +1095,7 @@ called before the ``install()`` method of any dependent packages.
10951095
This allows dependencies to set up environment variables and other
10961096
properties to be used by dependents.
10971097

1098-
The funciton declaration should look like this:
1098+
The function declaration should look like this:
10991099

11001100
.. code-block:: python
11011101
@@ -1115,7 +1115,7 @@ The arguments to this function are:
11151115
* **spec**: the spec of the *dependency package* (the one the function is called on).
11161116
* **dep_spec**: the spec of the dependent package (i.e. dep_spec depends on spec).
11171117

1118-
A goo example of using these is in the Python packge:
1118+
A good example of using these is in the Python package:
11191119

11201120
.. code-block:: python
11211121
@@ -1148,7 +1148,7 @@ packages to have a very simple install method, like this:
11481148
def install(self, spec, prefix):
11491149
python('setup.py', 'install', '--prefix=%s' % prefix)
11501150
1151-
Python's ``setup_dependent_environment`` method also sets up smoe
1151+
Python's ``setup_dependent_environment`` method also sets up some
11521152
other variables, creates a directory, and sets up the ``PYTHONPATH``
11531153
so that dependent packages can find their dependencies at build time.
11541154

@@ -1217,7 +1217,7 @@ Activation & deactivation
12171217
Spack's ``Package`` class has default ``activate`` and ``deactivate``
12181218
implementations that handle symbolically linking extensions' prefixes
12191219
into the directory of the parent package. However, extendable
1220-
packages can override these methdos to add custom activate/deactivate
1220+
packages can override these methods to add custom activate/deactivate
12211221
logic of their own. For example, the ``activate`` and ``deactivate``
12221222
methods in the Python class use the symbolic linking, but they also
12231223
handle details surrounding Python's ``.pth`` files, and other aspects
@@ -1286,7 +1286,7 @@ Virtual dependencies
12861286
-----------------------------
12871287

12881288
In some cases, more than one package can satisfy another package's
1289-
dependency. One way this can happen is if a pacakge depends on a
1289+
dependency. One way this can happen is if a package depends on a
12901290
particular *interface*, but there are multiple *implementations* of
12911291
the interface, and the package could be built with any of them. A
12921292
*very* common interface in HPC is the `Message Passing Interface (MPI)
@@ -1299,7 +1299,7 @@ MPI has several different implementations (e.g., `MPICH
12991299
applications can be built with any one of them. Complicating matters,
13001300
MPI does not have a standardized ABI, so a package built with one
13011301
implementation cannot simply be relinked with another implementation.
1302-
Many pacakage managers handle interfaces like this by requiring many
1302+
Many package managers handle interfaces like this by requiring many
13031303
similar package files, e.g., ``foo``, ``foo-mvapich``, ``foo-mpich``,
13041304
but Spack avoids this explosion of package files by providing support
13051305
for *virtual dependencies*.
@@ -1325,7 +1325,7 @@ supplying a ``depends_on`` call in the package definition. For example:
13251325
depends_on("adept-utils")
13261326
depends_on("callpath")
13271327
1328-
Here, ``callpath`` and ``adept-utils`` are concrete pacakges, but
1328+
Here, ``callpath`` and ``adept-utils`` are concrete packages, but
13291329
there is no actual package file for ``mpi``, so we say it is a
13301330
*virtual* package. The syntax of ``depends_on``, is the same for
13311331
both. If we look inside the package file of an MPI implementation,
@@ -1349,7 +1349,7 @@ to ``provides`` to add constraints. This allows Spack to support the
13491349
notion of *versioned interfaces*. The MPI standard has gone through
13501350
many revisions, each with new functions added, and each revision of
13511351
the standard has a version number. Some packages may require a recent
1352-
implementation that supports MPI-3 fuctions, but some MPI versions may
1352+
implementation that supports MPI-3 functions, but some MPI versions may
13531353
only provide up to MPI-2. Others may need MPI 2.1 or higher. You can
13541354
indicate this by adding a version constraint to the spec passed to
13551355
``provides``:
@@ -1381,7 +1381,7 @@ constraints on the *providing* package, or the *provider*. The
13811381
provider only provides the declared virtual spec when *it* matches
13821382
the constraints in the when clause. Here, when ``mpich`` is at
13831383
version 3 or higher, it provides MPI up to version 3. When ``mpich``
1384-
is at version 1 or higher, it provides the MPI virtual pacakge at
1384+
is at version 1 or higher, it provides the MPI virtual package at
13851385
version 1.
13861386

13871387
The ``when`` qualifier ensures that Spack selects a suitably high
@@ -1544,7 +1544,7 @@ software should be installed.
15441544

15451545
Spack provides wrapper functions for ``configure`` and ``make`` so
15461546
that you can call them in a similar way to how you'd call a shell
1547-
comamnd. In reality, these are Python functions. Spack provides
1547+
command. In reality, these are Python functions. Spack provides
15481548
these functions to make writing packages more natural. See the section
15491549
on :ref:`shell wrappers <shell-wrappers>`.
15501550

@@ -1603,7 +1603,7 @@ The install environment
16031603
--------------------------
16041604

16051605
In general, you should not have to do much differently in your install
1606-
method than you would when installing a pacakge on the command line.
1606+
method than you would when installing a package on the command line.
16071607
In fact, you may need to do *less* than you would on the command line.
16081608

16091609
Spack tries to set environment variables and modify compiler calls so
@@ -1626,7 +1626,7 @@ purposes:
16261626
#. Make build systems use Spack's compiler wrappers for their builds.
16271627
#. Allow build systems to find dependencies more easily
16281628

1629-
The Compiler enviroment variables that Spack sets are:
1629+
The Compiler environment variables that Spack sets are:
16301630

16311631
============ ===============================
16321632
Variable Purpose
@@ -1656,7 +1656,7 @@ entering ``install()`` so that packages can locate dependencies
16561656
easily:
16571657

16581658
======================= =============================
1659-
``PATH`` Set to point to ``/bin`` directories of dpeendencies
1659+
``PATH`` Set to point to ``/bin`` directories of dependencies
16601660
``CMAKE_PREFIX_PATH`` Path to dependency prefixes for CMake
16611661
``PKG_CONFIG_PATH`` Path to any pkgconfig directories for dependencies
16621662
``PYTHONPATH`` Path to site-packages dir of any python dependencies
@@ -1742,7 +1742,7 @@ the command line.
17421742
Forking ``install()``
17431743
~~~~~~~~~~~~~~~~~~~~~
17441744

1745-
To give packagers free reign over their install environemnt, Spack
1745+
To give packagers free reign over their install environment, Spack
17461746
forks a new process each time it invokes a package's ``install()``
17471747
method. This allows packages to have their own completely sandboxed
17481748
build environment, without impacting other jobs that the main Spack
@@ -1870,7 +1870,7 @@ dependency version.
18701870

18711871
You can use ``satisfies()`` to test for particular dependencies,
18721872
e.g. ``foo.satisfies('^openmpi@1.2')`` or ``foo.satisfies('^mpich')``,
1873-
or you can use Python's builtin ``in`` operator:
1873+
or you can use Python's built-in ``in`` operator:
18741874

18751875
.. code-block:: python
18761876
@@ -1899,7 +1899,7 @@ Accessing Dependencies
18991899
~~~~~~~~~~~~~~~~~~~~~~~~~~
19001900

19011901
You may need to get at some file or binary that's in the prefix of one
1902-
of your dependencies. You can do that by subscripting the spec:
1902+
of your dependencies. You can do that by sub-scripting the spec:
19031903

19041904
.. code-block:: python
19051905
@@ -2219,7 +2219,7 @@ File functions
22192219
Create an empty file at ``path``.
22202220
22212221
2222-
.. _pacakge-lifecycle:
2222+
.. _package-lifecycle:
22232223
22242224
Packaging workflow commands
22252225
---------------------------------
@@ -2248,7 +2248,7 @@ A typical package workflow might look like this:
22482248
... repeat clean/install until install works ...
22492249
22502250
Below are some commands that will allow you some finer-grained
2251-
controll over the install process.
2251+
control over the install process.
22522252
22532253
.. _spack-fetch:
22542254
@@ -2325,7 +2325,7 @@ Keeping the stage directory on success
23252325
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23262326
23272327
By default, ``spack install`` will delete the staging area once a
2328-
pacakge has been successfully built and installed. Use
2328+
package has been successfully built and installed. Use
23292329
``--keep-stage`` to leave the build directory intact:
23302330
23312331
.. code-block:: sh
@@ -2474,7 +2474,7 @@ build it:
24742474
/Users/gamblin2/src/spack/var/spack/stage/libelf@0.8.13%gcc@4.8.3=linux-ppc64/libelf-0.8.13
24752475
24762476
``spack cd`` here changed he current working directory to the
2477-
directory containing theexpanded ``libelf`` source code. There are a
2477+
directory containing the expanded ``libelf`` source code. There are a
24782478
number of other places you can cd to in the spack directory hierarchy:
24792479
24802480
.. command-output:: spack cd -h

0 commit comments

Comments
 (0)