Skip to content

auto-update docs for EasyBuild v4.9.1 #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2024
Merged

auto-update docs for EasyBuild v4.9.1 #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/version-specific/easyblocks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
- ConfigureMake
- CMakeMake
- CMakeMakeCp
- EB_DualSPHysics
- CMakeNinja
- CMakePythonPackage
- EB_DOLFIN
Expand Down Expand Up @@ -191,6 +192,7 @@
- EB_XCrySDen
- MakeCp
- CMakeMakeCp
- EB_DualSPHysics
- CmdCp
- EB_fastStructure
- EB_BamTools
Expand Down
4 changes: 2 additions & 2 deletions docs/version-specific/easyconfig-license-constants.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ License name |License description
``GPLv2`` |The GNU General Public License is a free, copyleft license for software and other kinds of works. |``2``
``GPLv3`` |The GNU General Public License is a free, copyleft license for software and other kinds of works. |``3``
``Libpng`` |Permission is granted to use, copy, modify, and distribute the source code, or portions hereof, for any purpose, without fee, subject to 3 restrictions; http://libpng.org/pub/png/src/libpng-LICENSE.txt for full license |``None``
``Unknown`` |None |``None``
``VeryRestrictive``|None |``None``
``Unknown`` | |``None``
``VeryRestrictive``| |``None``

*(see also* ``eb --avail-easyconfig-licenses`` *)*
2 changes: 2 additions & 0 deletions docs/version-specific/easyconfig-parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@

**Parameter name** |**Description** |**Default value**
----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------
`allow_append_abs_path` |Allow specifying absolute paths to append in modextrapaths_append |`False`
`allow_prepend_abs_path` |Allow specifying absolute paths to prepend in modextrapaths |`False`
`citing` |Free-form text that describes how the software should be cited in publications |`None`
`docpaths` |List of paths for documentation relative to installation directory |`None`
Expand All @@ -126,6 +127,7 @@
`modaliases` |Aliases to be defined in module file |`{}`
`modaltsoftname` |Module name to use (rather than using software name |`None`
`modextrapaths` |Extra paths to be prepended in module file |`{}`
`modextrapaths_append` |Extra paths to be appended in module file |`{}`
`modextravars` |Extra environment variables to be added to module file |`{}`
`modloadmsg` |Message that should be printed when generated module is loaded |`{}`
`modluafooter` |Footer to include in generated module file (Lua syntax) |`""`
Expand Down
4 changes: 3 additions & 1 deletion docs/version-specific/eb-help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,12 @@ Option flag |Option description
``--close-pr-msg=CLOSE-PR-MSG`` |Custom close message for pull request closed with --close-pr; (type <class 'str'>)
``--close-pr-reasons=CLOSE-PR-REASONS`` |Close reason for pull request closed with --close-pr; supported values: archived, inactive, obsolete, retest (type <class 'str'>)
``--dump-test-report=DUMP-TEST-REPORT`` |Dump test report to specified path (default: test_report.md)
``--from-commit=commit_SHA`` |Obtain easyconfigs from specified commit (type str)
``--from-pr=PR#`` |Obtain easyconfigs from specified PR (type comma-separated list)
``--git-working-dirs-path=GIT-WORKING-DIRS-PATH`` |Path to Git working directories for EasyBuild repositories (type <class 'str'>)
``--github-org=GITHUB-ORG`` |GitHub organization (type <class 'str'>)
``--github-user=GITHUB-USER`` |GitHub username (type <class 'str'>)
``--include-easyblocks-from-commit=commit_SHA`` |Include easyblocks from specified commit (type str)
``--include-easyblocks-from-pr=PR#`` |Include easyblocks from specified PR (type comma-separated list)
``--install-github-token`` |Install GitHub token (requires --github-user) (default: False)
``--list-prs=STATE,ORDER,DIRECTION`` |List pull requests (type <class 'str'>; default: open,created,desc)
Expand Down Expand Up @@ -225,7 +227,7 @@ Option flag |Option
``--allow-loaded-modules=ALLOW-LOADED-MODULES`` |List of software names for which to allow loaded modules in initial environment (type comma-separated list; default: EasyBuild)
``--allow-modules-tool-mismatch`` |Allow mismatch of modules tool and definition of 'module' function (default: False)
``--allow-use-as-root-and-accept-consequences`` |Allow using of EasyBuild as root (NOT RECOMMENDED!) (default: False)
``--backup-modules`` |Back up an existing module file, if any. Only works when using --module-only
``--backup-modules`` |Back up an existing module file, if any. Auto-enabled when using --module-only or --skip
``--backup-patched-files`` |Create a backup (*.orig) file when applying a patch (default: False)
``--banned-linked-shared-libs=BANNED-LINKED-SHARED-LIBS`` |Comma-separated list of shared libraries (names, file names, or paths) which are not allowed to be linked in any installed binary/library (type comma-separated list)
``--check-ebroot-env-vars=CHECK-EBROOT-ENV-VARS`` |Action to take when defined $EBROOT* environment variables are found for which there is no matching loaded module; supported values: error, ignore, unset, warn (default: warn)
Expand Down
Loading