Mercurial > octave-nkf
changeset 19257:eeb2a01cdc26
doc: Improve docstrings for dos() and unix().
* dos.m, unix.m: State that Octave will wait (stall) on system command to
finish before returning status and output.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 05 Oct 2014 21:41:14 -0700 |
| parents | 672674d5e8d9 |
| children | 5d3111977623 |
| files | scripts/miscellaneous/dos.m scripts/miscellaneous/unix.m |
| diffstat | 2 files changed, 14 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/miscellaneous/dos.m Sun Oct 05 20:55:35 2014 -0700 +++ b/scripts/miscellaneous/dos.m Sun Oct 05 21:41:14 2014 -0700 @@ -21,12 +21,15 @@ ## @deftypefnx {Function File} {@var{status} =} dos ("@var{command}") ## @deftypefnx {Function File} {[@var{status}, @var{text}] =} dos ("@var{command"}) ## @deftypefnx {Function File} {[@dots{}] =} dos ("@var{command}", "-echo") -## Execute a system command if running under a Windows-like operating -## system, otherwise do nothing. Return the exit status of the program -## in @var{status} and any output from the command in @var{text}. +## Execute a system command if running under a Windows-like operating system, +## otherwise do nothing. +## +## Octave waits for the external command to finish before returning the exit +## status of the program in @var{status} and any output in @var{text}. +## ## When called with no output argument, or the @qcode{"-echo"} argument is ## given, then @var{text} is also sent to standard output. -## @seealso{unix, system, isunix, ispc} +## @seealso{unix, system, isunix, ismac, ispc} ## @end deftypefn ## Author: octave-forge ???
--- a/scripts/miscellaneous/unix.m Sun Oct 05 20:55:35 2014 -0700 +++ b/scripts/miscellaneous/unix.m Sun Oct 05 21:41:14 2014 -0700 @@ -21,12 +21,15 @@ ## @deftypefnx {Function File} {@var{status} =} unix ("@var{command}") ## @deftypefnx {Function File} {[@var{status}, @var{text}] =} unix ("@var{command}") ## @deftypefnx {Function File} {[@dots{}] =} unix ("@var{command}", "-echo") -## Execute a system command if running under a Unix-like operating -## system, otherwise do nothing. Return the exit status of the program -## in @var{status} and any output from the command in @var{text}. +## Execute a system command if running under a Unix-like operating system, +## otherwise do nothing. +## +## Octave waits for the external command to finish before returning the exit +## status of the program in @var{status} and any output in @var{text}. +## ## When called with no output argument, or the @qcode{"-echo"} argument is ## given, then @var{text} is also sent to standard output. -## @seealso{dos, system, isunix, ispc} +## @seealso{dos, system, isunix, ismac, ispc} ## @end deftypefn ## Author: octave-forge ???