Skip to content

Commit 8df0cd7

Browse files
SebastianAchillesSebastianAchilles
authored
Merge pull request #211 from boegel/eb481
auto-update docs for EasyBuild v4.8.1
2 parents 0f37445 + 4381857 commit 8df0cd7

File tree

7 files changed

+1611
-397
lines changed

7 files changed

+1611
-397
lines changed

‎docs/version-specific/easyblocks.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,9 @@
265265
- EB_PyZMQ
266266
- EB_scipy
267267
- EB_SEPP
268+
- EB_sympy
268269
- EB_TensorFlow
270+
- EB_tensorflow_minus_compression
269271
- EB_TensorRT
270272
- EB_torchvision
271273
- EB_VSC_minus_tools
@@ -379,7 +381,9 @@
379381
- EB_PyZMQ
380382
- EB_scipy
381383
- EB_SEPP
384+
- EB_sympy
382385
- EB_TensorFlow
386+
- EB_tensorflow_minus_compression
383387
- EB_TensorRT
384388
- EB_torchvision
385389
- EB_VSC_minus_tools

‎docs/version-specific/easyconfig-parameters.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@
146146
**Parameter name**|**Description** |**Default value**
147147
------------------|---------------------------------------------------------------------------------------------------------------------------|-----------------
148148
`block` |List of other 'block' sections on which this block depends (only relevant in easyconfigs with subblocks) |`None`
149+
`build_info_msg` |String with information to be printed to stdout and logged during the building of the easyconfig |`None`
149150
`buildstats` |A list of dicts with build statistics |`None`
150151
`deprecated` |String specifying reason why this easyconfig file is deprecated and will be archived in the next major release of EasyBuild|`False`
151152

‎docs/version-specific/eb-help.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Option flag |Option description
3131
## Configfile options
3232

3333
Option flag |Option description
34-
-----------------------------------------|----------------------------------------------------------------------------------------------------------------
35-
``--configfiles=CONFIGFILES`` |Parse (additional) configfiles (type comma-separated list; default: /home/example/.config/easybuild/config.cfg)
34+
-----------------------------------------|----------------------------------------------------------
35+
``--configfiles=CONFIGFILES`` |Parse (additional) configfiles (type comma-separated list)
3636
``--ignoreconfigfiles=IGNORECONFIGFILES``|Ignore configfiles (type comma-separated list)
3737

3838
## Basic options
@@ -298,6 +298,7 @@ Option flag |Option
298298
``--set-gid-bit`` |Set group ID bit on newly created directories (default: False)
299299
``--show-progress-bar`` |Show progress bar in terminal output (default: True; disable with --disable-show-progress-bar)
300300
``--silence-deprecation-warnings=SILENCE-DEPRECATION-WARNINGS`` |Silence specified deprecation warnings out of (python2, Lmod6, easyconfig, toolchain) (type comma-separated list)
301+
``--silence-hook-trigger`` |Suppress printing of debug message every time a hook is triggered (default: False)
301302
``--skip-extensions`` |Skip installation of extensions (default: False)
302303
``-t, --skip-test-cases`` |Skip running test cases (default: False)
303304
``--skip-test-step`` |Skip running the test step (e.g. unit tests) (default: False)

‎docs/version-specific/generic-easyblocks.md‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -278,19 +278,20 @@ Support for configuring with CMake, building and installing with MesonNinja.
278278
### Extra easyconfig parameters specific to ``CMakeNinja`` easyblock
279279

280280
easyconfig parameter |description |default value
281-
--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------
281+
--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------
282282
``abs_path_compilers`` |Specify compilers via absolute file path (not via command names) |``False``
283283
``allow_system_boost`` |Always allow CMake to pick up on Boost installed in OS (even if Boost is included as a dependency) |``False``
284-
``build_cmd`` |Build command to use |``"make"``
284+
``build_cmd`` |Build command to use |``"ninja"``
285285
``build_cmd_targets`` |Target name (string) or list of target names to build |``""``
286+
``build_dir`` |build_dir to pass to meson |``None``
286287
``build_shared_libs`` |Build shared library (instead of static library)None can be used to add no flag (usually results in static library) |``None``
287288
``build_type`` |Build type for CMake, e.g. Release.Defaults to 'Release' or 'Debug' depending on toolchainopts[debug] |``None``
288289
``configure_cmd`` |Configure command to use |``"cmake"``
289290
``configure_cmd_prefix`` |Prefix to be glued before ./configure |``""``
290291
``configure_without_installdir``|Avoid passing an install directory to the configure command (such as via --prefix) |``False``
291292
``generator`` |Build file generator to use. None to use CMakes default |``"Ninja"``
292293
``host_type`` |Value to provide to --host option of configure script, e.g., x86_64-pc-linux-gnu (determined by config.guess shipped with EasyBuild if None, False implies to leave it up to the configure script)|``None``
293-
``install_cmd`` |Install command to use |``"make install"``
294+
``install_cmd`` |Install command to use |``"ninja"``
294295
``install_target_subdir`` |Subdirectory to use as installation target |``None``
295296
``prefix_opt`` |Prefix command line option for configure script ('--prefix=' if None) |``None``
296297
``separate_build_dir`` |Perform build in a separate directory |``True``
@@ -886,7 +887,10 @@ Support for building and installing software with 'meson' and 'ninja'.
886887

887888
easyconfig parameter |description |default value
888889
----------------------|-------------------------------------|-------------
890+
``build_cmd`` |Build command to use |``"ninja"``
891+
``build_dir`` |build_dir to pass to meson |``None``
889892
``configure_cmd`` |Configure command to use |``"meson"``
893+
``install_cmd`` |Install command to use |``"ninja"``
890894
``separate_build_dir``|Perform build in a separate directory|``True``
891895

892896
### Customised steps in ``MesonNinja`` easyblock
@@ -994,6 +998,7 @@ easyconfig parameter |description
994998
``default_component_specs`` |Default specs to use for every component |``{}``
995999
``default_easyblock`` |Default easyblock to use for components |``None``
9961000
``options`` |Dictionary with extension options. |``{}``
1001+
``prefix_opt`` |String to use for option to set installation prefix (default is 'PREFIX') |``None``
9971002
``runtest`` |Run unit tests. |``"test"``
9981003
``sanity_check_all_components``|Enable sanity checks for all components |``False``
9991004
``sanity_check_components`` |List of components for which to run sanity checks |``[]``
@@ -1006,10 +1011,11 @@ Builds and installs a Perl module, and can provide a dedicated module file.
10061011

10071012
### Extra easyconfig parameters specific to ``PerlModule`` easyblock
10081013

1009-
easyconfig parameter|description |default value
1010-
--------------------|----------------------------------|-------------
1011-
``options`` |Dictionary with extension options.|``{}``
1012-
``runtest`` |Run unit tests. |``"test"``
1014+
easyconfig parameter|description |default value
1015+
--------------------|-------------------------------------------------------------------------|-------------
1016+
``options`` |Dictionary with extension options. |``{}``
1017+
``prefix_opt`` |String to use for option to set installation prefix (default is 'PREFIX')|``None``
1018+
``runtest`` |Run unit tests. |``"test"``
10131019

10141020
### Customised steps in ``PerlModule`` easyblock
10151021

0 commit comments

Comments
 (0)