summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Gran <spk121@yahoo.com>2021-01-21 09:37:49 -0800
committerMichael Gran <spk121@yahoo.com>2021-01-21 10:33:08 -0800
commit32bf48e4b799a36276198a70b8ce48740100634e (patch)
tree57cce95d03d785ff6e9b2b54f115ef851698a69a /doc
parentc67cbc501face03ed0a4d1445e196c3893f0fb3d (diff)
downloadguile-32bf48e4b799a36276198a70b8ce48740100634e.tar.gz
Replace mutating mkdtemp! with non-mutating mkdtemp
* doc/ref/posix.texi: replace mkdtemp! and scm_mkdtemp_x documentation with documentation for mkdtemp and scm_mkdtemp * libguile/filesys.c (scm_mkdtemp_x): procedure mkdtemp! removed (scm_mkdtemp): new procedure mkdtemp * libguile/filesys.h: Remove declaration for scm_mkdtemp_x. New declaration scm_mkdtemp. * test-suite/tests/filesys.test: Remove mkdtemp! tests. Add tests for mkdtemp.
Diffstat (limited to 'doc')
-rw-r--r--doc/ref/posix.texi16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/ref/posix.texi b/doc/ref/posix.texi
index 8ea5baa5c..e78e1510c 100644
--- a/doc/ref/posix.texi
+++ b/doc/ref/posix.texi
@@ -1020,23 +1020,23 @@ The file is automatically deleted when the port is closed
or the program terminates.
@end deffn
-@deffn {Scheme Procedure} mkdtemp! tmpl
-@deffnx {C Function} scm_mkdtemp_x (tmpl)
+@deffn {Scheme Procedure} mkdtemp tmpl
+@deffnx {C Function} scm_mkdtemp (tmpl)
@cindex temporary directory
Create a new directory named in accordance with the template string
@var{tmpl}.
@var{tmpl} is a string specifying the directory's name. The last six
-characters of @var{tmpl} must be @samp{XXXXXX}, characters that will be
-modified to ensure the directory name is unique. Upon successful
-execution, those @samp{X}s will be changed to reflect the name of the
-unique directory created.
+characters of @var{tmpl} must be @samp{XXXXXX}. Upon successful
+execution, the name of the new directory is returned which has the same
+form as @var{tmpl} but with the @samp{XXXXXX} characters modified to
+ensure the directory name is unique.
The permissions of the directory created are OS dependent, but, are
usually @code{#o700}.
-The return value is unspecified. An error may be thrown if the template
-has the wrong format or if the directory cannot be created.
+An error may be thrown if the template has the wrong format or if the
+directory cannot be created.
@end deffn
@deffn {Scheme Procedure} dirname filename