From 1791ff8715a70011cdbd775780aea20b0c2c8db7 Mon Sep 17 00:00:00 2001 From: Simon Branford Date: Fri, 16 Feb 2024 18:30:23 +0000 Subject: [PATCH 1/3] split out default config changes and remove proposed changes --- .../changes-in-default-configuration.md | 52 +++++++++++++++++++ docs/easybuild-v5/enhancements.md | 45 ---------------- docs/easybuild-v5/index.md | 1 + docs/easybuild-v5/overview-of-changes.md | 5 +- docs/easybuild-v5/proposed-changes.md | 9 ---- 5 files changed, 55 insertions(+), 57 deletions(-) create mode 100644 docs/easybuild-v5/changes-in-default-configuration.md delete mode 100644 docs/easybuild-v5/proposed-changes.md diff --git a/docs/easybuild-v5/changes-in-default-configuration.md b/docs/easybuild-v5/changes-in-default-configuration.md new file mode 100644 index 000000000..e71551c20 --- /dev/null +++ b/docs/easybuild-v5/changes-in-default-configuration.md @@ -0,0 +1,52 @@ +# Changes in default configuration in EasyBuild v5.0 + +*(for a full overview of changes in EasyBuild v5.0, see [here](overview-of-changes.md))* + +Various changes in default configuration included in EasyBuild v5.0, including: + +* [Enable RPATH linking by default][rpath] +* [Enable `--trace` by default][trace] + +--- + +## Enable RPATH linking by default {: #rpath } + +[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]. + +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 RPATH linking in an EasyBuild [configuration file](../configuration.md#configuration_file): + + ``` ini + [override] + rpath=0 + ``` + + +--- + +## Enable `--trace` by default {: #trace } + +The [`--trace` option](../tracing-progress.md) is enabled by default (see [easybuild-framework PR #4250](https://github.com/easybuilders/easybuild-framework/pull/4250)). + +This makes the output produced by the `eb` command more informative, by providing more information about what's going on in the background. + +To disable trace output, either: + +* Use the `--disable-trace` command line option; +* Set the `$EASYBUILD_DISABLE_TRACE` environment variable; +* Disable trace mode in a [configuration file](../configuration.md#configuration_file): + + ``` ini + [override] + trace=0 + ``` diff --git a/docs/easybuild-v5/enhancements.md b/docs/easybuild-v5/enhancements.md index 3d5332cd3..33b3543dd 100644 --- a/docs/easybuild-v5/enhancements.md +++ b/docs/easybuild-v5/enhancements.md @@ -5,8 +5,6 @@ Various significant enhancements are included in EasyBuild v5.0, including: * [`run_shell_cmd` function][run_shell_cmd] -* [Enable RPATH linking by default][rpath] -* [Enable `--trace` by default][trace] --- @@ -14,46 +12,3 @@ 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 linking by default {: #rpath } - -[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]. - -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 RPATH linking in an EasyBuild [configuration file](../configuration.md#configuration_file): - - ``` ini - [override] - rpath=0 - ``` - - ---- - -## Enable `--trace` by default {: #trace } - -The [`--trace` option](../tracing-progress.md) is enabled by default (see [easybuild-framework PR #4250](https://github.com/easybuilders/easybuild-framework/pull/4250)). - -This makes the output produced by the `eb` command more informative, by providing more information about what's going on in the background. - -To disable trace output, either: - -* Use the `--disable-trace` command line option; -* Set the `$EASYBUILD_DISABLE_TRACE` environment variable; -* Disable trace mode in a [configuration file](../configuration.md#configuration_file): - - ``` ini - [override] - trace=0 - ``` diff --git a/docs/easybuild-v5/index.md b/docs/easybuild-v5/index.md index f6578511c..b1002acff 100644 --- a/docs/easybuild-v5/index.md +++ b/docs/easybuild-v5/index.md @@ -2,6 +2,7 @@ - [Overview of changes](overview-of-changes.md) - [Backwards-incompatible changes](backwards-incompatible-changes.md) + - [Changes in default configuration](changes-in-default-configuration.md) - [Enhancements](enhancements.md) - [`run_shell_cmd` function](run_shell_cmd.md) - [Deprecated functionality](deprecated-functionality.md) diff --git a/docs/easybuild-v5/overview-of-changes.md b/docs/easybuild-v5/overview-of-changes.md index 3eec0ff9f..9ab66bda3 100644 --- a/docs/easybuild-v5/overview-of-changes.md +++ b/docs/easybuild-v5/overview-of-changes.md @@ -3,16 +3,15 @@ !!! warning EasyBuild 5.0 is currently still under development, via the `5.0.x` branches in the EasyBuild GitHub repositories. - We intend to update this section of the documentation regularly as the planned changes are being implemented, - and when there are [proposed changes](proposed-changes.md) where we are requesting community feedback. + We intend to update this section of the documentation regularly as the planned changes are being implemented. This page provides a concise overview of the most prominent changes in EasyBuild version 5.0, which can be categorized as: * [Enhancements](enhancements.md) +* [Changes in default configuration](changes-in-default-configuration.md) * [Backward-incompatible changes](backwards-incompatible-changes.md) * [Deprecated functionality](deprecated-functionality.md) -* [Proposed changes](proposed-changes.md) * [Policies](policies.md) For in-depth details on a particular change, see the pull requests that are linked diff --git a/docs/easybuild-v5/proposed-changes.md b/docs/easybuild-v5/proposed-changes.md deleted file mode 100644 index d7af4c5df..000000000 --- a/docs/easybuild-v5/proposed-changes.md +++ /dev/null @@ -1,9 +0,0 @@ -# Proposed changes for EasyBuild v5.0 - -*(for a full overview of changes in EasyBuild v5.0, see [here](overview-of-changes.md))* - -There are several proposed changes where the EasyBuild maintainers are seeking community feedback. -If you wish to provide feedback then please comment in the GitHub issue for the proposal. - -* [Minimum supported Lmod version](https://github.com/easybuilders/easybuild/issues/871) -* [Toolchain support policy](https://github.com/easybuilders/easybuild/issues/872) From 549561294b9a78097d60ad3fa5642f919bcbd465 Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Mon, 4 Mar 2024 12:39:39 +0000 Subject: [PATCH 2/3] redirect proposed changes to EB5 index --- mkdocs.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 0f79fc30c..1214f11fe 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -196,9 +196,12 @@ plugins: - index.md # necessary for search to work - search - # redirects for original EasyBuild documentation to avoid broken URLs + - redirects: redirect_maps: + # redirect removed pages to sensible alternative + easybuild-v5/proposed-changes/: easybuild-v5/index.md + # redirects for original EasyBuild documentation to avoid broken URLs en/latest/Archived-easyconfigs.html: archived-easyconfigs.md en/latest/Backup_modules.html: backup-modules.md en/latest/Changelog.html: changelog-docs.md From ca2a19483d48d6e7c79e7b945d87e483ac5c4851 Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Mon, 4 Mar 2024 12:41:01 +0000 Subject: [PATCH 3/3] yaml lint --- mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 1214f11fe..81db743ee 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -196,7 +196,6 @@ plugins: - index.md # necessary for search to work - search - - redirects: redirect_maps: # redirect removed pages to sensible alternative