zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix bugs in contribution, getting started guides (#18216)

Browse Source 
Co-authored-by: Greg Becker <becker33@llnl.gov>
Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com>
This commit is contained in:
Richarda Butler
2020-08-26 23:23:26 -07:00
committed by GitHub
parent 5d3ad70e0a
commit 416afa0059
2 changed files with 24 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
lib/spack/docs/contribution_guide.rst
View File

@@ -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 .. command-output:: spack test --list-long lib/spack/spack/test/architecture.py
You can also combine any of these options with a ``pytest`` keyword 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: or "concretize" somewhere in their names:
.. command-output:: spack test --list-names -k "spec and concretize" .. command-output:: spack test --list-names -k "spec and concretize"
@@ -159,7 +161,7 @@ argument to ``pytest``:
.. code-block:: console .. 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 Unit tests are crucial to making sure bugs aren't introduced into
Spack. If you are modifying core Spack libraries or adding new 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 .. code-block:: console
$ cd "$SPACK_ROOT/lib/spack/docs" $ cd path/to/spack/lib/spack/docs/
$ make clean $ make clean
$ make $ make

23
lib/spack/docs/getting_started.rst
View File

@@ -53,22 +53,37 @@ in the ``SPACK_ROOT`` environment variable. Add ``$SPACK_ROOT/bin``
to your path and you're ready to go: to your path and you're ready to go:
.. code-block:: console .. code-block:: console
# For bash/zsh users
$ export SPACK_ROOT=/path/to/spack
$ export PATH=$SPACK_ROOT/bin:$PATH $ 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 $ spack install libelf
For a richer experience, use Spack's shell support: For a richer experience, use Spack's shell support:
.. code-block:: console .. code-block:: console
# Note you must set SPACK_ROOT
# For bash/zsh users # For bash/zsh users
$ export SPACK_ROOT=/path/to/spack
$ . $SPACK_ROOT/share/spack/setup-env.sh $ . $SPACK_ROOT/share/spack/setup-env.sh
# For tcsh or csh users (note you must set SPACK_ROOT) # For tcsh/csh users
$ setenv SPACK_ROOT /path/to/spack
$ source $SPACK_ROOT/share/spack/setup-env.csh $ 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`` This automatically adds Spack to your ``PATH`` and allows the ``spack``
command to be used to execute spack :ref:`commands <shell-support>` and command to be used to execute spack :ref:`commands <shell-support>` and