Skip to content

Commit 2c5ac0a

Browse files
authored
Merge pull request #178 from branfosj/trace
mention that `--trace` will be enabled by default in EasyBuild 5.x
2 parents 76e5e33 + d239a36 commit 2c5ac0a

File tree

2 files changed

+17
-9
lines changed

2 files changed

+17
-9
lines changed

docs/easybuild-v5/overview-of-changes.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ feedback then please comment in the GitHub issue for the proposal.
3232

3333
### Planned changes for EasyBuild v5.0 {: #eb5_plans }
3434

35-
* [enable `--trace` by default](https://github.com/easybuilders/easybuild-framework/pull/4250)
36-
3735
!!! note
3836
This list is the major planned changes. It is not intended to be a complete list of all changes that are
3937
planned for EasyBuild v5.0.
@@ -48,7 +46,23 @@ feedback then please comment in the GitHub issue for the proposal.
4846

4947
Various significant enhancements are included in EasyBuild v5.0, including:
5048

51-
* *(no significant enhancements implemented so far in the `5.0.x` branches)*
49+
* [enable `--trace` by default][eb5_trace]
50+
51+
### `--trace` enabled by default {: #eb5_trace }
52+
53+
The [`--trace` option][trace] is enabled by default (see [easybuild-framework PR #4250](https://github.com/easybuilders/easybuild-framework/pull/4250)).
54+
This makes the output produced by the `eb` command more informative, by providing more information about what's going on in the background.
55+
56+
To disable trace output, either:
57+
58+
* Use the `--disable-trace` command line option;
59+
* Set the `$EASYBUILD_DISABLE_TRACE` environment variable;
60+
* Disable trace mode in a [configuration file][configuration_file]:
61+
62+
``` ini
63+
[override]
64+
trace=0
65+
```
5266

5367
---
5468

docs/tracing-progress.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,6 @@
33
To trace the progress of EasyBuild while it is installing software, you
44
can use `eb --trace`.
55

6-
!!! note
7-
Tracing support was added as an experimental feature in EasyBuild v3.4.0, and thus required
8-
using `--experimental`. Since EasyBuild v3.4.1, `--trace` is
9-
considered stable and no longer requires the use of
10-
`--experimental`.
11-
126
## Trace output {: #trace_output }
137

148
When `eb --trace` is used, EasyBuild will print additional output on top

0 commit comments

Comments
 (0)