Skip to content

Commit 987111b

Browse files
committed
Small addition to replaced variables and findPythonDeps
1 parent 16d19bc commit 987111b

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/writing-easyconfig-files.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -977,7 +977,8 @@ This manual process can be partially automated:
977977
1. Optionally, but recommended, update the version of the software for each created easyconfig to the latest available one.
978978
1. **Important**: Verify the newly created easyconfigs by comparing each of them against the existing one for that software.
979979
Only the version of the software, toolchain and dependencies should have been changed.
980-
EasyBuild often replaces local variables or templates by their value when updating easyconfigs.
980+
EasyBuild often replaces local variables or templates like `name` or `%(version)s` by their value when updating easyconfigs.
981+
This is undesirable as the values might become out of sync with what they are supposed to be, e.g. after changing the version variable.
981982
It might be easier to use those easyconfigs just for getting the versions of each dependency required
982983
and still copy & update the easyconfigs from existing ones manually.
983984

@@ -990,7 +991,7 @@ The latest version of a single Python package can usually be found on [PyPI](htt
990991
To find the list of Python dependencies for another Python package to be installed by an easyconfig you can use the `findPythonDeps` script
991992
distributed with EasyBuild.
992993
This will also output the latest, compatible version of the found packages.
993-
A good approach is to start from an easyconfig just containing the dependency on Python but no Python packages and then run the `findPythonDeps`.
994+
A good approach is to start from an easyconfig just containing the dependency on Python but no Python packages and then run e.g. `findPythonDeps --ec foo-1.2.3.eb foo==1.2.3`.
994995
For every Python package displayed by the script first search for a suitable easyconfig containing that package and add it as a dependency one by one.
995996
That might require updating it from another toolchain.
996997
Then run the script again to honor Python packages from that dependency and its dependencies.

0 commit comments

Comments
 (0)