Colin Marquardt
df8f44e7a2
doc: fix ref link to Locating Modulefiles section
2020-01-08 23:07:23 -07: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
Colin Marquardt
1485f9da81
doc: fix some typos and grammar across documents
2020-01-08 23:07:23 -07:00
Xavier Delaruelle
3ca365527c
doc: clarify adv vers spec does not support identification context
2020-01-03 18:13:03 +01:00
Xavier Delaruelle
c9904e4b22
New year (2020) copyright mention update
2020-01-02 08:26:12 +01:00
Xavier Delaruelle
526ca5cc82
doc: fix rst bullet lists in design docs
...
Conform to RST docutils standard [1] that express bullet lists and
nested bullet lists should be separated by a blank line before and after
them.
Fixes #306 .
[1] https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#bullet-lists
2019-12-17 05:18:41 +01:00
Xavier Delaruelle
34e9b3784a
doc: add anchor for each module sub-cmd and env var
2019-11-27 17:53:57 +01:00
Xavier Delaruelle
52c2d7cca5
doc: add anchor for each modulefile command
2019-11-27 17:38:58 +01:00
Xavier Delaruelle
9ecd31412f
doc: desc. advanced_version_spec in diff/man
2019-11-16 15:03:49 +01:00
Xavier Delaruelle
a386dbb67c
Introduce home configuration option
...
Make MODULESHOME environment variable controllable through the `config`
sub-command with `home` configuration option. A `--with-moduleshome`
argument is also added to the ./configure script to set specific default
value for this option at installation time.
Fixes #292
2019-11-14 20:22:45 +01:00
Xavier Delaruelle
08bb9e5f68
doc: refine again advanced_version_spec design
2019-11-14 20:22:45 +01:00
Xavier Delaruelle
846aa3b149
doc: desc avail/load corner case for icase design
2019-11-14 20:22:45 +01:00
Xavier Delaruelle
f872fa8c9d
doc: refine advanced_version_spec design
2019-11-14 20:22:45 +01:00
Xavier Delaruelle
c6d6090a97
doc: add advanced-module-version-specifiers design spec
2019-11-14 07:49:54 +01:00
Xavier Delaruelle
c38228aa82
Remove '-' from list of ext dfl separator char
...
Remove the '-' character from the list of extended default separator
characters, as it is not feasible to determine in all cases the highest
version specified after this character (to determine an implicit
default). This removal means that only '.' is taken into account as
extended default separator.
2019-11-11 09:13:50 +01:00
Xavier Delaruelle
24638875f8
doc: refine extended_default design
2019-11-11 09:13:50 +01:00
Xavier Delaruelle
8638d5b5bb
doc: desc extended_default in man/diff/INSTALL
2019-11-11 09:13:50 +01:00
Xavier Delaruelle
ec9ea3df87
doc: desc corner cases in icase design
2019-11-11 09:00:03 +01:00
Xavier Delaruelle
620701fe1f
doc: search sub-cmd is always performed icase
...
Clarify on search sub-command that search query string is always matched
in a case insensitive manner.
2019-11-11 09:00:03 +01:00
Xavier Delaruelle
acf98ba389
doc: desc icase in man/diff/INSTALL
...
Fixes #212
2019-11-11 08:59:52 +01:00
Xavier Delaruelle
2094756d98
doc: fix typo in MODULES_SEARCH_MATCH section of module.1
2019-10-13 10:46:15 +02:00
Xavier Delaruelle
802811b234
doc: add extended-default design spec
2019-10-13 10:46:15 +02:00
Xavier Delaruelle
9eb0ee7f74
doc: add insensitive-case design spec
2019-10-13 10:46:15 +02:00
Xavier Delaruelle
6c07d7d52b
doc: add module-selection-contexts design spec
2019-10-13 10:46:15 +02: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
7cde306cc0
doc: desc wa_277 in man/diff/INSTALL
2019-09-16 20:45:04 +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
Xavier Delaruelle
67722c0796
doc: desc way to find siteconfig script location in recipes
...
In cookbook recipes implying the installation of a site-specific
configuration script, instructions are provided to help to find the
expected location of this script on the current setup.
Fixes #266 .
2019-09-12 06:19:25 +02:00
Xavier Delaruelle
5848939b98
doc: attempt to clarify eval mode in modulefile man
...
Fixes #289
2019-09-06 17:15:55 +02:00
Xavier Delaruelle
efa8883bb8
Honor CLICOLOR/CLICOLOR_FORCE env var to set color mode
...
Add support for standard variables CLICOLOR and CLICOLOR_FORCE to define
color mode. Implement specification for these variables described at
https://bixense.com/clicolors/ .
Fixes #279 .
2019-07-26 08:32:16 +02:00
Xavier Delaruelle
f9329e0264
doc: desc verbosity in man/diff/INSTALL
2019-07-25 17:30:29 +02:00
Xavier Delaruelle
e6b8873b0e
doc: update inhibit-report-info recipe with verbosity cfg
2019-07-23 12:06:52 +02:00
Xavier Delaruelle
ec2225e288
doc: desc init conf alt naming in diff/INSTALL
2019-07-11 06:36:35 +02:00
Xavier Delaruelle
26b7c8e4c4
Set global RC file in @etcdir@ instead @prefix@/etc
...
Fix location of ``etc/rc`` global RC file to ``@etcdir@/rc`` instead of
``@prefix@/etc/rc`` to cope with ``@etcdir@`` specific setup (defaults
to ``@prefix@/etc``).
2019-07-09 06:43:05 +02:00
Colin Marquardt
7863e78b5b
doc: add cookbook recipe for ModulesTest
...
Fixes #182 .
2019-07-07 19:44:18 +02:00
Xavier Delaruelle
df0698a53e
doc: desc set_shell_startup in man/diff/INSTALL
2019-07-04 20:09:22 +02:00
Xavier Delaruelle
b3a8547997
doc: desc search_match in man/diff/INSTALL
2019-07-02 05:39:15 +02:00
Xavier Delaruelle
e5aa32eb2a
Report locked config option value with a locked mention
2019-06-08 08:04:49 +02:00
Xavier Delaruelle
ae2c0045a8
Raise error when setting locked config option
...
Raise an error and exit if module 'config' sub-command attempts to
modify a configuration option which is locked.
2019-06-08 08:04:49 +02:00
Xavier Delaruelle
a665e6b8b4
install: enable implicit_default in locked_configs
...
Makes implicit_default configuration option lockable through
locked_configs option.
2019-06-08 08:04:49 +02:00
Xavier Delaruelle
1a52463b96
install: replaces --enable-extra-siteconfig with --with-locked-configs
...
Add to the configure script the --with-locked-configs option to ignore
environment variable superseding of Modules configurations defined in
modulecmd.tcl script. Lockable configuration option are extra_siteconfig.
Currently locked options are reported through the locked_configs option
on the config sub-command.
This new configure option replces --enable-extra-siteconfig which was
dedicated to the control over the MODULES_SITECONFIG variable.
2019-06-08 08:04:49 +02:00
Xavier Delaruelle
4df560d862
doc: clarify source sub-cmd in module.1 man
...
Talk about scriptfile on `source` sub-command rather modulefile to
clarify a bit usage.
2019-06-03 21:52:27 +02:00
Xavier Delaruelle
89fef8de6c
doc: desc implicit_default in man/diff/INSTALL
2019-06-03 08:14:59 +02:00
Xavier Delaruelle
8fd5d94fb7
doc: update unload-firstly-loaded recipe with unload_match_order cfg
2019-05-26 07:33:07 +02:00
Xavier Delaruelle
410fa99867
doc: desc unload_match_order in man/diff/INSTALL
2019-05-26 07:33:07 +02:00