Commit Graph

22 Commits

Author SHA1 Message Date
Xavier Delaruelle
46332f0237 doc: refer to more generic vers name in compiler-etc-depend recipe 2020-02-21 22:41:46 +01:00
Xavier Delaruelle
2c7be3d319 doc: improve console output reading of compiler-etc-depend recipe 2020-02-21 22:41:46 +01:00
Xavier Delaruelle
410bd79d5e doc: normalize code of modulefile of compiler-etc-depend recipe
And include these modulefile examples as Tcl code in recipe document to
get their content highlighted.
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
996c1ddc21 doc: normalize code of Tcl lib of compiler-etc-depend recipe
Add authorship information, same header and comment structure for all
Tcl files to include these files in cookbook recipe document with Tcl
syntax highlight.
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
f046cd833c doc: simplify reading of compiler-etc-depend recipe (trailing space) 2020-02-21 22:41:46 +01:00
Xavier Delaruelle
e451b7754c doc: simplify reading of compiler-etc-depend recipe (dummy) 2020-02-21 22:41:46 +01:00
Tom Payerle
f2272eb917 doc: add compiler-etc-dependencies cookbook recipe
New cookbook discussing various strategies for creating modulefiles for
packages with multiple builds depending on previously loaded compiler,
MPI libraries etc. (E.g. handling different "flavors" of packages)
2020-02-21 22:41:46 +01:00
Colin Marquardt
9b2cad1d7d doc: highlight code included in cookbook recipes
Specify language directive for included Tcl script files in cookbook
recipes to get their code highlighted in resulting HTML documents. As
Pygment Tcl lexer used by Sphinx does not support the whole Tcl syntax,
scripts of modulepaths-persist-over-sudo and test-modulefiles recipes
have been adapted to enable highlighting. Change has not been performed
over the expose-procs-vars-to-modulefiles and top-priority-values
recipes as their code cannot be adapted to match lexer needs.
2020-01-08 23:07:23 -07:00
Xavier Delaruelle
4466e4a996 doc: add sc19 demo 2019-11-21 06:32:37 -07:00
Xavier Delaruelle
5ee94baa05 doc: adapt ensure-user-qualify-modules recipe to config rework 2019-10-13 10:46:08 +02:00
Xavier Delaruelle
06c6e63faa doc: add module-info-name-return-basename recipe
Fixes #297.
2019-10-13 10:42:47 +02:00
Tom Payerle
0b6f21481c doc: Adding cookbook page "tips-for-code-reuse" 2019-09-17 08:01:27 +02:00
Xavier Delaruelle
79d8f0ab9b doc: add ensure-user-qualify-modules recipe to cookbook 2019-09-14 18:53:35 +02:00
Xavier Delaruelle
3d75225cae doc: add modulepaths-persist-over-sudo recipe to cookbook
Rework global RC file proposed in contrib/etc/rc-modulepath, for use
case described at [1], as a cookbook recipe.

[1] https://bugzilla.redhat.com/show_bug.cgi?id=1139165
2019-09-14 10:48:15 +02:00
Xavier Delaruelle
5eff0bc163 doc: add expose-procs-vars-to-modulefiles recipe to cookbook 2019-09-13 19:09:41 +02:00
Xavier Delaruelle
778aeecf26 doc: add log-module-commands recipe to cookbook
Fixes #283.
2019-09-12 21:21:44 +02:00
Colin Marquardt
7863e78b5b doc: add cookbook recipe for ModulesTest
Fixes #182.
2019-07-07 19:44:18 +02:00
Xavier Delaruelle
846f95108f Report auto mech warn/err to top level message block
During an additional evaluation triggered by an automated module
handling mechanism, ensure warning and error messages are reported under
the message block of the main evaluation.

Add a 'recordtop' argument to the reportWarning and reportError
procedures in order to indicate that the message should be recorded
under the top-level message block instead of the currently active
message block.

Fixes #252.
2019-04-21 19:11:34 +02:00
Xavier Delaruelle
9f638b8118 doc: add example modulefiles for 'flavored-modules' recipe 2019-03-16 15:31:35 +01:00
Xavier Delaruelle
4e432320e5 doc: mention author of modulefiles-in-git examples 2019-02-25 10:54:32 +01:00
Scott Johnson
ac0a3f7bb5 New cookbook entry for versioning Modulefiles with Git
Originally developed at:
https://github.com/scottj97/environment-modules-in-git
2019-02-25 10:54:32 +01:00
Xavier Delaruelle
8c9df050f9 doc: introduce cookbook
Add a cookbook section in the documentation and port there the 3
pre-existing recipes: inhibit-report-info, top-priority-values and
unload-firstly-loaded.

Move the examples files of these recipes from contrib/cookbook to
doc/example directory.
2018-11-19 04:02:06 +01:00