aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2017-05-30 15:57:51 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2017-05-30 15:57:51 +0200
commit6ea3d907eb7099afd8798705d4a9a620c82566bc (patch)
tree8bded8c7a8dd98817cbb0dee066a71404123871f /doc
parent4a74374e20d275722067e773d7ea99fc85ca2a0b (diff)
Update testcript cleanup wildcard spec
Diffstat (limited to 'doc')
-rw-r--r--doc/testscript.cli23
1 files changed, 16 insertions, 7 deletions
diff --git a/doc/testscript.cli b/doc/testscript.cli
index 4c585ec..79dcbce 100644
--- a/doc/testscript.cli
+++ b/doc/testscript.cli
@@ -2146,15 +2146,24 @@ the file/directory is removed if it exists. Finally, \c{&!} is a \i{never}
cleanup: it disables a previously registered cleanup for this file/directory
(primarily used to disable automatic cleanups registered by builtins).
-The last component in the path may contain a wildcard with the following
-semantics:
+The path components may contain the \c{*} and \c{?} wildcard characters
+with the following semantics:
\
-dir/* - all immediate files
-dir/*/ - all immediate sub-directories (which must be empty)
-dir/** - all files recursively
-dir/**/ - all sub-directories recursively (which must be empty)
-dir/*** - all files and sub-directories recursively and dir/
+? - any single character
+* - all immediate files
+*/ - all immediate sub-directories (which must be empty)
+** - all files recursively
+**/ - all sub-directories recursively (which must be empty)
+*** - all files and sub-directories recursively as well as the start
+ directory itself
+\
+
+For example, the following cleanup will remove \c{dir/} and its content
+recursively.
+
+\
+$* &dir/***
\
Registering a path for cleanup that is outside the script working directory is