From 520f7493f69e4fbcd7a4fc55a0bed29d7922adf9 Mon Sep 17 00:00:00 2001 From: Bernhard Reutner-Fischer Date: Sat, 15 Jun 2013 21:27:29 +1000 Subject: * doc/user.xml: Fix rendering errors around programlisting. * doc/ref.xml: Likewise. * doc/dejagnu.texi: Regenerate. Signed-off-by: Ben Elliston --- ChangeLog | 6 ++++++ doc/dejagnu.texi | 33 +++++++++++---------------------- doc/ref.xml | 12 ++++++++---- doc/user.xml | 34 ++++++++++++++++------------------ 4 files changed, 41 insertions(+), 44 deletions(-) diff --git a/ChangeLog b/ChangeLog index b26d8a9..f6f45a2 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,11 @@ 2013-06-15 Bernhard Reutner-Fischer + * doc/user.xml: Fix rendering errors around programlisting. + * doc/ref.xml: Likewise. + * doc/dejagnu.texi: Regenerate. + +2013-06-15 Bernhard Reutner-Fischer + * doc/user.xml: Fix spacing before productname. * doc/dejagnu.texi: Regenerate. diff --git a/doc/dejagnu.texi b/doc/dejagnu.texi index 16730a9..f911580 100644 --- a/doc/dejagnu.texi +++ b/doc/dejagnu.texi @@ -454,7 +454,6 @@ run (as root): apt-get install dejagnu @end example -@noindent These examples were run on a primary machine with a AMD K6 and a Mac Powerbook G3 serving as a remote target. @@ -1110,7 +1109,6 @@ In order to distinguish it from the host add the line PS1='test:>' @end example -@noindent to /home/dgt/.bash_profile. Also add a corresponding entry "powerbook" to /etc/hosts and verify that you are able to ping, telnet and ftp to the target "powerbook". @@ -2406,7 +2404,6 @@ options and variables you can set in @file{site.exp}. @ref{Invoking Runtest}, for explanations of the command-line options. - @strong{Tcl Variables For Command Line Options} @multitable @columnfractions 0.2 0.2 0.2 0.2 0.2 @@ -2879,7 +2876,6 @@ all set by using the @code{set_board_info} procedure. The parameters are the field name, followed by the value to set the field to. - @strong{Common Board Info Fields} @multitable @columnfractions 0.333333333333333 0.333333333333333 0.333333333333333 @@ -2925,7 +2921,6 @@ these tools. Many of these are used only by a few testcases, and their purpose is esoteric. These are listed with sample values as a guide to better guessing if you need to change any of these. - @strong{Board Info Fields For GCC & GDB} @multitable @columnfractions 0.333333333333333 0.333333333333333 0.333333333333333 @@ -3135,17 +3130,13 @@ all of which are slightly different; examine the directories for the tool of interest to see which (if any) is most suitable. Adding a GCC test can be very simple: just add the C code -to any directory beginning with @file{gcc}. and it -runs on the next +to any directory beginning with @file{gcc} and it +runs on the next: @example -runtest --tool - gcc +runtest --tool gcc @end example -@noindent -. - To add a test to GDB, first add any source code you will need to the test directory. Then you can either create a new expect file, or add your test to an existing one (any @@ -3217,11 +3208,10 @@ usually too dependent on terminal settings. Always escape punctuation, such as @emph{(} or @emph{"}, in your patterns; for example, write @emph{\(}. If you forget to escape punctuation, -you will usually see an error message like +you will usually see an error message like: @example -extra - characters after close-quote. +extra characters after close-quote @end example If you have trouble understanding why a pattern does not @@ -4132,14 +4122,14 @@ an ordinary @emph{FAIL}. You can also specify flags to exclude. This makes a result be a @emph{FAIL}, even if the included options are found. To set the conditional, set the variable @code{compiler_conditional_xfail_data} to the -fields +fields @example -"[message string] [targets list] [includes - list] [excludes list]" + + "[message string] [targets list] [includes list] [excludes list]" + @end example -@noindent (descriptions below). This is the checked at pass/fail decision time, so there is no need to call the procedure yourself, unless you wish to know if it gets @@ -6392,14 +6382,13 @@ Search @emph{runtest}s for @emph{testcase} and return @emph{1} if found, @emph{0} if not. @emph{runtests} is a list of two elements. The first is a copy of what was on -the right side of the @emph{=} if +the right side of the @emph{=} if @example foo.exp="..." @end example -@noindent -" was specified, or +was specified, or an empty string if no such argument is present. The second is the pathname of the current testcase under consideration. This is used by tools like compilers where each testcase is a file. diff --git a/doc/ref.xml b/doc/ref.xml index f8c0150..c902f36 100644 --- a/doc/ref.xml +++ b/doc/ref.xml @@ -859,8 +859,11 @@ exclude. This makes a result be a FAIL, even if the included options are found. To set the conditional, set the variable compiler_conditional_xfail_data to the - fields "[message string] [targets list] [includes - list] [excludes list]" (descriptions below). This is + fields + + "[message string] [targets list] [includes list] [excludes list]" + + (descriptions below). This is the checked at pass/fail decision time, so there is no need to call the procedure yourself, unless you wish to know if it gets triggered. After a pass/fail, the variable is reset, so it doesn't @@ -3677,8 +3680,9 @@ testcase and return 1 if found, 0 if not. runtests is a list of two elements. The first is a copy of what was on - the right side of the = if - foo.exp="..."" was specified, or + the right side of the = if + foo.exp="..." + was specified, or an empty string if no such argument is present. The second is the pathname of the current testcase under consideration. This is used by tools like compilers where each testcase is a file. diff --git a/doc/user.xml b/doc/user.xml index e527d2d..3878775 100644 --- a/doc/user.xml +++ b/doc/user.xml @@ -13,9 +13,9 @@ subtle problems. You have been warned. It should be no big problems installing &dj; using your package manager or from the source code. On the Debian GNU/Linux system just -run (as root): +run (as root): apt-get install dejagnu - + These examples were run on a primary machine with a AMD K6 and a Mac Powerbook G3 serving as a remote target. @@ -623,8 +623,9 @@ remote_expect $target 5 { Now setup a real target. In the following example we assume as target a PowerBook running Debian. As above add a test user "dgt", install Telnet and FTP servers. -In order to distinguish it from the host add the line -PS1='test:>' to /home/dgt/.bash_profile. +In order to distinguish it from the host add the line +PS1='test:>' + to /home/dgt/.bash_profile. Also add a corresponding entry "powerbook" to /etc/hosts and verify that you are able to ping, telnet and ftp to the target "powerbook". @@ -1975,7 +1976,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o site.exp. , for explanations of the command-line options. - +
Tcl Variables For Command Line Options @@ -2080,8 +2081,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o -
- + @@ -2509,7 +2509,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o parameters are the field name, followed by the value to set the field to. - +
Common Board Info Fields @@ -2618,8 +2618,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o -
- + These fields are used by the GCC and GDB tests, and are mostly only useful to somewhat trying to debug a new board file for one of @@ -2627,7 +2626,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o purpose is esoteric. These are listed with sample values as a guide to better guessing if you need to change any of these. - +
Board Info Fields For GCC & GDB @@ -2832,8 +2831,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o -
- + @@ -2963,9 +2961,9 @@ powerpc-linux-gcc -g -O2 -o calc calc.o the tool of interest to see which (if any) is most suitable. Adding a GCC test can be very simple: just add the C code - to any directory beginning with gcc. and it - runs on the next runtest --tool - gcc. + to any directory beginning with gcc and it + runs on the next: + runtest --tool gcc To add a test to GDB, first add any source code you will need to the test directory. Then you can either create a new @@ -3036,8 +3034,8 @@ powerpc-linux-gcc -g -O2 -o calc calc.o Always escape punctuation, such as ( or ", in your patterns; for example, write \(. If you forget to escape punctuation, - you will usually see an error message like extra - characters after close-quote. + you will usually see an error message like: + extra characters after close-quote If you have trouble understanding why a pattern does not match the program output, try using the -- cgit v1.1