Merge pull request #241 from branfosj/develop

RPATH on by default

Author: boegel

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 linking by default][rpath]
 * [Enable `--trace` by default][trace]
 
 ---
@@ -13,6 +14,31 @@ 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 }