changeset 18074:1e27079409bf

Rename function dir_in_path to dir_in_loadpath. * NEWS: Announce new function in 4.2. * scripts/deprecated/find_dir_in_path.m: Call dir_in_loadpath as replacement. * utils.cc (Fdir_in_loadpath): Renamed dir_in_path to dir_in_loadpath. * help.m, what.m, rundemos.m, runtests.m: Chane instances of dir_in_path to dir_in_loadpath. * utils.cc, variables.cc: Change seealso links to point to dir_in_loadpath. * func.txi: Document dir_in_loadpath function.
author Rik <rik@octave.org>
date Wed, 04 Dec 2013 08:23:42 -0800
parents b4b5ee91561a
children 42e6cdc76f4b
files NEWS doc/interpreter/func.txi libinterp/corefcn/utils.cc libinterp/corefcn/variables.cc scripts/deprecated/find_dir_in_path.m scripts/help/help.m scripts/miscellaneous/what.m scripts/testfun/rundemos.m scripts/testfun/runtests.m
diffstat 9 files changed, 19 insertions(+), 19 deletions(-) [+]
line wrap: on
line diff
--- a/NEWS	Tue Dec 03 20:39:07 2013 -0800
+++ b/NEWS	Wed Dec 04 08:23:42 2013 -0800
@@ -3,7 +3,7 @@
 
  ** Other new functions added in 4.2:
 
-      dir_in_path
+      dir_in_loadpath
 
  ** Deprecated functions.
 
--- a/doc/interpreter/func.txi	Tue Dec 03 20:39:07 2013 -0800
+++ b/doc/interpreter/func.txi	Wed Dec 04 08:23:42 2013 -0800
@@ -802,7 +802,7 @@
 
 @DOCSTRING(command_line_path)
 
-@DOCSTRING(dir_in_path)
+@DOCSTRING(dir_in_loadpath)
 
 @node Subfunctions
 @subsection Subfunctions
