Skip to content

Commit d113f98

Browse files
author
Vasileios Karakasis
committed
Enhance documentation of Spack backend
1 parent 3154793 commit d113f98

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

reframe/core/buildsystems.py

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -796,40 +796,46 @@ class Spack(BuildSystem):
796796
'''A build system for building test code using `Spack
797797
<https://spack.io/>`__.
798798
799-
ReFrame will use Spack to build and install the code given an environment
800-
and a set of specs.
799+
ReFrame will use a user-provided Spack environment in order to build and
800+
test a set of specs.
801801
802802
.. versionadded:: 3.6.1
803803
804804
'''
805805

806-
#: The list of specs to build and install within the given environment.
806+
#: The Spack environment to use for building this test.
807807
#:
808-
#: ReFrame will add the specs to the active environment by emititing the
809-
#: following command:
808+
#: ReFrame will activate and install this environment.
809+
#: This environment will also be used to run the test.
810810
#:
811811
#: .. code-block:: bash
812812
#:
813-
#: spack add spec1 spec2 spec3
813+
#: spack env activate -d <environment directory>
814814
#:
815-
#: :type: :class:`List[str]`
816-
#: :default: ``[]``
817-
specs = fields.TypedField(typ.List[str])
815+
#: ReFrame looks for environments in the test's
816+
#: :attr:`~reframe.core.pipeline.RegressionTest.sourcesdir`.
817+
#:
818+
#: This field is required.
819+
#:
820+
#: :type: :class:`str` or :class:`None`
821+
#: :default: :class:`None`
822+
environment = fields.TypedField(str, type(None))
818823

819-
#: Spack environment.
824+
#: The list of specs to build and install within the given environment.
820825
#:
821-
#: ReFrame activates this environment to build and install the specified
822-
#: packages:
826+
#: ReFrame will add the specs to the active environment by emititing the
827+
#: following command:
823828
#:
824829
#: .. code-block:: bash
825830
#:
826-
#: spack env activate -d <environment directory>
831+
#: spack add spec1 spec2 ... specN
827832
#:
828-
#: This field is required.
833+
#: If no spec is passed, ReFrame will simply install what is prescribed by
834+
#: the environment.
829835
#:
830-
#: :type: :class:`str` or :class:`None`
831-
#: :default: :class:`None`
832-
environment = fields.TypedField(str, type(None))
836+
#: :type: :class:`List[str]`
837+
#: :default: ``[]``
838+
specs = fields.TypedField(typ.List[str])
833839

834840
#: Emit the necessary ``spack load`` commands before running the test.
835841
#:

0 commit comments

Comments
 (0)