From 5d6af30a4952c5057e0205046ceffbc9f9d228ce Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Wed, 7 Feb 2024 18:50:48 +0000 Subject: [PATCH 1/5] RPATH on by default --- docs/easybuild-v5/enhancements.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/easybuild-v5/enhancements.md b/docs/easybuild-v5/enhancements.md index 16660f6c5..7dea7f807 100644 --- a/docs/easybuild-v5/enhancements.md +++ b/docs/easybuild-v5/enhancements.md @@ -5,6 +5,7 @@ Various significant enhancements are included in EasyBuild v5.0, including: * [`run_shell_cmd` function][run_shell_cmd] +* [Enable `--rpath` by default][rpath] * [Enable `--trace` by default][trace] --- @@ -13,6 +14,28 @@ Various significant enhancements are included in EasyBuild v5.0, including: See dedicated page on the new [`run_shell_cmd` function](run_shell_cmd.md). +--- + +## Enable `--rpath` by default {: #rpath } + +The [`--rpath` option][rpath_support] is enabled by default (see [easybuild-framework PR #4448](https://github.com/easybuilders/easybuild-framework/pull/4448)). The benefits for enabling RPATH are explained in [Why RPATH?][rpath_support_why]. + +This enhancement **does not** add any filtering of envirnoment variables. This means that environment variables, such as +`$LD_LIBRARY_PATH`, will continue to appear in the module files unless EasyBuild is configured to filter these variables +(see [Relation to `$LD_LIBRARY_PATH`][rpath_support_LD_LIBRARY_PATH]). + +To disable RPATH output, either: + +* Use the `--disable-rpath` command line option; +* Set the `$EASYBUILD_DISABLE_RPATH` environment variable; +* Disable trace mode in a [configuration file](../configuration.md#configuration_file): + + ``` ini + [override] + rapth=0 + ``` + + --- ## Enable `--trace` by default {: #trace } From 5173b12a9653957c7de02e89a39fcc7104c6f4d9 Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Wed, 7 Feb 2024 18:56:12 +0000 Subject: [PATCH 2/5] environment --- docs/easybuild-v5/enhancements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/easybuild-v5/enhancements.md b/docs/easybuild-v5/enhancements.md index 7dea7f807..a1e39c0cb 100644 --- a/docs/easybuild-v5/enhancements.md +++ b/docs/easybuild-v5/enhancements.md @@ -20,7 +20,7 @@ See dedicated page on the new [`run_shell_cmd` function](run_shell_cmd.md). The [`--rpath` option][rpath_support] is enabled by default (see [easybuild-framework PR #4448](https://github.com/easybuilders/easybuild-framework/pull/4448)). The benefits for enabling RPATH are explained in [Why RPATH?][rpath_support_why]. -This enhancement **does not** add any filtering of envirnoment variables. This means that environment variables, such as +This enhancement **does not** add any filtering of environment variables. This means that environment variables, such as `$LD_LIBRARY_PATH`, will continue to appear in the module files unless EasyBuild is configured to filter these variables (see [Relation to `$LD_LIBRARY_PATH`][rpath_support_LD_LIBRARY_PATH]). From 76652051b0309d43fb5d35ee052647df45cce9d8 Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Wed, 7 Feb 2024 19:25:50 +0000 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: Kenneth Hoste --- docs/easybuild-v5/enhancements.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/easybuild-v5/enhancements.md b/docs/easybuild-v5/enhancements.md index a1e39c0cb..09fdc9fd8 100644 --- a/docs/easybuild-v5/enhancements.md +++ b/docs/easybuild-v5/enhancements.md @@ -5,7 +5,7 @@ Various significant enhancements are included in EasyBuild v5.0, including: * [`run_shell_cmd` function][run_shell_cmd] -* [Enable `--rpath` by default][rpath] +* [Enable RPATH linking by default][rpath] * [Enable `--trace` by default][trace] --- @@ -16,23 +16,26 @@ See dedicated page on the new [`run_shell_cmd` function](run_shell_cmd.md). --- -## Enable `--rpath` by default {: #rpath } +## Enable RPATH linking by default {: #rpath } -The [`--rpath` option][rpath_support] is enabled by default (see [easybuild-framework PR #4448](https://github.com/easybuilders/easybuild-framework/pull/4448)). The benefits for enabling RPATH are explained in [Why RPATH?][rpath_support_why]. +The [RPATH linking][rpath_support] is enabled by default in EasyBuild v5.0 (see [easybuild-framework PR #4448](https://github.com/easybuilders/easybuild-framework/pull/4448)). -This enhancement **does not** add any filtering of environment variables. This means that environment variables, such as -`$LD_LIBRARY_PATH`, will continue to appear in the module files unless EasyBuild is configured to filter these variables -(see [Relation to `$LD_LIBRARY_PATH`][rpath_support_LD_LIBRARY_PATH]). +The benefits for enabling RPATH are explained in [Why RPATH?][rpath_support_why]. -To disable RPATH output, either: +This enhancement **does not** add any filtering of environment variables. This means `$LD_LIBRARY_PATH` +will continue to be appended by the environment module files EasyBuild generates, +unless it is configured to filter these variables (via `--filter-env-vars`). +See also [Relation to `$LD_LIBRARY_PATH`][rpath_support_LD_LIBRARY_PATH]). + +To disable RPATH linking, either: * Use the `--disable-rpath` command line option; * Set the `$EASYBUILD_DISABLE_RPATH` environment variable; -* Disable trace mode in a [configuration file](../configuration.md#configuration_file): +* Disable RPATH linking in an EasyBuild [configuration file](../configuration.md#configuration_file): ``` ini [override] - rapth=0 + rpath=0 ``` From 53be64fa2d18400e3fd0d347b74ad84e90420ac4 Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Thu, 8 Feb 2024 15:54:22 +0000 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Jasper Grimm <65227842+jfgrimm@users.noreply.github.com> --- docs/easybuild-v5/enhancements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/easybuild-v5/enhancements.md b/docs/easybuild-v5/enhancements.md index 09fdc9fd8..e1dce11ee 100644 --- a/docs/easybuild-v5/enhancements.md +++ b/docs/easybuild-v5/enhancements.md @@ -18,7 +18,7 @@ See dedicated page on the new [`run_shell_cmd` function](run_shell_cmd.md). ## Enable RPATH linking by default {: #rpath } -The [RPATH linking][rpath_support] is enabled by default in EasyBuild v5.0 (see [easybuild-framework PR #4448](https://github.com/easybuilders/easybuild-framework/pull/4448)). +[RPATH linking][rpath_support] is enabled by default in EasyBuild v5.0 (see [easybuild-framework PR #4448](https://github.com/easybuilders/easybuild-framework/pull/4448)). The benefits for enabling RPATH are explained in [Why RPATH?][rpath_support_why]. From f586a30bfa688beb6ff8484a3f030168a0b2df08 Mon Sep 17 00:00:00 2001 From: Kenneth Hoste Date: Wed, 14 Feb 2024 16:28:58 +0100 Subject: [PATCH 5/5] fix extra ) in paragraph on using --filter-env-vars with RPATH --- docs/easybuild-v5/enhancements.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/easybuild-v5/enhancements.md b/docs/easybuild-v5/enhancements.md index e1dce11ee..3d5332cd3 100644 --- a/docs/easybuild-v5/enhancements.md +++ b/docs/easybuild-v5/enhancements.md @@ -24,8 +24,8 @@ The benefits for enabling RPATH are explained in [Why RPATH?][rpath_support_why] This enhancement **does not** add any filtering of environment variables. This means `$LD_LIBRARY_PATH` will continue to be appended by the environment module files EasyBuild generates, -unless it is configured to filter these variables (via `--filter-env-vars`). -See also [Relation to `$LD_LIBRARY_PATH`][rpath_support_LD_LIBRARY_PATH]). +unless it is configured to filter these variables (via `--filter-env-vars`, +see also [Relation to `$LD_LIBRARY_PATH`][rpath_support_LD_LIBRARY_PATH]). To disable RPATH linking, either: