aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2017-01-10 10:46:57 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2017-01-10 10:46:57 +0200
commit17a6183e8fdc35025483b06d305e4ecb3a6e1021 (patch)
treeb5d69439b89f5292aca840655f7853b6d3bd7e45 /doc
parentca97c1e1527e721cae3a1114864da2110b15406a (diff)
Spec rmdir builtin in testscript doc
Diffstat (limited to 'doc')
-rw-r--r--doc/testscript.cli27
1 files changed, 23 insertions, 4 deletions
diff --git a/doc/testscript.cli b/doc/testscript.cli
index 5929eea..1f6599d 100644
--- a/doc/testscript.cli
+++ b/doc/testscript.cli
@@ -2097,9 +2097,9 @@ opening brace (\c{{}) and for a test \- the first test line.
The Testscript language provides a portable subset of POSIX utilities. Each
utility normally implements the commonly used subset of the corresponding
POSIX specification, though there are deviations (e.g., in option handling)
-and extensions, as described in this chapter. Note also the builtins are
+and extensions, as described in this chapter. Note also that the builtins are
implemented in-process with some of the simple ones (e.g., \c{true/false},
-\c{mkdir}, etc) are being just function calls.
+\c{mkdir}, etc) being just function calls.
\h#builtins-cat|\c{cat}|
@@ -2170,13 +2170,32 @@ is specified.
\li|\n\c{-f}
- Do not fail if path does not exist or no path is specified.||
+ Do not fail if no path is specified, the path does not exist, or is outside
+ the script working directory.||
Note that the implementation deviates from POSIX in a number of ways. It never
interacts with the user and fails immediately if unable to act on an
argument. It does not check for dot containment in the path nor considers
filesystem permissions. In essence, it simply tries to remove the filesystem
-entry. I also always fails if an empty path is specified.
+entry. It also always fails if an empty path is specified.
+
+
+\h#builtins-rmdir|\c{rmdir}|
+
+\
+rmdir [-f] <dir>...
+\
+
+Remove directories. The directory must be empty and not be the test working
+directory or its parent directory. It also must not be outside the script
+working directory unless the \c{-f} option is specified.
+
+\dl|
+
+\li|\n\c{-f}
+
+ Do not fail if no directory is specified, the directory does not exist, or
+ is outside the script working directory.||
\h#builtins-touch|\c{touch}|