changeset 28292:5bf3f462c11e stable

Document that make_absolute_filename and canonicalize_file_name do not perform tilde expansion (bug #58326) * syscalls.cc (Fcanonicalize_file_name): Document that tilde expansion is not performed. Add tilde_expand to @seealso list. * utils.cc (Fmake_absolute_filename): Document that tilde expansion is not performed. Add tilde_expand to @seealso list.
author Philip Nienhuis <prnienhuis@users.sf.net>
date Mon, 11 May 2020 19:18:48 +0200
parents 739f66d9107e
children 7096f672f611
files libinterp/corefcn/syscalls.cc libinterp/corefcn/utils.cc
diffstat 2 files changed, 6 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/syscalls.cc	Sun May 10 20:36:31 2020 +0200
+++ b/libinterp/corefcn/syscalls.cc	Mon May 11 19:18:48 2020 +0200
@@ -1334,8 +1334,9 @@
 @deftypefn {} {[@var{cname}, @var{status}, @var{msg}] =} canonicalize_file_name (@var{fname})
 Return the canonical name of file @var{fname}.
 
-If the file does not exist the empty string ("") is returned.
-@seealso{make_absolute_filename, is_absolute_filename, is_rooted_relative_filename, is_same_file}
+If the file does not exist the empty string ("") is returned.  No tilde
+expansion of @var{fname} is performed.
+@seealso{make_absolute_filename, is_absolute_filename, is_rooted_relative_filename, is_same_file, tilde_expand}
 @end deftypefn */)
 {
   if (args.length () != 1)
--- a/libinterp/corefcn/utils.cc	Sun May 10 20:36:31 2020 +0200
+++ b/libinterp/corefcn/utils.cc	Mon May 11 19:18:48 2020 +0200
@@ -1002,8 +1002,9 @@
 Return the full name of @var{file} beginning from the root of the file
 system.
 
-No check is done for the existence of @var{file}.
-@seealso{canonicalize_file_name, is_absolute_filename, is_rooted_relative_filename, isfolder}
+No check is done for the existence of @var{file}.  No tilde expansion of
+@var{file} is performed.
+@seealso{canonicalize_file_name, is_absolute_filename, is_rooted_relative_filename, isfolder, tilde_expand}
 @end deftypefn */)
 {
   if (args.length () != 1)