I ran across this while working on tests for default_target_compile and
noticing that the handling of the redirect= and timeout= options is not
orthogonal, while confirming that they *are* independent in the
underlying remote_exec.
This patch: (1) fixes a typo ("standard input") and (2) explicitly
lists the optional arguments to remote_exec, instead of exposing the
internal implementation detail of using Tcl varargs.
----
ChangeLog entry:
* doc/dejagnu.texi (remote_exec procedure): Explicitly list
optional arguments instead of simply copying the Tcl argument list
for the remote_exec procedure.
---
doc/dejagnu.texi | 29 ++++++++++++++++++-----------
1 files changed, 18 insertions(+), 11 deletions(-)
diff --git a/doc/dejagnu.texi b/doc/dejagnu.texi
index ccccb91..34b11a1 100644
--- a/doc/dejagnu.texi
+++ b/doc/dejagnu.texi
@@ -3462,7 +3462,8 @@ program. This may be an empty string if output from the
program was
redirected.
@quotation
-@t{@b{remote_exec} @i{hostname} @i{program} @i{args}}
+@t{ @b{remote_exec} @i{hostname} @i{program}
+?@i{options}? ?@i{input}? ?@i{output}? ?@i{timeout}?}
@end quotation
@table @asis
@@ -3470,19 +3471,25 @@ redirected.
Name of the host to execute the command on.
@item @code{program}
-Command
-@item @code{args}
-There are four optional arguments:
+Command to execute.
-@enumerate
-@item arguments to pass to the program;
-@item an input filename to feed to stanard input of the command;
-@item an output filename where the output from the command should be written;
and
-@item timeout value in seconds.
-@end enumerate
+@item @code{options}
+Arguments to pass to the program.
+
+@item @code{input}
+Input filename to feed to standard input of the command.
+
+@item @code{output}
+Output filename where the output from the command should be written.
+
+@item @code{timeout}
+Timeout value in seconds.
@end table
+All of the optional positional arguments accept an empty string as a
+neutral value.
+
@node remote_expect procedure, remote_file procedure, remote_exec procedure,
Procedures For Remote Communication
@subsubheading remote_expect Procedure
@findex remote_expect
@@ -5668,4 +5675,4 @@ This makes @code{runtest} exit. Abbreviation: @kbd{q}.
@c LocalWords: subdirectory prepend prepended testsuite filename Expect's svn
@c LocalWords: DejaGnu CVS RCS SCCS prepending subcommands Tcl Awk Readline
-@c LocalWords: POSIX KFAIL KPASS XFAIL XPASS
+@c LocalWords: POSIX KFAIL KPASS XFAIL XPASS hostname
----
-- Jacob
_______________________________________________
DejaGnu mailing list
DejaGnu@gnu.org
https://lists.gnu.org/mailman/listinfo/dejagnu
