Skip to content

update documentation to use SYSTEM template constant for system-toolchain dependencies #827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 12, 2022
Merged

update documentation to use SYSTEM template constant for system-toolchain dependencies #827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Wrapping_dependencies.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ depending on a specific version (e.g., ``Java/1.8.0_181``):
.. code::

# specify dependency on Java/1.8 "wrapper", rather than a specific Java version
dependencies = [('Java', '1.8', '', True)]
dependencies = [('Java', '1.8', '', SYSTEM)]

This has a couple of advantages:

Expand Down
10 changes: 3 additions & 7 deletions docs/Writing_easyconfig_files.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -579,16 +579,12 @@ versions prior to v4.0, see :ref:`system_toolchain_motivation_deprecating_dummy`
Specifying dependencies using ``system`` toolchain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To make EasyBuild resolve a dependency using the ``system`` toolchain, either specify '``system``' as toolchain name
in the tuple representing the dependency specification, or simply use ``True`` as 4th value in the tuple.
To make EasyBuild resolve a dependency using the ``system`` toolchain, simply use the ``SYSTEM`` template constant as
the 4th value in the tuple representing the dependency specification.

For example, to specify PnMPI version 1.2.0 built with the ``system`` toolchain as a (runtime) dependency::

dependencies = [('PnMPI', '1.2.0', '', ('system', ''))]

which is equivalent to::

dependencies = [('PnMPI', '1.2.0', '', True)]
dependencies = [('PnMPI', '1.2.0', '', SYSTEM)]


Using external modules as dependencies
Expand Down