Mercurial > octave-nkf

diff scripts/deprecated/find_dir_in_path.m @ 18070:ff05d5b70411

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Deprecate find_dir_in_path in favor of dir_in_path. * NEWS: Announce deprecation of find_dir_in_path and new function dir_in_path. * scripts/deprecated/find_dir_in_path.m: Add script to call dir_in_path and give deprecation warning. * scripts/deprecated/module.mk: Add deprecated find_dir_in_path.m to build system. * utils.cc (Fdir_in_path): Renamed find_dir_in_path to dir_in_path. * help.m, what.m, rundemos.m, runtests.m: Chane instances of find_dir_in_path to dir_in_path. * utils.cc, variables.cc: Change seealso links to point to dir_in_path. * func.txi: Document dir_in_path function.
author Rik <rik@octave.org>
date Tue, 03 Dec 2013 15:59:56 -0800
parents
children 1e27079409bf
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/deprecated/find_dir_in_path.m	Tue Dec 03 15:59:56 2013 -0800
@@ -0,0 +1,40 @@
+## Copyright (C) 2013 John W. Eaton
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- 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}
+## @end deftypefn
+
+## Deprecated in version 4.2
+
+function retval = find_dir_in_path (varargin)
+
+  persistent warned = false;
+  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");
+  endif
+
+  retval = dir_in_path (varargin{:});
+
+endfunction
+