--- a/libinterp/corefcn/utils.cc	Tue Dec 03 20:39:07 2013 -0800
+++ b/libinterp/corefcn/utils.cc	Wed Dec 04 08:23:42 2013 -0800
@@ -303,7 +303,7 @@
 If the second optional argument @qcode{\"all\"} is supplied, return\n\
 a cell array containing the list of all files that have the same\n\
 name in the path.  If no files are found, return an empty cell array.\n\
-@seealso{file_in_path, dir_in_path, path}\n\
+@seealso{file_in_path, dir_in_loadpath, path}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -380,7 +380,7 @@
 If the third optional argument @qcode{\"all\"} is supplied, return\n\
 a cell array containing the list of all files that have the same\n\
 name in the path.  If no files are found, return an empty cell array.\n\
-@seealso{file_in_loadpath, dir_in_path, path}\n\
+@seealso{file_in_loadpath, dir_in_loadpath, path}\n\
 @end deftypefn")
 {
   octave_value retval;
@@ -892,10 +892,10 @@
 %!error make_absolute_filename ("foo", "bar")
 */
 
-DEFUN (dir_in_path, args, ,
+DEFUN (dir_in_loadpath, args, ,
        "-*- texinfo -*-\n\
-@deftypefn  {Built-in Function} {} dir_in_path (@var{dir})\n\
-@deftypefnx {Built-in Function} {} dir_in_path (@var{dir}, \"all\")\n\
+@deftypefn  {Built-in Function} {} dir_in_loadpath (@var{dir})\n\
+@deftypefnx {Built-in Function} {} dir_in_loadpath (@var{dir}, \"all\")\n\
 Return the full name of the path element matching @var{dir}.  The\n\
 match is performed at the end of each path element.  For example, if\n\
 @var{dir} is @qcode{\"foo/bar\"}, it matches the path element\n\
@@ -926,7 +926,7 @@
             retval = Cell (load_path::find_matching_dirs (dir));
         }
       else
-        error ("dir_in_path: DIR must be a directory name");
+        error ("dir_in_loadpath: DIR must be a directory name");
     }
   else
     print_usage ();
@@ -937,8 +937,8 @@
 /*
 ## FIXME: We need system-dependent tests here.
 
-%!error dir_in_path ()
-%!error dir_in_path ("foo", "bar", 1)
+%!error dir_in_loadpath ()
+%!error dir_in_loadpath ("foo", "bar", 1)
 */
 
 DEFUNX ("errno", Ferrno, args, ,
--- a/libinterp/corefcn/variables.cc	Tue Dec 03 20:39:07 2013 -0800
+++ b/libinterp/corefcn/variables.cc	Wed Dec 04 08:23:42 2013 -0800
@@ -548,7 +548,7 @@
 Check only for directories.\n\
 @end table\n\
 \n\
-@seealso{file_in_loadpath, file_in_path, dir_in_path, stat}\n\
+@seealso{file_in_loadpath, file_in_path, dir_in_loadpath, stat}\n\
 @end deftypefn")
 {
   octave_value retval = false;
--- a/scripts/deprecated/find_dir_in_path.m	Tue Dec 03 20:39:07 2013 -0800
+++ b/scripts/deprecated/find_dir_in_path.m	Wed Dec 04 08:23:42 2013 -0800
@@ -19,8 +19,8 @@
 ## -*- texinfo -*-
 ## @deftypefn  {Built-in Function} {} find_dir_in_path (@var{dir})
 ## @deftypefnx {Built-in Function} {} find_dir_in_path (@var{dir}, "all")
-## This function has been deprecated.  Use @code{dir_in_path} instead.
-## @seealso{dir_in_path}
+## This function has been deprecated.  Use @code{dir_in_loadpath} instead.
+## @seealso{dir_in_loadpath}
 ## @end deftypefn
 
 ## Deprecated in version 4.2
@@ -31,10 +31,10 @@
   if (! warned)
     warned = true;
     warning ("Octave:deprecated-function",
-             "find_dir_in_path is obsolete and will be removed from a future version of Octave, please use dir_in_path instead");
+             "find_dir_in_path is obsolete and will be removed from a future version of Octave, please use dir_in_loadpath instead");
   endif
 
-  retval = dir_in_path (varargin{:});
+  retval = dir_in_loadpath (varargin{:});
 
 endfunction
 
--- a/scripts/help/help.m	Tue Dec 03 20:39:07 2013 -0800
+++ b/scripts/help/help.m	Wed Dec 04 08:23:42 2013 -0800
@@ -163,7 +163,7 @@
 
   found = false;
 
-  dlist = dir_in_path (name, "all");
+  dlist = dir_in_loadpath (name, "all");
 
   for i = 1:numel (dlist)
     fname = make_absolute_filename (fullfile (dlist{i}, "Contents.m"));
--- a/scripts/miscellaneous/what.m	Tue Dec 03 20:39:07 2013 -0800
+++ b/scripts/miscellaneous/what.m	Wed Dec 04 08:23:42 2013 -0800
@@ -37,7 +37,7 @@
       if (d(end) == '/' || d(end) == '\')
         d(end) = [];
       endif
-      dtmp = dir_in_path (d);
+      dtmp = dir_in_loadpath (d);
       if (isempty (dtmp))
         error ("what: could not find the directory %s", d);
       endif
--- a/scripts/testfun/rundemos.m	Tue Dec 03 20:39:07 2013 -0800
+++ b/scripts/testfun/rundemos.m	Wed Dec 04 08:23:42 2013 -0800
@@ -42,7 +42,7 @@
       if (directory(end) == '/' || directory(end) == '\')
         directory(end) = [];
       endif
-      fullname = dir_in_path (directory);
+      fullname = dir_in_loadpath (directory);
       if (isempty (fullname))
         error ("rundemos: DIRECTORY argument must be a valid pathname");
       endif
--- a/scripts/testfun/runtests.m	Tue Dec 03 20:39:07 2013 -0800
+++ b/scripts/testfun/runtests.m	Wed Dec 04 08:23:42 2013 -0800
@@ -42,7 +42,7 @@
       if (directory(end) == '/' || directory(end) == '\')
         directory(end) = [];
       endif
-      fullname = dir_in_path (directory);
+      fullname = dir_in_loadpath (directory);
       if (isempty (fullname))
         error ("runtests: DIRECTORY argument must be a valid pathname");
       endif