Skip to content

Commit

Permalink
Merge pull request #211 from boegel/eb481
Browse files Browse the repository at this point in the history 
auto-update docs for EasyBuild v4.8.1
  • Loading branch information
@SebastianAchilles
SebastianAchilles authored Sep 11, 2023
2 parents 0f37445 + 4381857 commit 8df0cd7
Show file tree
Hide file tree
Showing 7 changed files with 1,611 additions and 397 deletions.
4 changes: 4 additions & 0 deletions docs/version-specific/easyblocks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,9 @@
- EB_PyZMQ
- EB_scipy
- EB_SEPP
- EB_sympy
- EB_TensorFlow
- EB_tensorflow_minus_compression
- EB_TensorRT
- EB_torchvision
- EB_VSC_minus_tools
Expand Down Expand Up @@ -379,7 +381,9 @@
- EB_PyZMQ
- EB_scipy
- EB_SEPP
- EB_sympy
- EB_TensorFlow
- EB_tensorflow_minus_compression
- EB_TensorRT
- EB_torchvision
- EB_VSC_minus_tools
Expand Down
1 change: 1 addition & 0 deletions docs/version-specific/easyconfig-parameters.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@
**Parameter name**|**Description** |**Default value**
------------------|---------------------------------------------------------------------------------------------------------------------------|-----------------
`block` |List of other 'block' sections on which this block depends (only relevant in easyconfigs with subblocks) |`None`
`build_info_msg` |String with information to be printed to stdout and logged during the building of the easyconfig |`None`
`buildstats` |A list of dicts with build statistics |`None`
`deprecated` |String specifying reason why this easyconfig file is deprecated and will be archived in the next major release of EasyBuild|`False`

Expand Down
5 changes: 3 additions & 2 deletions docs/version-specific/eb-help.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Option flag |Option description
## Configfile options

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

## Basic options
Expand Down Expand Up @@ -298,6 +298,7 @@ Option flag |Option
``--set-gid-bit`` |Set group ID bit on newly created directories (default: False)
``--show-progress-bar`` |Show progress bar in terminal output (default: True; disable with --disable-show-progress-bar)
``--silence-deprecation-warnings=SILENCE-DEPRECATION-WARNINGS`` |Silence specified deprecation warnings out of (python2, Lmod6, easyconfig, toolchain) (type comma-separated list)
``--silence-hook-trigger`` |Suppress printing of debug message every time a hook is triggered (default: False)
``--skip-extensions`` |Skip installation of extensions (default: False)
``-t, --skip-test-cases`` |Skip running test cases (default: False)
``--skip-test-step`` |Skip running the test step (e.g. unit tests) (default: False)
Expand Down
20 changes: 13 additions & 7 deletions docs/version-specific/generic-easyblocks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -278,19 +278,20 @@ Support for configuring with CMake, building and installing with MesonNinja.
### Extra easyconfig parameters specific to ``CMakeNinja`` easyblock

easyconfig parameter |description |default value
--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------
--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------
``abs_path_compilers`` |Specify compilers via absolute file path (not via command names) |``False``
``allow_system_boost`` |Always allow CMake to pick up on Boost installed in OS (even if Boost is included as a dependency) |``False``
``build_cmd`` |Build command to use |``"make"``
``build_cmd`` |Build command to use |``"ninja"``
``build_cmd_targets`` |Target name (string) or list of target names to build |``""``
``build_dir`` |build_dir to pass to meson |``None``
``build_shared_libs`` |Build shared library (instead of static library)None can be used to add no flag (usually results in static library) |``None``
``build_type`` |Build type for CMake, e.g. Release.Defaults to 'Release' or 'Debug' depending on toolchainopts[debug] |``None``
``configure_cmd`` |Configure command to use |``"cmake"``
``configure_cmd_prefix`` |Prefix to be glued before ./configure |``""``
``configure_without_installdir``|Avoid passing an install directory to the configure command (such as via --prefix) |``False``
``generator`` |Build file generator to use. None to use CMakes default |``"Ninja"``
``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``
``install_cmd`` |Install command to use |``"make install"``
``install_cmd`` |Install command to use |``"ninja"``
``install_target_subdir`` |Subdirectory to use as installation target |``None``
``prefix_opt`` |Prefix command line option for configure script ('--prefix=' if None) |``None``
``separate_build_dir`` |Perform build in a separate directory |``True``
Expand Down Expand Up @@ -886,7 +887,10 @@ Support for building and installing software with 'meson' and 'ninja'.

easyconfig parameter |description |default value
----------------------|-------------------------------------|-------------
``build_cmd`` |Build command to use |``"ninja"``
``build_dir`` |build_dir to pass to meson |``None``
``configure_cmd`` |Configure command to use |``"meson"``
``install_cmd`` |Install command to use |``"ninja"``
``separate_build_dir``|Perform build in a separate directory|``True``

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

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

easyconfig parameter|description |default value
--------------------|----------------------------------|-------------
``options`` |Dictionary with extension options.|``{}``
``runtest`` |Run unit tests. |``"test"``
easyconfig parameter|description |default value
--------------------|-------------------------------------------------------------------------|-------------
``options`` |Dictionary with extension options. |``{}``
``prefix_opt`` |String to use for option to set installation prefix (default is 'PREFIX')|``None``
``runtest`` |Run unit tests. |``"test"``

### Customised steps in ``PerlModule`` easyblock

Expand Down
Loading

0 comments on commit 8df0cd7

Please sign in to comment.