@@ -5,7 +5,7 @@ Packaging Guide
55
66This guide is intended for developers or administrators who want to
77package 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
463463they're released). It fetches the tarballs you ask for and prints out
464464a list of ``version `` commands ready to copy/paste into your package
465465file:
@@ -479,7 +479,7 @@ in ``http://example.com/downloads/`` for links to additional versions.
479479If you need to search another path for download links, you can supply
480480some extra attributes that control how your package finds new
481481versions. 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
647647example@<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 ``
931931has 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.
10951095This allows dependencies to set up environment variables and other
10961096properties 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
11521152other variables, creates a directory, and sets up the ``PYTHONPATH ``
11531153so that dependent packages can find their dependencies at build time.
11541154
@@ -1217,7 +1217,7 @@ Activation & deactivation
12171217Spack's ``Package `` class has default ``activate `` and ``deactivate ``
12181218implementations that handle symbolically linking extensions' prefixes
12191219into 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
12211221logic of their own. For example, the ``activate `` and ``deactivate ``
12221222methods in the Python class use the symbolic linking, but they also
12231223handle details surrounding Python's ``.pth `` files, and other aspects
@@ -1286,7 +1286,7 @@ Virtual dependencies
12861286-----------------------------
12871287
12881288In 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
12901290particular *interface *, but there are multiple *implementations * of
12911291the 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
12991299applications can be built with any one of them. Complicating matters,
13001300MPI does not have a standardized ABI, so a package built with one
13011301implementation 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
13031303similar package files, e.g., ``foo ``, ``foo-mvapich ``, ``foo-mpich ``,
13041304but Spack avoids this explosion of package files by providing support
13051305for *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
13291329there 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
13311331both. 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
13491349notion of *versioned interfaces *. The MPI standard has gone through
13501350many revisions, each with new functions added, and each revision of
13511351the 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
13531353only provide up to MPI-2. Others may need MPI 2.1 or higher. You can
13541354indicate 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
13811381provider only provides the declared virtual spec when *it * matches
13821382the constraints in the when clause. Here, when ``mpich `` is at
13831383version 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
13851385version 1.
13861386
13871387The ``when `` qualifier ensures that Spack selects a suitably high
@@ -1544,7 +1544,7 @@ software should be installed.
15441544
15451545Spack provides wrapper functions for ``configure `` and ``make `` so
15461546that 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
15481548these functions to make writing packages more natural. See the section
15491549on :ref: `shell wrappers <shell-wrappers >`.
15501550
@@ -1603,7 +1603,7 @@ The install environment
16031603--------------------------
16041604
16051605In 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.
16071607In fact, you may need to do *less * than you would on the command line.
16081608
16091609Spack 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
16561656easily:
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.
17421742Forking ``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
17461746forks a new process each time it invokes a package's ``install() ``
17471747method. This allows packages to have their own completely sandboxed
17481748build environment, without impacting other jobs that the main Spack
@@ -1870,7 +1870,7 @@ dependency version.
18701870
18711871You can use ``satisfies() `` to test for particular dependencies,
18721872e.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
19011901You 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
22242224Packaging workflow commands
22252225-------------------------------- -
@@ -2248,7 +2248,7 @@ A typical package workflow might look like this:
22482248 ... repeat clean/ install until install works ...
22492249
22502250Below 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
23272327By 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
24782478number of other places you can cd to in the spack directory hierarchy:
24792479
24802480.. command- output:: spack cd - h
0 commit comments