From 581381e11818b9db69b93f8176a0b0cdba114b6e Mon Sep 17 00:00:00 2001 From: Simon Branford Date: Sun, 2 Jul 2023 09:59:48 +0100 Subject: [PATCH 1/5] --trace enabled by default --- docs/easybuild-v5/overview-of-changes.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/easybuild-v5/overview-of-changes.md b/docs/easybuild-v5/overview-of-changes.md index 570181d7e..a5668ebfb 100644 --- a/docs/easybuild-v5/overview-of-changes.md +++ b/docs/easybuild-v5/overview-of-changes.md @@ -32,8 +32,6 @@ feedback then please comment in the GitHub issue for the proposal. ### Planned changes for EasyBuild v5.0 {: #eb5_plans } -* [enable `--trace` by default](https://github.com/easybuilders/easybuild-framework/pull/4250) - !!! note This list is the major planned changes. It is not intended to be a complete list of all changes that are planned for EasyBuild v5.0. @@ -48,7 +46,12 @@ feedback then please comment in the GitHub issue for the proposal. Various significant enhancements are included in EasyBuild v5.0, including: -* *(no significant enhancements implemented so far in the `5.0.x` branches)* +* [enable `--trace` by default][eb5_trace] + +### `--trace` enabled by default {: #eb5_trace } + +The [`--trace` option is enabled by default](https://github.com/easybuilders/easybuild-framework/pull/4250). This makes +the steps and commands that EasyBuild is running clearer to the user. --- From 1b7cefd15276cad4e9b273d28ade7cf88e2fa39a Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Wed, 5 Jul 2023 12:47:19 +0100 Subject: [PATCH 2/5] further information --- docs/easybuild-v5/overview-of-changes.md | 4 +++- docs/tracing-progress.md | 6 ------ 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/docs/easybuild-v5/overview-of-changes.md b/docs/easybuild-v5/overview-of-changes.md index a5668ebfb..2f8751f2a 100644 --- a/docs/easybuild-v5/overview-of-changes.md +++ b/docs/easybuild-v5/overview-of-changes.md @@ -51,7 +51,9 @@ Various significant enhancements are included in EasyBuild v5.0, including: ### `--trace` enabled by default {: #eb5_trace } The [`--trace` option is enabled by default](https://github.com/easybuilders/easybuild-framework/pull/4250). This makes -the steps and commands that EasyBuild is running clearer to the user. +the [steps and commands that EasyBuild is running clearer][trace] to the user. + +Use `--disable-trace` to remove this extra information. --- diff --git a/docs/tracing-progress.md b/docs/tracing-progress.md index 952256a97..30c326170 100644 --- a/docs/tracing-progress.md +++ b/docs/tracing-progress.md @@ -3,12 +3,6 @@ To trace the progress of EasyBuild while it is installing software, you can use `eb --trace`. -!!! note - Tracing support was added as an experimental feature in EasyBuild v3.4.0, and thus required - using `--experimental`. Since EasyBuild v3.4.1, `--trace` is - considered stable and no longer requires the use of - `--experimental`. - ## Trace output {: #trace_output } When `eb --trace` is used, EasyBuild will print additional output on top From f735794dab0367b76ea5d59a72fbbd223776f45d Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Wed, 5 Jul 2023 14:35:55 +0100 Subject: [PATCH 3/5] clearer explanation Co-authored-by: Kenneth Hoste --- docs/easybuild-v5/overview-of-changes.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/easybuild-v5/overview-of-changes.md b/docs/easybuild-v5/overview-of-changes.md index 2f8751f2a..d9945f144 100644 --- a/docs/easybuild-v5/overview-of-changes.md +++ b/docs/easybuild-v5/overview-of-changes.md @@ -50,8 +50,8 @@ Various significant enhancements are included in EasyBuild v5.0, including: ### `--trace` enabled by default {: #eb5_trace } -The [`--trace` option is enabled by default](https://github.com/easybuilders/easybuild-framework/pull/4250). This makes -the [steps and commands that EasyBuild is running clearer][trace] to the user. +The [`--trace` option][trace] 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. Use `--disable-trace` to remove this extra information. From 03e13c334b0b531ab1f9c419ee3a951573c241bd Mon Sep 17 00:00:00 2001 From: Simon Branford Date: Wed, 5 Jul 2023 14:41:26 +0100 Subject: [PATCH 4/5] more info on disabling --trace --- docs/easybuild-v5/overview-of-changes.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/easybuild-v5/overview-of-changes.md b/docs/easybuild-v5/overview-of-changes.md index d9945f144..8860a8e37 100644 --- a/docs/easybuild-v5/overview-of-changes.md +++ b/docs/easybuild-v5/overview-of-changes.md @@ -53,7 +53,15 @@ Various significant enhancements are included in EasyBuild v5.0, including: The [`--trace` option][trace] 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. -Use `--disable-trace` to remove this extra information. +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_file]: + ``` ini + [override] + trace=0 + ``` --- From d239a364648bf858a727270c5b296a82a300ff69 Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Wed, 5 Jul 2023 14:42:46 +0100 Subject: [PATCH 5/5] linting --- docs/easybuild-v5/overview-of-changes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/easybuild-v5/overview-of-changes.md b/docs/easybuild-v5/overview-of-changes.md index 8860a8e37..24499ff1b 100644 --- a/docs/easybuild-v5/overview-of-changes.md +++ b/docs/easybuild-v5/overview-of-changes.md @@ -58,6 +58,7 @@ 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_file]: + ``` ini [override] trace=0