summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRicharda Butler <39577672+RikkiButler20@users.noreply.github.com>2020-08-26 23:23:26 -0700
committerGitHub <noreply@github.com>2020-08-27 08:23:26 +0200
commit416afa0059fb51e6753bd44a6b923481dd02065a (patch)
tree8a330b9fa8dd36f22d3e484fc9616a1fda5ec9a5
parent5d3ad70e0aeed90ecc4260a3eb1b26e7c13c815e (diff)
downloadspack-416afa0059fb51e6753bd44a6b923481dd02065a.tar.gz
spack-416afa0059fb51e6753bd44a6b923481dd02065a.tar.bz2
spack-416afa0059fb51e6753bd44a6b923481dd02065a.tar.xz
spack-416afa0059fb51e6753bd44a6b923481dd02065a.zip
docs: fix bugs in contribution, getting started guides (#18216)
Co-authored-by: Greg Becker <becker33@llnl.gov> Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com>
-rw-r--r--lib/spack/docs/contribution_guide.rst8
-rw-r--r--lib/spack/docs/getting_started.rst23
2 files changed, 24 insertions, 7 deletions
diff --git a/lib/spack/docs/contribution_guide.rst b/lib/spack/docs/contribution_guide.rst
index 2fc6546f5e..37cf9091bd 100644
--- a/lib/spack/docs/contribution_guide.rst
+++ b/lib/spack/docs/contribution_guide.rst
@@ -146,7 +146,9 @@ you want to know about. For example, to see just the tests in
.. command-output:: spack test --list-long lib/spack/spack/test/architecture.py
You can also combine any of these options with a ``pytest`` keyword
-search. For example, to see the names of all tests that have "spec"
+search. See the `pytest usage docs
+<https://docs.pytest.org/en/stable/usage.html#specifying-tests-selecting-tests>`_:
+for more details on test selection syntax. For example, to see the names of all tests that have "spec"
or "concretize" somewhere in their names:
.. command-output:: spack test --list-names -k "spec and concretize"
@@ -159,7 +161,7 @@ argument to ``pytest``:
.. code-block:: console
- $ spack test -s spack test --list-long lib/spack/spack/test/architecture.py::test_platform
+ $ spack test -s --list-long lib/spack/spack/test/architecture.py::test_platform
Unit tests are crucial to making sure bugs aren't introduced into
Spack. If you are modifying core Spack libraries or adding new
@@ -325,7 +327,7 @@ Once all of the dependencies are installed, you can try building the documentati
.. code-block:: console
- $ cd "$SPACK_ROOT/lib/spack/docs"
+ $ cd path/to/spack/lib/spack/docs/
$ make clean
$ make
diff --git a/lib/spack/docs/getting_started.rst b/lib/spack/docs/getting_started.rst
index 9ce01ae222..f9e6c0fa57 100644
--- a/lib/spack/docs/getting_started.rst
+++ b/lib/spack/docs/getting_started.rst
@@ -53,22 +53,37 @@ in the ``SPACK_ROOT`` environment variable. Add ``$SPACK_ROOT/bin``
to your path and you're ready to go:
.. code-block:: console
-
+
+ # For bash/zsh users
+ $ export SPACK_ROOT=/path/to/spack
$ export PATH=$SPACK_ROOT/bin:$PATH
+
+ # For tsch/csh users
+ $ setenv SPACK_ROOT /path/to/spack
+ $ setenv PATH $SPACK_ROOT/bin:$PATH
+
+ # For fish users
+ $ set -x SPACK_ROOT /path/to/spack
+ $ set -U fish_user_paths /path/to/spack $fish_user_paths
+
+.. code-block:: console
+
$ spack install libelf
For a richer experience, use Spack's shell support:
.. code-block:: console
+ # Note you must set SPACK_ROOT
+
# For bash/zsh users
- $ export SPACK_ROOT=/path/to/spack
$ . $SPACK_ROOT/share/spack/setup-env.sh
- # For tcsh or csh users (note you must set SPACK_ROOT)
- $ setenv SPACK_ROOT /path/to/spack
+ # For tcsh/csh users
$ source $SPACK_ROOT/share/spack/setup-env.csh
+ # For fish users
+ $ source $SPACK_ROOT/share/spack/setup-env.fish
This automatically adds Spack to your ``PATH`` and allows the ``spack``
command to be used to execute spack :ref:`commands <shell-support>` and