envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-05-30 00:12:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: desc. stashlist subcmd in NEWS/man/changes

Browse Source
This commit is contained in:
Xavier Delaruelle
2022-09-29 07:25:49 +02:00
parent 8556a361cb
commit 0b3ceef5ea
3 changed files with 22 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
NEWS.rst
View File

@@ -138,6 +138,7 @@ Modules 5.2.0 (not yet released)
* Add :subcmd:`stashrm` sub-command to delete stash collection file.
* Add :subcmd:`stashshow` sub-command to display stash collection file.
* Add :subcmd:`stashclear` sub-command to delete all stash collection files.
* Add :subcmd:`stashlist` sub-command to list all stash collection files.
.. _Nagelfar: http://nagelfar.sourceforge.net/
.. _ShellCheck: https://www.shellcheck.net/

2
doc/source/changes.rst
View File

@@ -828,7 +828,7 @@ The following module sub-commands appeared on Modules 5.
+------------+-----------------------------------------------------------------+
| 5.2 | :subcmd:`lint`, :subcmd:`mod-to-sh`, :subcmd:`reset`, |
| | :subcmd:`stash`, :subcmd:`stashpop`, :subcmd:`stashrm`, |
| | :subcmd:`stashshow`, :subcmd:`stashclear` |
| | :subcmd:`stashshow`, :subcmd:`stashclear`, :subcmd:`stashlist` |
+------------+-----------------------------------------------------------------+
:subcmd:`list`

29
doc/source/module.rst
View File

@@ -320,8 +320,9 @@ switches are accepted:
.. option:: --json, -j
Display :subcmd:`avail`, :subcmd:`list`, :subcmd:`savelist`, :subcmd:`whatis`
and :subcmd:`search` output in JSON format.
Display :subcmd:`avail`, :subcmd:`list`, :subcmd:`savelist`,
:subcmd:`stashlist`, :subcmd:`whatis` and :subcmd:`search` output in JSON
format.
.. only:: html
@@ -339,8 +340,8 @@ switches are accepted:
.. option:: --long, -l
Display :subcmd:`avail`, :subcmd:`list` and :subcmd:`savelist` output in long
format.
Display :subcmd:`avail`, :subcmd:`list`, :subcmd:`savelist` and
:subcmd:`stashlist` output in long format.
.. option:: --no-auto
@@ -465,8 +466,8 @@ switches are accepted:
.. option:: --terse, -t
Display :subcmd:`avail`, :subcmd:`list` and :subcmd:`savelist` output in
short format.
Display :subcmd:`avail`, :subcmd:`list`, :subcmd:`savelist` and
:subcmd:`stashlist` output in short format.
.. option:: --timer
@@ -1992,6 +1993,16 @@ Module Sub-Commands
.. versionadded:: 5.2
.. subcmd:: stashlist [-t|-l|-j]
List all stash collection files of current :mconfig:`collection_target`. If
no collection target is currently set, list stash collection files without a
target suffix.
.. only:: html
.. versionadded:: 5.2
.. subcmd:: stashpop [stash]
:subcmd:`Restore<restore>` *stash* collection then delete corresponding
@@ -3105,9 +3116,9 @@ ENVIRONMENT
When a target is set, only the collections made for that target are
available to the :subcmd:`restore`, :subcmd:`savelist`, :subcmd:`saveshow`,
:subcmd:`saverm`, :subcmd:`stash`, :subcmd:`stashpop`, :subcmd:`stashshow`,
and :subcmd:`stashrm` sub-commands. Saving a collection registers the target
footprint by suffixing the collection filename with
:subcmd:`saverm`, :subcmd:`stash`, :subcmd:`stashpop`, :subcmd:`stashlist`,
:subcmd:`stashshow`, and :subcmd:`stashrm` sub-commands. Saving a collection
registers the target footprint by suffixing the collection filename with
``.$MODULES_COLLECTION_TARGET``. The collection target is not involved when
collection is specified as file path on the :subcmd:`saveshow`,
:subcmd:`restore` and :subcmd:`save` sub-commands.