Skip to content

Commit

Permalink
Merge pull request #178 from branfosj/trace
Browse files Browse the repository at this point in the history
mention that `--trace` will be enabled by default in EasyBuild 5.x
  • Loading branch information
boegel authored Sep 13, 2023
2 parents 76e5e33 + d239a36 commit 2c5ac0a
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 9 deletions.
20 changes: 17 additions & 3 deletions docs/easybuild-v5/overview-of-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -48,7 +46,23 @@ 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][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.

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
```

---

Expand Down
6 changes: 0 additions & 6 deletions docs/tracing-progress.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2c5ac0a

Please sign in to comment.