octave-nkf: scripts/miscellaneous/dos.m annotate

annotate scripts/miscellaneous/dos.m @ 20550:76f67400649e

Use '-local' option to warning to simplify BIST tests. * dos.m, unix.m, savepath.m, kurtosis.m, skewness.m: Use '-local' option to warning instead of unwind/protect block.

author	Rik <rik@octave.org>
date	Fri, 25 Sep 2015 21:00:29 -0700
parents	4197fc428c7d
children

rev	line source
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19630 diff changeset	1 ## Copyright (C) 2004-2015 John W. Eaton
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	2 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	4 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6069 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6069 diff changeset	8 ## your option) any later version.
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	9 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	14 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6069 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6069 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	18
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
14018 5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	20 ## @deftypefn {Function File} {} dos ("@var{command}")
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	21 ## @deftypefnx {Function File} {@var{status} =} dos ("@var{command}")
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	22 ## @deftypefnx {Function File} {[@var{status}, @var{text}] =} dos ("@var{command"})
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	23 ## @deftypefnx {Function File} {[@dots{}] =} dos ("@var{command}", "-echo")
19257 eeb2a01cdc26 doc: Improve docstrings for dos() and unix(). Rik <rik@octave.org> parents: 17744 diff changeset	24 ## Execute a system command if running under a Windows-like operating system,
eeb2a01cdc26 doc: Improve docstrings for dos() and unix(). Rik <rik@octave.org> parents: 17744 diff changeset	25 ## otherwise do nothing.
eeb2a01cdc26 doc: Improve docstrings for dos() and unix(). Rik <rik@octave.org> parents: 17744 diff changeset	26 ##
eeb2a01cdc26 doc: Improve docstrings for dos() and unix(). Rik <rik@octave.org> parents: 17744 diff changeset	27 ## Octave waits for the external command to finish before returning the exit
eeb2a01cdc26 doc: Improve docstrings for dos() and unix(). Rik <rik@octave.org> parents: 17744 diff changeset	28 ## status of the program in @var{status} and any output in @var{text}.
eeb2a01cdc26 doc: Improve docstrings for dos() and unix(). Rik <rik@octave.org> parents: 17744 diff changeset	29 ##
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 14138 diff changeset	30 ## When called with no output argument, or the @qcode{"-echo"} argument is
14018 5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	31 ## given, then @var{text} is also sent to standard output.
19257 eeb2a01cdc26 doc: Improve docstrings for dos() and unix(). Rik <rik@octave.org> parents: 17744 diff changeset	32 ## @seealso{unix, system, isunix, ismac, ispc}
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	33 ## @end deftypefn
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	34
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	35 ## Author: octave-forge ???
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	36 ## Adapted by: jwe
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	37
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	38 function [status, text] = dos (command, echo_arg)
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	39
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	40 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5820 diff changeset	41 print_usage ();
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	42 elseif (! isunix ())
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	43 [status, text] = system (command);
5820 27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	44 if (nargin > 1 \|\| nargout == 0)
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	45 printf ("%s\n", text);
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	46 endif
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	47 endif
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	48
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe] jwe parents: diff changeset	49 endfunction
14018 5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	50
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	51
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	52 %!test
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	53 %! cmd = ls_command ();
20550 76f67400649e Use '-local' option to warning to simplify BIST tests. Rik <rik@octave.org> parents: 19731 diff changeset	54 %! warning ("off", "Octave:undefined-return-values", "local");
76f67400649e Use '-local' option to warning to simplify BIST tests. Rik <rik@octave.org> parents: 19731 diff changeset	55 %! [status, output] = dos (cmd);
14018 5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	56 %!
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	57 %! if (ispc () && ! isunix ())
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	58 %! [status, output] = dos (cmd);
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	59 %! assert (status, 0);
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	60 %! assert (ischar (output));
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	61 %! assert (! isempty (output));
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	62 %! else
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	63 %! assert (status, []);
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	64 %! assert (output, []);
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	65 %! endif
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	66
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	67 %!error dos ()
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	68 %!error dos (1, 2, 3)
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	69

Mercurial > octave-nkf

annotate scripts/miscellaneous/dos.m @ 20550:76f67400649e