mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-09 13:30:26 +02:00
Code Activity

doc: Add missing canonicalize-path documentation.

Browse source 
The documentation is copied over from libguile/filesys.c. I just added
"(absolute)" to the text to help users finding it, since this term is
more common in other languages.

* doc/ref/posix.texi (File System): Document it.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
This commit is contained in:
Ricardo G. Herdt 2020-05-30 22:50:16 +02:00 • committed by Ludovic Courtès
parent 52809cc630
commit 5fbf5c10fc
1 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
doc/ref/posix.texi
View file

@ -1040,6 +1040,21 @@ If @var{suffix} is provided, and is equal to the end of
@end lisp @end lisp
@end deffn @end deffn
@deffn {Scheme Procedure} canonicalize-path path
@deffnx {C Function} scm_canonicalize_path (path)
Return the canonical (absolute) path of @var{path}.
A canonical path has no @code{.} or @code{..} components,
nor any repeated path separators (@code{/}) nor symlinks.
Raises an error if any component of @var{path} does not
exist.
@lisp
(canonicalize-path "test.xml")
@result{} "/tmp/test.xml"
@end lisp
@end deffn
@deffn {Scheme Procedure} file-exists? filename @deffn {Scheme Procedure} file-exists? filename
Return @code{#t} if the file named @var{filename} exists, @code{#f} if Return @code{#t} if the file named @var{filename} exists, @code{#f} if
not. not.