diff options
author | Ben Elliston <bje@gnu.org> | 2018-11-30 21:30:57 +1100 |
---|---|---|
committer | Ben Elliston <bje@gnu.org> | 2018-11-30 21:30:57 +1100 |
commit | e804244b042aa96b57dce3234f14114a9a441aac (patch) | |
tree | e46f46d7d9526a9f29180784d18697ca5c2e21fd /doc | |
parent | fd80cd001a35733dc1457c5641984bbe41eeaa19 (diff) | |
download | dejagnu-e804244b042aa96b57dce3234f14114a9a441aac.zip dejagnu-e804244b042aa96b57dce3234f14114a9a441aac.tar.gz dejagnu-e804244b042aa96b57dce3234f14114a9a441aac.tar.bz2 |
* doc/dejagnu.texi: (verbose procedure): Improve documentation.
(load_lib procedure): Likewise.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/dejagnu.texi | 64 |
1 files changed, 33 insertions, 31 deletions
diff --git a/doc/dejagnu.texi b/doc/dejagnu.texi index 66b0845..85a1730 100644 --- a/doc/dejagnu.texi +++ b/doc/dejagnu.texi @@ -2738,52 +2738,54 @@ The system triplets to clear. @node verbose procedure, load_lib procedure, clear_xfail procedure, Core Internal Procedures @subsubsection verbose Procedure -Test cases can use this function to issue helpful messages depending on -the number of @code{-v}/@code{--verbose} options passed to runtest on -the command line. It prints @i{string} if the value of the variable -@code{verbose} is higher than or equal to the optional @i{loglevel}. The -default log level is 1. Use the optional @code{-log} argument to cause -string to always be added to the log file, even if it won't be printed. -Use the optional @code{-x} argument to log the test results into a -parsable XML file. Use the optional @code{-n} argument to print string -without a trailing newline. Use the optional @code{--} argument if -string begins with "-". - -@quotation -@t{@b{verbose}@{@i{-log} +Test cases can use this procedure to issue helpful messages depending on +the number of @code{-v}/@code{--verbose} options passed on the command +line to @code{runtest}. It prints @i{message} if the value of the +number of @code{-v} options passed is greater than or equal to the +@i{loglevel} argument. The default log level is 1. + +@quotation +@t{ @b{verbose} +@{@i{-log} @i{-x} @i{-n} -@i{-r} -@i{string} +@i{message} @i{loglevel}@}} @end quotation @table @asis -@item @code{-x} - @item @code{-log} +Always write @i{message} to the log file, even if it won't be printed on +the console. + +@item @code{-x} +Log the @i{message} into an XML file. @item @code{-n} +Print @i{message} without a trailing newline. @item @code{--} +Use this option if @i{message} begins with '-'. -@item @code{string} +@item @code{message} +The log messsage. -@item @code{number} +@item @code{loglevel} +The specified log level. The default level is 1. @end table @node load_lib procedure, , verbose procedure, Core Internal Procedures @subsubsection load_lib Procedure -Loads a DejaGnu library file by searching the default fixed paths built -into DejaGnu. If DejaGnu has been installed, it looks in a path starting -with the installed library directory. If you are running DejaGnu -directly from a source directory, without first running @code{make -install}, this path defaults to the current directory. In either case, -it then looks in the current directory for a directory called -@file{lib}. If there are duplicate definitions, the last one loaded -takes precedence over the earlier ones. +@code{load_lib} loads a DejaGnu library file by searching the default +fixed paths built into DejaGnu. If DejaGnu has been installed, it looks +in a path starting with the installed library directory. If you are +running DejaGnu directly from a source directory, without first running +@code{make install}, this path defaults to the current directory. In +either case, it then looks in the current directory for a directory +called @file{lib}. If there are duplicate definitions, the last one +loaded takes precedence over the earlier ones. @quotation @t{@b{load_lib} @{@i{filespec}@}} @@ -2802,10 +2804,10 @@ the default fixed paths built into DejaGnu. @example # append a non-standard search path - global libdirs - lappend libdirs $srcdir/../../gcc/testsuite/lib - # now loading $srcdir/../../gcc/testsuite/lib/foo.exp works - load_lib foo.exp +global libdirs +lappend libdirs $srcdir/../../gcc/testsuite/lib +# now loading $srcdir/../../gcc/testsuite/lib/foo.exp works +load_lib foo.exp @end example @node Procedures For Remote Communication, connprocs, Core Internal Procedures, Builtin Procedures |