Skip to content

Commit 6b4e111

Browse files
committed
doc: desc. savelist stash filter in design/NEWS/man doc
1 parent b5d6ad8 commit 6b4e111

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

NEWS.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,8 @@ Modules 5.2.0 (not yet released)
139139
* Add :subcmd:`stashshow` sub-command to display stash collection file.
140140
* Add :subcmd:`stashclear` sub-command to delete all stash collection files.
141141
* Add :subcmd:`stashlist` sub-command to list all stash collection files.
142+
* Update :subcmd:`savelist` sub-command to filter out stash collections unless
143+
if :option:`--all` option is set.
142144

143145
.. _Nagelfar: http://nagelfar.sourceforge.net/
144146
.. _ShellCheck: https://www.shellcheck.net/

doc/source/design/stash-environment.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,4 +244,10 @@ Error is obtained and processing stops if:
244244

245245
* stash collection exists but cannot be accessed
246246

247+
savelist sub-command
248+
--------------------
249+
250+
:subcmd:`savelist` sub-command is adapted to filter out stash collections by
251+
default. Stash collections are reported if :option:`--all` option is set.
252+
247253
.. vim:set tabstop=2 shiftwidth=2 expandtab autoindent:

doc/source/module.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1840,6 +1840,10 @@ Module Sub-Commands
18401840
*patterns* are given, collection has to match at least one of them to be
18411841
listed.
18421842

1843+
Stash collections are not listed unless if the :option:`--all`/:option:`-a`
1844+
option is set. Stash collections can be listed with :subcmd:`stashlist`
1845+
sub-command.
1846+
18431847
.. only:: html
18441848

18451849
.. versionadded:: 4.0

0 commit comments

Comments
 (0)