summaryrefslogtreecommitdiffstats
path: root/txr.1
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2016-05-23 18:37:09 -0700
committerKaz Kylheku <kaz@kylheku.com>2016-05-23 18:37:09 -0700
commit009d16bee2ae23593c11c47db1af385e70f3a700 (patch)
treef02f261e199aa0255c31c129dbcead907e30857c /txr.1
parent2973674d118749fb7724fff6b6cc640c9e3b145e (diff)
downloadtxr-009d16bee2ae23593c11c47db1af385e70f3a700.tar.gz
txr-009d16bee2ae23593c11c47db1af385e70f3a700.tar.bz2
txr-009d16bee2ae23593c11c47db1af385e70f3a700.zip
Optional argument on remove-path.
* stream.c (remove_path): New parameter, throw_on_error. (stream_init): Update registratino of remove_path intrinsic. * stream.h (remove_path): Declaration updated. * txr.1: Updated remove-path documentation to describe throw-on-error-p parameter.
Diffstat (limited to 'txr.1')
-rw-r--r--txr.111
1 files changed, 9 insertions, 2 deletions
diff --git a/txr.1 b/txr.1
index 89f8d115..b7fa864c 100644
--- a/txr.1
+++ b/txr.1
@@ -36407,7 +36407,7 @@ an exception will be thrown.
.coNP Function @ remove-path
.synb
-.mets (remove-path << path )
+.mets (remove-path < path <> [ throw-on-error-p ])
.syne
.desc
The
@@ -36421,7 +36421,14 @@ If successful, it returns
.codn t .
A failure to remove the object results in an exception of type
-.codn file-error .
+.codn file-error ,
+unless
+.meta throw-on-error-p
+is present, and its value is
+.codn nil .
+In that case, failure is indicated by a
+.code nil
+return value.
.coNP Function @ rename-path
.synb