From 830e2ca5a76db1d5f13b2c8bcb3e33006c50317c Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Wed, 2 Sep 2020 06:57:01 +0200 Subject: [PATCH] doc: desc. debug2 verbosity mode in diff/man/NEWS/INSTALL --- INSTALL.rst | 3 ++- NEWS.rst | 9 ++++----- doc/source/diff_v3_v4.rst | 2 ++ doc/source/module.rst | 7 ++++--- 4 files changed, 12 insertions(+), 9 deletions(-) diff --git a/INSTALL.rst b/INSTALL.rst index e8d6741a..46753240 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -352,7 +352,8 @@ instance ``--without-modulepath``): --with-verbosity=VALUE Specify default message verbosity. accepted values are ``silent``, ``concise``, ``normal``, ``verbose``, - ``debug`` and ``trace``. (default=\ ``normal``) + ``debug``, ``debug2`` and ``trace``. + (default=\ ``normal``) --with-dark-background-colors=SGRLIST Default color set to apply if terminal background color is defined to ``dark``. SGRLIST follows the same syntax diff --git a/NEWS.rst b/NEWS.rst index d5734792..230a7607 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -21,11 +21,6 @@ Modules 4.6.0 (not yet released) aliases, shell functions and current working directory are tracked. The following shells are supported: sh, dash, csh, tcsh, bash, ksh, ksh93, zsh and fish. -* Add the ``trace`` verbosity level, to report each call of - :file:`modulecmd.tcl` internal procedures in addition to debug messages. - Trace mode can be enabled by setting the ``verbosity`` config to the - ``trace`` value or by using the :option:`-T`/:option:`--trace` command-line - switches. * Doc: add *Source shell script in modulefile* design notes. * Introduce the :mfcmd:`source-sh` modulefile command, to evaluate shell script and apply resulting environment changes through modulefile commands. @@ -137,6 +132,10 @@ Modules 4.6.0 (not yet released) * Add ``--nearly-message`` option to :mfcmd:`module-forbid` modulefile command to supplement the warning message obtained when evaluating a nearly forbidden module. +* Add the ``debug2`` verbosity level, to report each call of + :file:`modulecmd.tcl` internal procedures in addition to debug messages. + Debug2 mode can be enabled by setting the ``verbosity`` config to the + ``debug2`` value or by using the :option:`-D` command-line switch twice. Modules 4.5.3 (2020-08-31) diff --git a/doc/source/diff_v3_v4.rst b/doc/source/diff_v3_v4.rst index 9e42cf56..6eab5777 100644 --- a/doc/source/diff_v3_v4.rst +++ b/doc/source/diff_v3_v4.rst @@ -320,6 +320,8 @@ Command line switches :option:`--all`, :option:`-a` +:option:`-DD` + These command line switches appeared on version ``4.6`` and are not supported on compatibility version. diff --git a/doc/source/module.rst b/doc/source/module.rst index cdba70ea..1b0db34c 100644 --- a/doc/source/module.rst +++ b/doc/source/module.rst @@ -184,10 +184,11 @@ switches are accepted: .. versionadded:: 4.3 -.. option:: --debug, -D +.. option:: --debug, -D, -DD Debug mode. Causes :command:`module` to print debugging messages about its - progress. + progress. Multiple :option:`-D` options increase the debug verbosity. The + maximum is 2. .. only:: html @@ -1655,7 +1656,7 @@ ENVIRONMENT * ``verbose``: add additional informational messages, like a systematic report of the loading or unloading module evaluations. * ``debug``: print debugging messages about module command execution. - * ``trace``: trace :file:`modulecmd.tcl` procedure calls in addition to + * ``debug2``: report :file:`modulecmd.tcl` procedure calls in addition to printing debug messages. Module command verbosity is defined in the following order of preference: