[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

PATCH: Improve remote_exec procedure documentation

From: Jacob Bachmeyer
Subject: PATCH: Improve remote_exec procedure documentation
Date: Fri, 31 May 2019 17:53:03 -0500
User-agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv: Gecko/20090807 MultiZilla/ SeaMonkey/1.1.17 Mnenhy/

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

address@hidden@b{remote_exec} @i{hostname} @i{program} @i{args}}
address@hidden  @b{remote_exec} @i{hostname} @i{program}
address@hidden address@hidden address@hidden address@hidden
@end quotation

@table @asis
@@ -3470,19 +3471,25 @@ redirected.
Name of the host to execute the command on.

@item @code{program}
address@hidden @code{args}
-There are four optional arguments:
+Command to execute.

address@hidden arguments to pass to the program;
address@hidden an input filename to feed to stanard input of the command;
address@hidden an output filename where the output from the command should be 
written; and
address@hidden timeout value in seconds.
address@hidden enumerate
address@hidden @code{options}
+Arguments to pass to the program.
address@hidden @code{input}
+Input filename to feed to standard input of the command.
address@hidden @code{output}
+Output filename where the output from the command should be written.
address@hidden @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
address@hidden  LocalWords:  POSIX KFAIL KPASS XFAIL XPASS
address@hidden  LocalWords:  POSIX KFAIL KPASS XFAIL XPASS hostname

-- Jacob

reply via email to

[Prev in Thread] Current Thread [Next in Thread]