Xavier Delaruelle
c9fabd43d5
doc: fix several broken links
...
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr >
2025-05-08 21:35:44 +02:00
Xavier Delaruelle
5b68d502aa
doc: add "man-path" cookbook recipe
...
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr >
2025-05-03 20:59:32 +02:00
Xavier Delaruelle
40c8958df9
Fix several typos found with codespell
...
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr >
2025-03-05 07:12:20 +01:00
Xavier Delaruelle
fde153fe22
Update repository URL to https://github.com/envmodules/modules
2024-12-13 20:52:13 +01:00
Xavier Delaruelle
3b68dee799
Release of version 5.5.0
2024-11-11 10:03:27 +01:00
Xavier Delaruelle
c75e58a6ce
doc: desc. new log feature in log cookbook
2024-06-13 04:55:13 +02:00
Xavier Delaruelle
e072167ce3
doc: modernize modulefile code examples
...
Modernize and simplify modulefile code examples in documentation:
* Follow coding convention defined for the project
* Use simple "#%Module" file signature, no "1.0" suffix needed
2023-09-02 09:22:49 +02:00
Xavier Delaruelle
2f443deba2
doc: fix duplicate white-spaces in docs
2023-05-30 21:34:28 +02:00
Xavier Delaruelle
ce74b7b3af
doc: update reduce-io-load recipe with module cache
2022-12-28 16:11:09 +01:00
Xavier Delaruelle
30599c6fa4
doc/vim: update tcl.tk links into tcl-lang.org
2022-11-03 05:01:29 +01:00
Xavier Delaruelle
3b1faeb181
Use main as new name for default git branch
2022-10-30 13:26:31 +01:00
Xavier Delaruelle
52fda4787a
doc: fix logging sys on log-module-command recipe
...
Update log-module-command recipe to ensure the logging system is not
broken by the current user environment.
Fixes #475 .
2022-10-14 06:50:37 +02:00
Xavier Delaruelle
925ed5a058
doc: add vim settings at end of cookbook documents
2022-07-30 16:07:28 +02:00
Xavier Delaruelle
85d1e383ad
doc: fix trailing wspace & list ident in tips-for-code-reuse
2022-07-30 16:07:28 +02:00
Xavier Delaruelle
9bff25c2d2
doc: fix log-module-command recipe siteconfig.tcl
...
Fix the siteconfig.tcl file of the log-module-command cookbook recipe
not to break when a file is sourced through cmdModuleSource. Limit the
addition of the 'auto' log field only if load evaluation comes from
cmdModuleLoad procedure.
Fixes #453
2022-04-28 08:55:10 +02:00
Xavier Delaruelle
c0ca0400fa
doc: magic cookie means file signature
...
Update documentation to clarify that the Modules magic cookie
corresponds to a file signature.
2022-03-09 07:08:27 +01:00
Xavier Delaruelle
0bc1f54bdd
doc: fix typos found with Aspell
2022-03-04 06:33:39 +01:00
Xavier Delaruelle
60edac304f
Fix stickiness typos
...
Fixes #442 .
2022-02-18 06:41:25 +01:00
Dimitri Papadopoulos
3bc7b9904d
Fix typos not found by codespell
2022-02-17 20:15:01 +01:00
Dimitri Papadopoulos
e9a6678eec
Fix typos found by codespell
2022-02-15 05:54:03 +01:00
Xavier Delaruelle
bf02e2a39c
doc: fix typos in MIGRATING/changes/reduce-io-load
2022-01-17 06:50:24 +01:00
Xavier Delaruelle
7ae6966f4f
doc: add reduce-io-load cookbook recipe
2022-01-14 07:04:25 +01:00
Xavier Delaruelle
6c6e0764b7
doc: update setenv in top-priority-values recipe config
2021-11-20 18:03:47 +01:00
Xavier Delaruelle
b688be67d8
doc: extend *Log module commands* cookbook
...
Improve the *Log module commands* cookbook to rely on the `trace` Tcl
command to track every modulefile evaluation and module/ml procedure
calls.
Fixes #412 .
2021-09-19 14:32:01 +02:00
Xavier Delaruelle
b668e21e61
doc: apply file rst markup for initrc/modulespath
2021-09-05 16:05:57 +02:00
Xavier Delaruelle
919662c3c2
doc: desc setup with shell-specific scripts in cookbook
...
Update the *Source script in modulefile* cookbook recipe to add it a
*Usage with shell-specific scripts* section that demonstrate how to use
modulefiles with `source-sh` commands when software provide a specific
initialization script for each shell it supports.
Take this opportunity to improve the readability of this recipe by
coloring/highlighting shell session examples.
Fixes #399 .
2021-05-30 15:16:33 +02:00
Xavier Delaruelle
777fc4adf2
doc: add *sticky modules* cookbook recipe
2021-04-05 22:31:54 +02:00
Xavier Delaruelle
8d83c7349f
doc: fix hide-and-forbid-modules document ref
2021-04-05 22:31:54 +02:00
Xavier Delaruelle
b9b43e354d
doc: markup config/subcmd/mfcmd in cookbook/design
2021-01-07 07:18:23 +01:00
Xavier Delaruelle
778dac700a
doc: add hidden-loaded example on hide/forbid recipe
2020-12-18 18:59:11 +01:00
Xavier Delaruelle
d73b22fef8
doc: fix code-block syntax issue in hide-and-forbid-modules
...
An argument value was missing for a code-block in the
hide-and-forbid-modules cookbook recipe. Set value to none, as this
block cannot be highlighted as Tcl code.
2020-12-05 17:34:59 +01:00
Xavier Delaruelle
c3432ac87f
doc: fix missing space in test-modulefiles rcp
...
Thanks to Aurélien Degrémont for spotting this issue.
2020-11-17 10:09:37 +01:00
Colin Marquardt
e22aaa98f9
doc: add proper ReST references in test-modulefiles rcp
2020-11-17 06:34:48 +01:00
Xavier Delaruelle
4f99282692
doc: update new-features-without-breaking-old-module recipe
...
Describe use of new ModuleTool and ModuleToolVersion Tcl variables as
well as versioncmp modulefile command.
2020-11-15 10:03:31 +01:00
Xavier Delaruelle
d44a4b7f51
doc: add 'hide-and-forbid-modules' cookbook recipe
2020-11-14 15:23:09 +01:00
Xavier Delaruelle
20405b7b83
doc: add 'new-features-without-breaking-old-module' recipe
2020-10-01 21:14:27 +02:00
Xavier Delaruelle
5c85dbf627
doc: use versioned magic cookie in recent examples
...
Fixes #349 .
2020-07-24 22:10:25 +02:00
Xavier Delaruelle
44c9147ee8
Apply inclusive terminology in code and docs
...
Use inclusive terminology [1] to eliminate 'master' and 'slave' terms as
much as possible from code and documentation. 'master' has been changed
into 'main' and 'slave' into 'subordinate' or 'sub'.
After this change, some references to the 'master' and 'slave' word can
still be found in repository:
* `slaves` sub-command of `interp` Tcl command
* `--slave` option of `update-alternatives tool in RPM spec file
* `master_doc` attribute of Sphinx `conf.py` file
* git 'master' branch need to be renamed and tools referring it need to
be updated accordingly (configure, script/mpub, script/mrel)
[1] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=49decddd39e5f6132ccd7d9fdc3d7c470b0061bb
2020-07-16 21:31:30 +02:00
Xavier Delaruelle
d15b7c6494
doc: add source-script-in-modulefile recipe
2020-06-01 21:03:12 +02:00
Xavier Delaruelle
755841fae5
doc: clarify some statements in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
c8ff0cedcb
doc: add refs between sections in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
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
267f68a969
doc: simplify reading of compiler-etc-depend recipe (code)
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
aa8feb115b
doc: adopt neutral tone compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
529bca1bbf
doc: add ref to ext tools mentionned in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
d3e29f4fa9
doc: normalize rst section/link syntax in compiler-etc-depend recipe
2020-02-21 22:41:46 +01:00
Xavier Delaruelle
cc276e4e15
doc: fix typos in 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