Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

mention that --trace will be enabled by default in EasyBuild 5.x #178

Merged
merged 5 commits into from
Sep 13, 2023
Merged

mention that --trace will be enabled by default in EasyBuild 5.x #178

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
581381e
--trace enabled by default
branfosj Jul 2, 2023
1b7cefd
further information
branfosj Jul 5, 2023
f735794
clearer explanation
branfosj Jul 5, 2023
03e13c3
more info on disabling --trace
branfosj Jul 5, 2023
d239a36
linting
branfosj Jul 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/easybuild-v5/overview-of-changes.md
View file
Open in desktop
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,14 @@ 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]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you could debate whether this is an enhancement or not, rather than just a changed default, but fine as is.


### `--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.
branfosj marked this conversation as resolved.
Show resolved Hide resolved

Use `--disable-trace` to remove this extra information.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would mention all 3 ways to disable trace output:

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:
[override]
trace=0

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

03e13c3


---

Expand Down
6 changes: 0 additions & 6 deletions docs/tracing-progress.md
View file
Open in desktop
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