Which easyconfigs an easyblock change reaches¶
A change to an easyblock, generic or software-specific, or to a framework
module an easyblock imports, reaches the easyconfigs that use that class.
The class may be the easyblock line, the implied EB_<Name> class, a
subclass, an extension class, or a bundle component class.
One changed file¶
scripts/fetch-upstream-trees.sh creates a checkout of the pinned trees and writes
env.sh. EB_EASYBLOCKS is easybuild-easyblocks v5.4.1.
EB_EASYCONFIGS is the develop easyconfigs directory.
EB_EASYBUILD_FRAMEWORK is easybuild-framework v5.4.1. Source env.sh
and pass those paths.
scripts/fetch-upstream-trees.sh
set -a
source "${EB_UPSTREAM_CACHE:-$HOME/.cache/eb-stack/upstream}/env.sh"
set +a
printf '%s\n' 'CMake/4.2.1-GCCcore-15.2.0' > /tmp/modules.txt
eb-stack easyblock-reach \
--easyblocks "$EB_EASYBLOCKS" \
--easyconfigs "$EB_EASYCONFIGS" \
--file "$EB_EASYBLOCKS/easybuild/easyblocks/generic/cmakemake.py" \
--installed /tmp/modules.txt \
--reverse \
--out-dir /tmp/cmakemake-reach
That command, against the trees `scripts/fetch-upstream-trees.sh` checked out on 2026-10-24, printed:
easyconfigs=2352 installed=0 classes=39 reverse=5058 out=/tmp/cmakemake-reach
installed stays 0 when the modules file does not name a reached
module. The empty range HEAD..HEAD on that same checkout printed
easyconfigs=0 installed=0 classes=0 reverse=0.
modules.txt lists installed modules, one per line:
name/version[-toolchain]versionsuffix. Blank lines and # comments are
ignored.
The command writes reach.toml, reach.json, and reach.md to
--out-dir. reach.toml starts with
# Generated by `eb-stack easyblock-reach`., and reach.md opens with
the same line as an HTML comment. reach.json has no comment.
A commit range or a pull request¶
eb-stack easyblock-reach \
--easyblocks "$EB_EASYBLOCKS" \
--easyconfigs "$EB_EASYCONFIGS" \
--range HEAD..HEAD \
--out-dir /tmp/range-reach
eb-stack easyblock-reach \
--easyblocks "$EB_EASYBLOCKS" \
--framework "$EB_EASYBUILD_FRAMEWORK" \
--easyconfigs "$EB_EASYCONFIGS" \
--pr 4250 \
--repo "$EB_EASYBLOCKS" \
--base easybuild-easyblocks-v5.4.1 \
--out-dir /tmp/pr4250-reach
--range is passed to git diff --name-only. HEAD..HEAD on the
pinned checkout changes no file. --pr fetches refs/pull/N/head and
diffs it against the merge-base with --base (default develop). The
pinned easyblocks checkout is the v5.4.1 tag, so pass
--base easybuild-easyblocks-v5.4.1 when that is the tree --repo
has. --repo is the clone git reads; it defaults to the first
--easyblocks path. The class hierarchy is the working tree. A
deleted file is read from the base so its class is still seen.
What counts as a use¶
the
easyblocklineno
easyblockline:EB_<Name>derived from the software namea subclass, read from the Python
classstatement, soEB_GROMACS(CMakeMake)is reached by a change toCMakeMakea nested class, so
EB_QuantumESPRESSOcmake(CMakeMake)insideEB_QuantumESPRESSOreaches the QuantumESPRESSO easyconfigsa module-level alias bound to a class, so
Legacy = CMakeMakeisCMakeMakean extension’s own
easyblock, elseEB_<extname>when that class exists, elseexts_classmap, elseexts_defaultclassa component’s own
easyblock, elseEB_<name>when that class exists, elsedefault_easyblock
A class that assigns exts_defaultclass overwrites the easyconfig.
PythonBundle assigns PythonPackage, including from inside with.
For a component, default_easyblock in the easyconfig wins over the
class.
A framework module reaches the easyblocks that import it, then their subclasses. Imports inside `easybuild.framework` and `easybuild.tools` are followed to the end of that graph. An easyblock that imports any module on that path is reached. An easyblock that only imports another easyblock is not, unless it subclasses a reached class.
--reverse lists modules that depend on a reached module and would need a
rebuild: runtime, builddependency, extension, or toolchain. Reached modules
are not listed again.