Commit Graph

793 Commits

Author SHA1 Message Date
Xavier Delaruelle
d9f2db1a2c doc: clarify python initialization example
Update Python initialization example to precise that the init script
should be exec-ed in the global scope. This is important when init
script is executed from a function.

This change helps to clarify a question asked on #483.
2023-04-04 05:26:57 +02:00
Xavier Delaruelle
ce74b7b3af doc: update reduce-io-load recipe with module cache 2022-12-28 16:11:09 +01:00
Xavier Delaruelle
f387664ac4 doc: desc. limited-access & cache in NEWS/man 2022-12-27 19:22:30 +01:00
Xavier Delaruelle
b08839da32 doc: desc. in design notes when cache is not in sync 2022-12-27 18:43:59 +01:00
Xavier Delaruelle
cc1b47ceb3 doc: additional notes on module cache design 2022-12-27 18:43:59 +01:00
Xavier Delaruelle
75d2ce5b42 doc: elaborate limited access in module cache design 2022-12-27 18:43:59 +01:00
Xavier Delaruelle
c547379307 doc: desc cache_expiry_secs in man 2022-12-27 18:43:59 +01:00
Xavier Delaruelle
55417ae899 doc: desc cache_expiry_secs in design/changes 2022-12-27 18:43:59 +01:00
Xavier Delaruelle
b4cf10931c doc: desc cache_buffer_bytes in man 2022-12-27 18:43:58 +01:00
Xavier Delaruelle
3fb26cf1b4 doc: desc cache_buffer_bytes in design/changes 2022-12-27 18:43:58 +01:00
Xavier Delaruelle
a206d0a081 doc: desc ignore_cache/--ignore-cache in man 2022-12-27 18:43:58 +01:00
Xavier Delaruelle
a561adfe8b doc: desc --ignore-cache/ignore_cache in design/changes 2022-12-27 18:43:58 +01:00
Xavier Delaruelle
81b201f315 doc: desc cache in man pages 2022-12-27 18:43:58 +01:00
Xavier Delaruelle
2869bda1bc doc/ts: cache build & use with module header options 2022-12-24 17:24:52 +01:00
Xavier Delaruelle
8a2afa2a36 doc: desc. cacheclear subcmd in NEWS/man/changes 2022-11-28 03:58:56 +01:00
Xavier Delaruelle
c3616b2709 doc: add module-cache design doc 2022-11-28 03:58:56 +01:00
Xavier Delaruelle
6666300f5b doc: desc. cachebuild subcmd in NEWS/man/changes 2022-11-22 04:45:07 +01:00
Xavier Delaruelle
dfa0962aee Release of version 5.2.0 2022-11-08 05:08:06 +01:00
Xavier Delaruelle
03560290d0 doc: extend Collections desc in module man 2022-11-05 19:00: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
980901d75c doc: desc hooks made with rename in module man 2022-11-03 04:54:24 +01:00
Xavier Delaruelle
d247a6a0f4 doc: add Site-specific configuration section in man 2022-11-01 20:30:43 +01:00
Xavier Delaruelle
997d79a8f6 doc: desc. cmds/vars hooks in NEWS 2022-11-01 20:30:43 +01:00
Xavier Delaruelle
d77499651f doc: desc. refresh only modules requiring it 2022-10-31 13:18:58 +01:00
Xavier Delaruelle
7b5d8a4b3e doc: desc. __MODULES_LMREFRESH in NEWS/man/changes 2022-10-31 13:18:58 +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
72a210fc3f doc: desc stash in collection section of man page 2022-10-07 07:24:26 +02:00
Xavier Delaruelle
6b4e111d33 doc: desc. savelist stash filter in design/NEWS/man doc 2022-10-07 06:54:42 +02:00
Xavier Delaruelle
0b3ceef5ea doc: desc. stashlist subcmd in NEWS/man/changes 2022-10-02 14:26:28 +02:00
Xavier Delaruelle
afc051b8ab doc: desc. stashlist in stash-environment design doc 2022-10-02 10:05:28 +02:00
Xavier Delaruelle
6a010c984f doc: desc. stashclear subcmd in NEWS/man/changes 2022-09-29 07:02:38 +02:00
Xavier Delaruelle
5d0281cba9 doc: desc. stashclear in stash-environment design doc 2022-09-29 07:02:38 +02:00
Xavier Delaruelle
4d2bca5b33 doc: desc. stashshow subcmd in NEWS/man/changes 2022-09-29 07:02:38 +02:00
Xavier Delaruelle
f271094ea2 doc: desc. stashshow in stash-environment design doc 2022-09-28 07:21:30 +02:00
Xavier Delaruelle
11d3972eac doc: desc. stashrm subcmd in NEWS/man/changes 2022-09-28 07:21:30 +02:00
Xavier Delaruelle
530c91a1e5 doc: desc. stashrm in stash-environment design doc 2022-09-28 07:20:54 +02:00
Xavier Delaruelle
1e4bf541f6 doc: desc. stashpop subcmd in NEWS/man/changes 2022-09-28 07:20:54 +02:00
Xavier Delaruelle
145462a864 ts/doc: add stashpop test/doc on 'module-info command' 2022-09-28 07:20:54 +02:00
Xavier Delaruelle
104f1d9198 doc: desc. stashpop in stash-environment design doc 2022-09-28 07:20:54 +02:00
Xavier Delaruelle
5fca7f1f31 doc: desc. stash subcmd in NEWS/man/changes 2022-09-28 06:42:59 +02:00
Xavier Delaruelle
ec835353b2 ts/doc: add stash test/doc on 'module-info command' 2022-09-28 06:42:59 +02:00
Xavier Delaruelle
59967b26c3 doc: add stash-environment design doc 2022-09-18 20:41:47 +02:00
Lukáš Zaoral
d018f7a9e6 lint(ShellCheck): fix SC2086 info diagnostic
Some variables, that were unquoted intentionally were converted to arrays.

