view scripts/deprecated/find_dir_in_path.m @ 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 ff05d5b70411
children ebd27d8c63fd
line wrap: on
line source

## 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_loadpath} instead.
## @seealso{dir_in_loadpath}
## @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_loadpath instead");
  endif

  retval = dir_in_loadpath (varargin{:});

endfunction