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.

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

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

Merged
merged 5 commits into from Sep 13, 2023

Conversation

branfosj
Copy link
Member

@branfosj branfosj commented Jul 2, 2023

No description provided.

@branfosj branfosj added the EasyBuild-5.0 EasyBuild 5.0 label Jul 2, 2023
@@ -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]
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 to the user.
Copy link
Member

Choose a reason for hiding this comment

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

Should include a link to https://docs.easybuild.io/tracing-progress, and we should mention how to configure EasyBuild to not produce trace output, in case someone gets annoyed by it?

Copy link
Member Author

Choose a reason for hiding this comment

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

added in 1b7cefd

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.

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.

docs/easybuild-v5/overview-of-changes.md Outdated Show resolved Hide resolved
branfosj and others added 3 commits July 5, 2023 14:35
Co-authored-by: Kenneth Hoste <kenneth.hoste@ugent.be>
@boegel boegel changed the title --trace enabled by default mention that --trace will be enabled by default in EasyBuild 5.x Sep 13, 2023
@boegel boegel merged commit 2c5ac0a into easybuilders:main Sep 13, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EasyBuild-5.0 EasyBuild 5.0
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants