From dffc15d2e33fb907ee755be74be439600d2c8428 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Thu, 5 Feb 2015 16:04:08 +0100 Subject: [PATCH 1/3] update documentation on deprecated functionality in (generic) easyblocks --- docs/Changelog.rst | 7 ++-- docs/Deprecated-functionality.rst | 65 +++++++++++++++++++++++++++++++ docs/conf.py | 2 +- 3 files changed, 70 insertions(+), 4 deletions(-) diff --git a/docs/Changelog.rst b/docs/Changelog.rst index 6c3d1d89..3e09fa15 100644 --- a/docs/Changelog.rst +++ b/docs/Changelog.rst @@ -3,12 +3,13 @@ Changelog for EasyBuild documentation ------------------------------------- -* **release 20150126.01** (`Jan 26th 2014`): +* **release 20150205.01** (`Feb 5th 2015`): include information on deprecated functionality in (generic) easyblocks (see :ref:`deprecated`) +* **release 20150126.01** (`Jan 26th 2015`): * fix ``pip`` installation prefix option (:ref:`alt_inst_methods`) * clarify need to have modules tool binary available in ``$PATH`` (:ref:`installation`) -* **release 20150112.01** (`Jan 12th 2014`): mention need to escape ``%`` when setting log file format via config file (see :ref:`logfile_format`) -* **release 20150107.01** (`Jan 7th 2014`): document behaviour of `dummy` toolchain (:ref:`dummy_toolchain`) +* **release 20150112.01** (`Jan 12th 2015`): mention need to escape ``%`` when setting log file format via config file (see :ref:`logfile_format`) +* **release 20150107.01** (`Jan 7th 2015`): document behaviour of `dummy` toolchain (:ref:`dummy_toolchain`) * **release 20141219.01** (`Dec 19th 2014`): add release notes for EasyBuild v1.16.1 * **release 20141218.01** (`Dec 18th 2014`): add release notes for EasyBuild v1.16.0 * **release 20141217.01** (`Dec 17th 2014`): document deprecated functionality in EasyBuild v1.x (:ref:`deprecated`) diff --git a/docs/Deprecated-functionality.rst b/docs/Deprecated-functionality.rst index feca9d62..53bb8602 100644 --- a/docs/Deprecated-functionality.rst +++ b/docs/Deprecated-functionality.rst @@ -101,11 +101,13 @@ For authors of easyconfig files: * :ref:`ConfigureMake_fallback` * :ref:`easyconfig_parameters` +* :ref:`mrbayes_beagle` For developers of easyblocks: * :ref:`easyblocks_API` * :ref:`renamed_relocated_functions` +* :ref:`changes_generic_easyblocks` For EasyBuild framework developers: @@ -240,6 +242,23 @@ be a known license type (see ``eb --avail-easyconfig-licenses``). .. note:: The `software_license` easyconfig parameter will become **mandatory** at some point. +.. _mrbayes_beagle: + +``BEAGLE`` dependency in ``MrBayes`` easyblock replaced by ``beagle-lib`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**The** ``MrBayes`` **easyblock no longer considers** ``BEAGLE`` **as a valid dependency.** + +* *deprecated since:* EasyBuild v1.6.0 (Jul'14) +* *no longer supported in:* EasyBuild v2.0 +* *alternative(s)*: use ``beagle-lib`` instead + +Due to a misnomer in the easyconfig files for ``beagle-lib`` (formerly named ``BEAGLE``), the custom easyblock for +``MrBayes`` now no longer considers ``BEAGLE`` as a dependency. + +The library required by ``MrBayes`` must now be provided as a dependency named ``beagle-lib``. + + EasyBuild API changes ~~~~~~~~~~~~~~~~~~~~~ @@ -403,3 +422,49 @@ Some functions have moved to a different location: The ``get_log`` function provided by the ``easybuild.tools.build_log`` module has been deprecated entirely, no alternatives are provided (since none are needed). *(since EasyBuild v1.3.0 (Apr'13))* + +.. _changes_generic_easyblocks: + +Changes in (generic) easyblocks +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Named argument ``builddir`` in ``CMakeMake.configure_step`` replaced with ``srcdir`` +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +**The named argument** ``builddir`` **in the** ``configure_step`` **method of the generic** ``CMakeMake`` **easyblock +was replaced by the equivalent** ``srcdir`` **named argument.** + +* *deprecated since:* EasyBuild v1.4.0 (May'13) +* *no longer supported in:* EasyBuild v2.0 +* *alternative(s)*: use the ``srcdir`` named argument instead + +Since the ``builddir`` named argument in the ``configure_step`` method of the generic ``CMakeMake`` easyblock was a +misnomer (it specifies the location of the *source* directory that should be provided to ``cmake``), it was replaced +with an equivalent named argument ``srcdir``. + +``VersionIndependendPythonPackage`` generic easyblock replaced by ``VersionIndependentPythonPackage`` ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +**The** ``VersionIndependendPythonPackage`` **generic easyblock was replaced with the equivalent** +``VersionIndependentPythonPackage`` **easyblock.** + +* *deprecated since:* EasyBuild v1.11.0 (Feb'14) +* *no longer supported in:* EasyBuild v2.0 +* *alternative(s)*: use ``VersionIndependentPythonPackage`` + +Because of to a typo in the name, the ``VersionIndependendPythonPackage`` generic easyblock was replaced by the +equivalent ``VersionIndependentPythonPackage`` generic easyblock. + +``get_sitearch_suffix`` function in ``Perl`` easyblock is removed ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +**The** ``get_sitearch_suffix`` **function in the** ``Perl`` **easyblock has been removed.** + +* *deprecated since:* EasyBuild v1.7.0 (Sept'13) +* *no longer supported in:* EasyBuild v2.0 +* *alternative(s)*: use ``get_site_suffix('sitearch')`` + +The ``get_sitearch_suffix`` function provided by the ``Perl`` easyblock, which can be (and is) imported in/used by other +easyblocks, has been replaced by the more generic ``get_site_suffix`` function. + +To obtain the same functionality as was provided by ``get_sitearch_suffix``, use ``get_site_suffix('sitearch')`` instead. diff --git a/docs/conf.py b/docs/conf.py index 01953f74..325f5122 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -43,7 +43,7 @@ # The short X.Y version. version = '1.16.1' # this is meant to reference the version of EasyBuild # The full version, including alpha/beta/rc tags. -release = '20150126.01' # this is meant to reference the version of the documentation itself +release = '20150205.01' # this is meant to reference the version of the documentation itself # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: From 2a69ce62aa68cae69ecbc652848852bdbb4f8664 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Thu, 5 Feb 2015 16:13:55 +0100 Subject: [PATCH 2/3] stylistic changes --- docs/Deprecated-functionality.rst | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/Deprecated-functionality.rst b/docs/Deprecated-functionality.rst index 53bb8602..323c4f50 100644 --- a/docs/Deprecated-functionality.rst +++ b/docs/Deprecated-functionality.rst @@ -428,29 +428,29 @@ no alternatives are provided (since none are needed). *(since EasyBuild v1.3.0 ( Changes in (generic) easyblocks ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Named argument ``builddir`` in ``CMakeMake.configure_step`` replaced with ``srcdir`` -++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +``srcdir`` replaces ``builddir`` as named argument in ``CMakeMake.configure_step`` +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ **The named argument** ``builddir`` **in the** ``configure_step`` **method of the generic** ``CMakeMake`` **easyblock -was replaced by the equivalent** ``srcdir`` **named argument.** +was replaced by** ``srcdir`` **.** * *deprecated since:* EasyBuild v1.4.0 (May'13) * *no longer supported in:* EasyBuild v2.0 -* *alternative(s)*: use the ``srcdir`` named argument instead +* *alternative(s)*: equivalent ``srcdir`` named argument Since the ``builddir`` named argument in the ``configure_step`` method of the generic ``CMakeMake`` easyblock was a misnomer (it specifies the location of the *source* directory that should be provided to ``cmake``), it was replaced with an equivalent named argument ``srcdir``. -``VersionIndependendPythonPackage`` generic easyblock replaced by ``VersionIndependentPythonPackage`` -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +``VersionIndependentPythonPackage`` replaces ``VersionIndependentPythonPackage`` +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ **The** ``VersionIndependendPythonPackage`` **generic easyblock was replaced with the equivalent** ``VersionIndependentPythonPackage`` **easyblock.** * *deprecated since:* EasyBuild v1.11.0 (Feb'14) * *no longer supported in:* EasyBuild v2.0 -* *alternative(s)*: use ``VersionIndependentPythonPackage`` +* *alternative(s)*: ``VersionIndependentPythonPackage`` Because of to a typo in the name, the ``VersionIndependendPythonPackage`` generic easyblock was replaced by the equivalent ``VersionIndependentPythonPackage`` generic easyblock. @@ -458,11 +458,12 @@ equivalent ``VersionIndependentPythonPackage`` generic easyblock. ``get_sitearch_suffix`` function in ``Perl`` easyblock is removed +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -**The** ``get_sitearch_suffix`` **function in the** ``Perl`` **easyblock has been removed.** +**The** ``get_sitearch_suffix`` **function in the** ``Perl`` **easyblock was replaced in favor of the more generic** +``get_site_suffix`` **function.** * *deprecated since:* EasyBuild v1.7.0 (Sept'13) * *no longer supported in:* EasyBuild v2.0 -* *alternative(s)*: use ``get_site_suffix('sitearch')`` +* *alternative(s)*: ``get_site_suffix('sitearch')`` The ``get_sitearch_suffix`` function provided by the ``Perl`` easyblock, which can be (and is) imported in/used by other easyblocks, has been replaced by the more generic ``get_site_suffix`` function. From 87194c5d62086e9831ecf21ddff00e82484778f3 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Thu, 5 Feb 2015 16:52:15 +0100 Subject: [PATCH 3/3] fix remarks --- docs/Deprecated-functionality.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Deprecated-functionality.rst b/docs/Deprecated-functionality.rst index 323c4f50..1b13f99d 100644 --- a/docs/Deprecated-functionality.rst +++ b/docs/Deprecated-functionality.rst @@ -442,11 +442,11 @@ Since the ``builddir`` named argument in the ``configure_step`` method of the ge misnomer (it specifies the location of the *source* directory that should be provided to ``cmake``), it was replaced with an equivalent named argument ``srcdir``. -``VersionIndependentPythonPackage`` replaces ``VersionIndependentPythonPackage`` +``VersionIndependentPythonPackage`` replaces ``VersionIndependendPythonPackage`` ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -**The** ``VersionIndependendPythonPackage`` **generic easyblock was replaced with the equivalent** -``VersionIndependentPythonPackage`` **easyblock.** +**The generic easyblock** ``VersionIndependendPythonPackage`` **was replaced with the equivalent generic easyblock** +``VersionIndependentPythonPackage`` **.** * *deprecated since:* EasyBuild v1.11.0 (Feb'14) * *no longer supported in:* EasyBuild v2.0