diff options
| author | Anton Kolesov <anton.kolesov@synopsys.com> | 2013-10-31 06:35:30 +1100 |
|---|---|---|
| committer | Ben Elliston <bje@gnu.org> | 2013-10-31 06:35:30 +1100 |
| commit | 11ba195b8b6d4d3c57449f41ef12a8cf54f612b9 (patch) | |
| tree | f39d4120d37b01fced14f2c64b11aa47a3ae6ecc /doc | |
| parent | 28a5e74afeb11090dc269bbf814eec306c7d4ec5 (diff) | |
* lib/remote.exp (standard_reboot): Return 1 instead of an empty string.
(remote_reboot): Add comment explaining return value of this procedure.
* doc/ref.xml (remote_reboot, standard_reboot): Document procedures.
* doc/dejagnu.texi: Regenerate.
Signed-off-by: Ben Elliston <bje@gnu.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dejagnu.texi | 9 | ||||
| -rw-r--r-- | doc/ref.xml | 11 |
2 files changed, 18 insertions, 2 deletions
diff --git a/doc/dejagnu.texi b/doc/dejagnu.texi index 9e6c606..bd82d44 100644 --- a/doc/dejagnu.texi +++ b/doc/dejagnu.texi @@ -4830,6 +4830,10 @@ the @code{target_info} array. @node remote_reboot procedure, remote_send procedure, remote_raw_wait procedure, Procedures For Remote Communication @subsubsection Remote_reboot Procedure +Return value of this function depends on actual implementation +of reboot that will be used, in practice it is expected that +@code{remote_reboot} returns @emph{1} +on success and @emph{0} on failure. @quotation @@ -5035,6 +5039,11 @@ the @code{target_info} array. @node standard_reboot procedure, standard_send procedure, standard_load procedure, Procedures For Remote Communication @subsubsection Standard_reboot Procedure +It looks like that this procedure is never called, instead +@code{$@{board@}_reboot} defined in +@file{base-config.exp} will be used because it has +higher priority and @file{base-config.exp} is +always imported by @code{runtest}. @quotation diff --git a/doc/ref.xml b/doc/ref.xml index 18ae3bc..0c0f1f6 100644 --- a/doc/ref.xml +++ b/doc/ref.xml @@ -1725,7 +1725,10 @@ <sect4 id="remotereboot" xreflabel="remote_reboot procedure"> <title>Remote_reboot Procedure</title> - <para></para> + <para>Return value of this function depends on actual implementation + of reboot that will be used, in practice it is expected that + <function>remote_reboot</function> returns <emphasis>1</emphasis> + on success and <emphasis>0</emphasis> on failure.</para> <funcsynopsis role="tcl"> <funcprototype> @@ -2013,7 +2016,11 @@ <sect4 id="standardreboot" xreflabel="standard_reboot procedure"> <title>Standard_reboot Procedure</title> - <para></para> + <para>It looks like that this procedure is never called, instead + <function>${board}_reboot</function> defined in + <filename>base-config.exp</filename> will be used because it has + higher priority and <filename>base-config.exp</filename> is + always imported by <command>runtest</command>.</para> <funcsynopsis role="tcl"> <funcprototype> |