According to ShellCheck's documentation:

Quoting variables prevents word splitting and glob expansion, and prevents
the script from breaking when input contains spaces, line feeds, glob
characters and such.

Related: https://www.shellcheck.net/wiki/SC2086
Related: #470
2022-09-02 09:52:05 +02:00
Lukáš Zaoral
5939a00154 lint(ShellCheck): fix SC2155 warning
According to ShellCheck's documentation:

In the original code, the return value of mycmd in $(mycmd) is ignored,
and export will instead always return true.  This may prevent conditionals,
set -e and traps from working correctly.

Related: https://www.shellcheck.net/wiki/SC2155
Related: #470
2022-09-02 09:52:05 +02:00
Lukáš Zaoral
7418b3fce0 lint(ShellCheck): fix SC2128 warning
These occurrences do not cause any problems described below but it's better
to be verbose that we indeed want to access the first array element.

According to ShellCheck's documentation:

When referencing arrays, $myarray is equivalent to ${myarray[0]} --
it results in only the first of multiple elements.

Related: https://www.shellcheck.net/wiki/SC2128
Related: #470
2022-09-02 09:52:05 +02:00
Lukáš Zaoral
a45f186200 lint(ShellCheck): fix SC2148 error
According to ShellCheck's documentation:

Different shells support different features.  To give effective advice,
ShellCheck needs to know which shell your script is going to run on.

Related: https://www.shellcheck.net/wiki/SC2148
Related: #470
2022-09-02 09:52:05 +02:00
Xavier Delaruelle
181130d1d6 doc: fix changed/new features dispatch in changes doc 2022-08-25 08:10:01 +02:00
Xavier Delaruelle
59d66a5b7b doc: desc. sticky unload on restore in design notes 2022-08-25 08:10:01 +02:00
Xavier Delaruelle
4badc28143 doc: use bullet list for concise desc. in change doc 2022-08-25 08:10:01 +02:00