From 262078eac2ec9fc26667a6b449f7468984cafb9e Mon Sep 17 00:00:00 2001
From: Simon Branford <4967+branfosj@users.noreply.github.com>
Date: Wed, 21 Feb 2024 12:50:19 +0000
Subject: [PATCH] `download_instructions`

---
 docs/easybuild-v5/enhancements.md | 14 ++++++++++++++
 docs/writing-easyconfig-files.md  |  2 +-
 2 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/docs/easybuild-v5/enhancements.md b/docs/easybuild-v5/enhancements.md
index 3d5332cd3..b561b359f 100644
--- a/docs/easybuild-v5/enhancements.md
+++ b/docs/easybuild-v5/enhancements.md
@@ -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]
 
 ---
 
@@ -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)).
diff --git a/docs/writing-easyconfig-files.md b/docs/writing-easyconfig-files.md
index 7238a928c..7f3875fd0 100644
--- a/docs/writing-easyconfig-files.md
+++ b/docs/writing-easyconfig-files.md
@@ -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: