Skip to content

Commit 8825914

Browse files
Merge pull request #222 from boegel/eb482_auto_update
auto-update docs for EasyBuild v4.8.2
2 parents 157ad8a + fde660f commit 8825914

File tree

4 files changed

+1014
-338
lines changed

4 files changed

+1014
-338
lines changed

docs/version-specific/easyconfig-templates.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,22 @@ Template name |Template value
1616

1717
Template name |Template value
1818
--------------------|------------------------------------------------
19+
``%(cudamajver)s`` |major version for CUDA
1920
``%(cudashortver)s``|short version for CUDA (``<major>.<minor>``)
2021
``%(cudaver)s`` |full version for CUDA
22+
``%(cudamajver)s`` |major version for CUDAcore
2123
``%(cudashortver)s``|short version for CUDAcore (``<major>.<minor>``)
2224
``%(cudaver)s`` |full version for CUDAcore
25+
``%(javamajver)s`` |major version for Java
2326
``%(javashortver)s``|short version for Java (``<major>.<minor>``)
2427
``%(javaver)s`` |full version for Java
28+
``%(perlmajver)s`` |major version for Perl
2529
``%(perlshortver)s``|short version for Perl (``<major>.<minor>``)
2630
``%(perlver)s`` |full version for Perl
31+
``%(pymajver)s`` |major version for Python
2732
``%(pyshortver)s`` |short version for Python (``<major>.<minor>``)
2833
``%(pyver)s`` |full version for Python
34+
``%(rmajver)s`` |major version for R
2935
``%(rshortver)s`` |short version for R (``<major>.<minor>``)
3036
``%(rver)s`` |full version for R
3137

@@ -59,6 +65,7 @@ Template name |Template value
5965
Template name |Template value
6066
---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------
6167
``%(arch)s`` |System architecture (e.g. x86_64, aarch64, ppc64le, ...)
68+
``%(sysroot)s`` |Location root directory of system, prefix for standard paths like /usr/lib and /usr/includeas specify by the --sysroot configuration option
6269
``%(mpi_cmd_prefix)s`` |Prefix command for running MPI programs (with default number of ranks)
6370
``%(cuda_compute_capabilities)s``|Comma-separated list of CUDA compute capabilities, as specified via --cuda-compute-capabilities configuration option or via cuda_compute_capabilities easyconfig parameter
6471
``%(cuda_cc_cmake)s`` |List of CUDA compute capabilities suitable for use with $CUDAARCHS in CMake 3.18+

docs/version-specific/eb-help.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,26 @@ Option flag |Option description
3737

3838
## Basic options
3939

40-
Option flag |Option description
41-
---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
42-
``--dry-run`` |Print build overview incl. dependencies (full paths) (default: False)
43-
``-D, --dry-run-short`` |Print build overview incl. dependencies (short paths) (default: False)
44-
``-x, --extended-dry-run`` |Print build environment and (expected) build procedure that will be performed (default: False)
45-
``--extended-dry-run-ignore-errors`` |Ignore errors that occur during dry run (default: True; disable with --disable-extended-dry-run-ignore-errors)
46-
``-f, --force`` |Force to rebuild software even if it's already installed (i.e. if it can be found as module), and skipping check for OS dependencies (default: False)
47-
``--ignore-locks`` |Ignore locks that prevent two identical installations running in parallel (default: False)
48-
``--job`` |Submit the build as a job (default: False)
49-
``--locks-dir=LOCKS-DIR`` |Directory to store lock files (should be on a shared filesystem); None implies .locks subdirectory of software installation directory
50-
``-l, --logtostdout`` |Redirect main log to stdout (default: False)
51-
``-M, --missing-modules`` |Print list of missing modules for dependencies of specified easyconfigs (default: False)
52-
``-b BLOCKS, --only-blocks=BLOCKS`` |Only build listed blocks (type comma-separated list)
53-
``--rebuild`` |Rebuild software, even if module already exists (don't skip OS dependencies checks) (default: False)
54-
``-r PATH[:PATH], --robot=PATH[:PATH]``|Enable dependency resolution, using easyconfigs in specified paths (type pathsep-separated list)
55-
``--robot-paths=PATH[:PATH]`` |Additional paths to consider by robot for easyconfigs (--robot paths get priority) (type pathsep-separated list; default: /home/example/work/easybuild-easyconfigs/easybuild/easyconfigs)
56-
``--search-paths=PATH[:PATH]`` |Additional locations to consider in --search (next to --robot and --robot-paths paths) (type pathsep-separated list)
57-
``-k, --skip`` |Skip existing software (useful for installing additional packages) (default: False)
58-
``-s STOP, --stop=STOP`` |Stop the installation after certain step (type choice; default: source) (choices: fetch, ready, source, patch, prepare, configure, build, test, install, extensions, postiter, postproc, sanitycheck, cleanup, module, permissions, package, testcases)
59-
``--strict=STRICT`` |Set strictness level (type choice; default: warn) (choices: ignore, warn, error)
40+
Option flag |Option description
41+
-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
42+
``--dry-run`` |Print build overview incl. dependencies (full paths) (default: False)
43+
``-D, --dry-run-short`` |Print build overview incl. dependencies (short paths) (default: False)
44+
``-x, --extended-dry-run`` |Print build environment and (expected) build procedure that will be performed (default: False)
45+
``--extended-dry-run-ignore-errors`` |Ignore errors that occur during dry run (default: True; disable with --disable-extended-dry-run-ignore-errors)
46+
``-f, --force`` |Force to rebuild software even if it's already installed (i.e. if it can be found as module), and skipping check for OS dependencies (default: False)
47+
``--ignore-locks`` |Ignore locks that prevent two identical installations running in parallel (default: False)
48+
``--job`` |Submit the build as a job (default: False)
49+
``--locks-dir=LOCKS-DIR`` |Directory to store lock files (should be on a shared filesystem); None implies .locks subdirectory of software installation directory
50+
``-l, --logtostdout`` |Redirect main log to stdout (default: False)
51+
``-M, --missing-modules`` |Print list of missing modules for dependencies of specified easyconfigs (default: False)
52+
``-b BLOCKS, --only-blocks=BLOCKS`` |Only build listed blocks (type comma-separated list)
53+
``--rebuild`` |Rebuild software, even if module already exists (don't skip OS dependencies checks) (default: False)
54+
``-r [PATH[:PATH]], --robot=[PATH[:PATH]]``|Enable dependency resolution, optionally consider additional paths to search for easyconfigs (type pathsep-separated list)
55+
``--robot-paths=PATH[:PATH]`` |Additional paths to consider by robot for easyconfigs (--robot paths get priority) (type pathsep-separated list; default: /home/example/work/easybuild-easyconfigs/easybuild/easyconfigs)
56+
``--search-paths=PATH[:PATH]`` |Additional locations to consider in --search (next to --robot and --robot-paths paths) (type pathsep-separated list)
57+
``-k, --skip`` |Skip existing software (useful for installing additional packages) (default: False)
58+
``-s STOP, --stop=STOP`` |Stop the installation after certain step (type choice; default: source) (choices: fetch, ready, source, patch, prepare, configure, build, test, install, extensions, postiter, postproc, sanitycheck, cleanup, module, permissions, package, testcases)
59+
``--strict=STRICT`` |Set strictness level (type choice; default: warn) (choices: ignore, warn, error)
6060

6161
## Configuration options
6262

0 commit comments

Comments
 (0)