Mercurial > octave

annotate scripts/deprecated/find_dir_in_path.m @ 18074:1e27079409bf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18070
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
1 ## Copyright (C) 2013 John W. Eaton
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
18
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
20 ## @deftypefn {Built-in Function} {} find_dir_in_path (@var{dir})
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
21 ## @deftypefnx {Built-in Function} {} find_dir_in_path (@var{dir}, "all")
18074
1e27079409bf Rename function dir_in_path to dir_in_loadpath.
Rik <rik@octave.org>
parents: 18070
diff changeset
22 ## This function has been deprecated. Use @code{dir_in_loadpath} instead.
1e27079409bf Rename function dir_in_path to dir_in_loadpath.
Rik <rik@octave.org>
parents: 18070
diff changeset
23 ## @seealso{dir_in_loadpath}
18070
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
24 ## @end deftypefn
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
25
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
26 ## Deprecated in version 4.2
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
27
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
28 function retval = find_dir_in_path (varargin)
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
29
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
30 persistent warned = false;
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
31 if (! warned)
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
32 warned = true;
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
33 warning ("Octave:deprecated-function",
18074
1e27079409bf Rename function dir_in_path to dir_in_loadpath.
Rik <rik@octave.org>
parents: 18070
diff changeset
34 "find_dir_in_path is obsolete and will be removed from a future version of Octave, please use dir_in_loadpath instead");
18070
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
35 endif
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
36
18074
1e27079409bf Rename function dir_in_path to dir_in_loadpath.
Rik <rik@octave.org>
parents: 18070
diff changeset
37 retval = dir_in_loadpath (varargin{:});
18070
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
38
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
39 endfunction
ff05d5b70411 Deprecate find_dir_in_path in favor of dir_in_path.
Rik <rik@octave.org>
parents:
diff changeset
40