Skip to content

add example PR to illustrate how to add option to EasyBuild #144

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

Merged
boegel merged 3 commits into from
May 10, 2023
Merged

add example PR to illustrate how to add option to EasyBuild #144

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5adf46b
fix scope of active configuration options
lexming Apr 26, 2023
2152d5d
reference PR easybuild-framework#4226 as example on how to add new op…
lexming Apr 26, 2023
559ab95
fix typo
boegel May 10, 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: 6 additions & 5 deletions docs/framework-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,9 +387,9 @@ through its `set_up_configuration()` method, which is called in the

Once all options are parsed, those options listed in `easybuild.tools.config`
will be gathered in a singleton `BuildOptions` class. This class is the
centralized locations of configuration options for the current build. The
method `build_option()` in `easybuild.tools.config` provides a simple interface
to it:
centralized location of configuration options for the current EasyBuild
session. The method `build_option()` in `easybuild.tools.config` provides a
simple interface to it:

```python
if build_option('ignore_test_failure'):
Expand All @@ -401,8 +401,9 @@ else:
Therefore, adding a new option to `eb` and making that options available
through `build_option()` is a two step process. First the option has to be
added to `EasyBuildOptions` in `easybuild.tools.options` and then also listed
in `easybuild.tools.config`.

in `easybuild.tools.config`. As an example, you can check
[easybuild-framework#4226](https://github.com/easybuilders/easybuild-framework/pull/4226)
which is a PR adding the `download_timeout` option to EasyBuild.

## Features in easybuild.tools

Expand Down