Skip to content

Commit 72a210f

Browse files
committed
doc: desc stash in collection section of man page
1 parent 96e9264 commit 72a210f

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/source/module.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2577,10 +2577,21 @@ case these collections can only be restored if their suffix correspond to
25772577
the current value of the :envvar:`MODULES_COLLECTION_TARGET` environment
25782578
variable (see the dedicated section of this topic below).
25792579

2580+
Stash collections are created and restored respectively with :subcmd:`stash`
2581+
and :subcmd:`stashpop` sub-commands. When created, current environment state
2582+
is dumped in a collection then environment is :subcmd:`reset` to the defined
2583+
initial state. When restored, environment is updated to match stash collection
2584+
definition, then stash collection file is deleted. Stash collections have same
2585+
format and are saved in the same location than other collections. Collection
2586+
target also applies to stash collection.
2587+
25802588
.. only:: html
25812589

25822590
.. versionadded:: 4.0
25832591

2592+
.. versionchanged:: 5.2
2593+
Stash collection introduced
2594+
25842595

25852596
EXIT STATUS
25862597
-----------

0 commit comments

Comments
 (0)