add documentation for eb --extended-dry-run #159
Conversation
boegel
changed the title
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Any errors that occur are ignored, and are reported with a clear warning message. | ||
| This is done because it is not unlikely that these errors occur because of the dry run mechanism. |
There was a problem hiding this comment.
double negative is harder to read. Perhaps change to "likely" or "possible" or "probable"
| Extended dry run | ||
| ================ | ||
|
|
||
| Using ``--extended-dry-run`` or ``-x`` (supported since EasyBuild v2.4.0), a detailed overview of the build and install |
There was a problem hiding this comment.
Do we link to the changelog here?
There was a problem hiding this comment.
You mean release notes?
I can, but they still need to be fleshed out for the upcoming v2.4.0.
I can get them started and only include an entry for easybuilders/easybuild-framework#1388 though, so I will, and include a reference here.
|
looks fine, some typos. I think the apply_regex_substitutions is an important feature to highlight, since it will probably become our "best practice" rather than one line patch files... |
|
Good to go now easybuilders/easybuild-framework#1388 is merged in. Thanks for the review @rjeschmi |
add documentation for eb --extended-dry-run
see easybuilders/easybuild-framework#1388
preview available at http://boegel-eb.readthedocs.org/en/extended_dry_run/Extended_dry_run.html
should be fleshed out a bit more, including:
--disable-extended-dry-run-ignore-errorsmodule loadof missing modules (esp. the toolchain module)--extended-dry-run