Skip to content

Commit 5efb7ca

Browse files
bedrogebedroge
authored
Merge pull request #248 from boegel/eb491_auto_update_docs
2 parents 54bc1e7 + 654298a commit 5efb7ca

File tree

6 files changed

+2116
-713
lines changed

6 files changed

+2116
-713
lines changed

‎docs/version-specific/easyblocks.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
- ConfigureMake
6161
- CMakeMake
6262
- CMakeMakeCp
63+
- EB_DualSPHysics
6364
- CMakeNinja
6465
- CMakePythonPackage
6566
- EB_DOLFIN
@@ -191,6 +192,7 @@
191192
- EB_XCrySDen
192193
- MakeCp
193194
- CMakeMakeCp
195+
- EB_DualSPHysics
194196
- CmdCp
195197
- EB_fastStructure
196198
- EB_BamTools

‎docs/version-specific/easyconfig-license-constants.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ License name |License description
77
``GPLv2`` |The GNU General Public License is a free, copyleft license for software and other kinds of works. |``2``
88
``GPLv3`` |The GNU General Public License is a free, copyleft license for software and other kinds of works. |``3``
99
``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``
10-
``Unknown`` |None |``None``
11-
``VeryRestrictive``|None |``None``
10+
``Unknown`` | |``None``
11+
``VeryRestrictive``| |``None``
1212

1313
*(see also* ``eb --avail-easyconfig-licenses`` *)*

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@
118118

119119
**Parameter name** |**Description** |**Default value**
120120
----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------
121+
`allow_append_abs_path` |Allow specifying absolute paths to append in modextrapaths_append |`False`
121122
`allow_prepend_abs_path` |Allow specifying absolute paths to prepend in modextrapaths |`False`
122123
`citing` |Free-form text that describes how the software should be cited in publications |`None`
123124
`docpaths` |List of paths for documentation relative to installation directory |`None`
@@ -126,6 +127,7 @@
126127
`modaliases` |Aliases to be defined in module file |`{}`
127128
`modaltsoftname` |Module name to use (rather than using software name |`None`
128129
`modextrapaths` |Extra paths to be prepended in module file |`{}`
130+
`modextrapaths_append` |Extra paths to be appended in module file |`{}`
129131
`modextravars` |Extra environment variables to be added to module file |`{}`
130132
`modloadmsg` |Message that should be printed when generated module is loaded |`{}`
131133
`modluafooter` |Footer to include in generated module file (Lua syntax) |`""`

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,10 +139,12 @@ Option flag |Option description
139139
``--close-pr-msg=CLOSE-PR-MSG`` |Custom close message for pull request closed with --close-pr; (type <class 'str'>)
140140
``--close-pr-reasons=CLOSE-PR-REASONS`` |Close reason for pull request closed with --close-pr; supported values: archived, inactive, obsolete, retest (type <class 'str'>)
141141
``--dump-test-report=DUMP-TEST-REPORT`` |Dump test report to specified path (default: test_report.md)
142+
``--from-commit=commit_SHA`` |Obtain easyconfigs from specified commit (type str)
142143
``--from-pr=PR#`` |Obtain easyconfigs from specified PR (type comma-separated list)
143144
``--git-working-dirs-path=GIT-WORKING-DIRS-PATH`` |Path to Git working directories for EasyBuild repositories (type <class 'str'>)
144145
``--github-org=GITHUB-ORG`` |GitHub organization (type <class 'str'>)
145146
``--github-user=GITHUB-USER`` |GitHub username (type <class 'str'>)
147+
``--include-easyblocks-from-commit=commit_SHA`` |Include easyblocks from specified commit (type str)
146148
``--include-easyblocks-from-pr=PR#`` |Include easyblocks from specified PR (type comma-separated list)
147149
``--install-github-token`` |Install GitHub token (requires --github-user) (default: False)
148150
``--list-prs=STATE,ORDER,DIRECTION`` |List pull requests (type <class 'str'>; default: open,created,desc)
@@ -225,7 +227,7 @@ Option flag |Option
225227
``--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)
226228
``--allow-modules-tool-mismatch`` |Allow mismatch of modules tool and definition of 'module' function (default: False)
227229
``--allow-use-as-root-and-accept-consequences`` |Allow using of EasyBuild as root (NOT RECOMMENDED!) (default: False)
228-
``--backup-modules`` |Back up an existing module file, if any. Only works when using --module-only
230+
``--backup-modules`` |Back up an existing module file, if any. Auto-enabled when using --module-only or --skip
229231
``--backup-patched-files`` |Create a backup (*.orig) file when applying a patch (default: False)
230232
``--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)
231233
``--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)

0 commit comments

Comments
 (0)