Skip to content

document deprecation of Toolchain.add_dependencies #471

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
bartoldeman merged 1 commit into from
Dec 7, 2018
Merged

document deprecation of Toolchain.add_dependencies #471

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
16 changes: 16 additions & 0 deletions docs/Deprecated-functionality.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ For developers of easyblocks:
For EasyBuild framework developers:

* :ref:`depr_get_easyblock_class_default_fallback`
* :ref:`depr_toolchain_add_dependencies`


.. _depr_fftw_use_fma4:
Expand Down Expand Up @@ -156,6 +157,21 @@ The ``default_fallback`` named argument for ``get_easyblock_class`` was replaced
to retain support for ignoring a missing matching easyblock rather than raising an error.


.. _depr_toolchain_add_dependencies:

``add_dependencies`` method in ``Toolchain`` class
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* *deprecated since:* EasyBuild v3.8.0
* *will be removed in:* EasyBuild v4.0
* *alternatives*: **pass list of dependencies to** ``deps`` **named argument of** ``prepare`` **method instead**

The ``add_dependencies`` method in the ``Toolchain`` class was deprecated, to provide more flexibility in the
EasyBuild framework w.r.t. handling of dependencies (see https://github.com/easybuilders/easybuild-framework/pull/2674).

Instead, the list of dependencies should be passed to the ``Toolchain.prepare`` method, via the ``deps`` named argument.


.. _deprecation_policy:

Deprecation policy
Expand Down