Skip to content

Commit

Permalink
download_instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
branfosj authored Feb 21, 2024
1 parent f087e44 commit 262078e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions docs/easybuild-v5/enhancements.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Various significant enhancements are included in EasyBuild v5.0, including:
* [`run_shell_cmd` function][run_shell_cmd]
* [Enable RPATH linking by default][rpath]
* [Enable `--trace` by default][trace]
* [Require `download_instructions` to be specified][require_download_instructions]

---

Expand Down Expand Up @@ -57,3 +58,16 @@ To disable trace output, either:
[override]
trace=0
```
---
## Require `download_instructions` to be specified {: require_download_instructions }
[`download_instructions`][download_instructions] is used in easyconfigs to specify instructions, or information, on
how to obtain sources that are not directly downloadable. In EasyBuild 5, we require that easyconfigs specify these
(see [easybuild-easyconfigs PR #19881](https://github.com/easybuilders/easybuild-easyconfigs/pull/19881)).
As part of this enhancement we also added `download_instructions` to all easyconfigs that require them (see the PRs linked from
[easybuild-easyconfigs PR #19881](https://github.com/easybuilders/easybuild-easyconfigs/pull/19881)). In addition to the
`download_instructions` we also clearly specify the active source path (see
[easybuild-framework PR #4459](https://github.com/easybuilders/easybuild-framework/pull/4459)).
2 changes: 1 addition & 1 deletion docs/writing-easyconfig-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ sources = [{
in favour of the Python dictionary format described above; see also
[Specifying source files as 2-element tuples to provide a custom extraction command][depr_sources_2_element_tuple].

#### Using `download_instructions` for user-side part of installation
#### Using `download_instructions` for user-side part of installation {: download_instructions }

In some cases, getting some of the files required for an installation
cannot be automated. Reasons for this include:
Expand Down

0 comments on commit 262078e

Please sign in to comment.