aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBernhard Reutner-Fischer <aldot@gcc.gnu.org>2013-06-15 21:27:29 +1000
committerBen Elliston <bje@gnu.org>2013-06-15 21:27:29 +1000
commit520f7493f69e4fbcd7a4fc55a0bed29d7922adf9 (patch)
tree30dcdb1928939b37a794ef5318831d22d2c55a3f
parenta340a5b44eb49b412f0f5e235c1769e77605a7b2 (diff)
downloaddejagnu-520f7493f69e4fbcd7a4fc55a0bed29d7922adf9.zip
dejagnu-520f7493f69e4fbcd7a4fc55a0bed29d7922adf9.tar.gz
dejagnu-520f7493f69e4fbcd7a4fc55a0bed29d7922adf9.tar.bz2
* doc/user.xml: Fix rendering errors around programlisting.
* doc/ref.xml: Likewise. * doc/dejagnu.texi: Regenerate. Signed-off-by: Ben Elliston <bje@gnu.org>
-rw-r--r--ChangeLog6
-rw-r--r--doc/dejagnu.texi33
-rw-r--r--doc/ref.xml12
-rw-r--r--doc/user.xml34
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 <aldot@gcc.gnu.org>
+ * doc/user.xml: Fix rendering errors around programlisting.
+ * doc/ref.xml: Likewise.
+ * doc/dejagnu.texi: Regenerate.
+
+2013-06-15 Bernhard Reutner-Fischer <aldot@gcc.gnu.org>
+
* 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 <emphasis>FAIL</emphasis>, even if
the included options are found. To set the conditional, set
the variable <symbol>compiler_conditional_xfail_data</symbol> to the
- fields <programlisting>"[message string] [targets list] [includes
- list] [excludes list]"</programlisting> (descriptions below). This is
+ fields</para>
+ <programlisting>
+ "[message string] [targets list] [includes list] [excludes list]"
+ </programlisting>
+ <para> (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 @@
<emphasis>testcase</emphasis> and return <emphasis>1</emphasis> if
found, <emphasis>0</emphasis> if not. <emphasis>runtests</emphasis>
is a list of two elements. The first is a copy of what was on
- the right side of the <emphasis>=</emphasis> if
- <programlisting>foo.exp="..."</programlisting>" was specified, or
+ the right side of the <emphasis>=</emphasis> if</para>
+ <programlisting>foo.exp="..."</programlisting>
+ <para>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.</para>
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.</para>
<para>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):</para>
<programlisting>apt-get install dejagnu</programlisting>
-
+<para>
These examples were run on a primary machine with a AMD K6 and a Mac
Powerbook G3 serving as a remote target.</para>
@@ -623,8 +623,9 @@ remote_expect $target 5 {
<para>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
-<programlisting>PS1='test:>'</programlisting> to /home/dgt/.bash_profile.
+In order to distinguish it from the host add the line</para>
+<programlisting>PS1='test:>'</programlisting>
+<para> 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".</para>
@@ -1975,7 +1976,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
<filename>site.exp</filename>. <xref linkend="invoking"/>, for
explanations of the command-line options.</para>
- <para><table frame="all" rowsep="0" colsep="0">
+ <table frame="all" rowsep="0" colsep="0">
<title>Tcl Variables For Command Line Options</title>
<tgroup cols="5" align="char" rowsep="1" colsep="0">
@@ -2080,8 +2081,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
</tbody>
</tgroup>
- </table>
- </para>
+ </table>
</sect3>
@@ -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.</para>
- <para><table frame="all" rowsep="0" colsep="0">
+ <table frame="all" rowsep="0" colsep="0">
<title>Common Board Info Fields</title>
<tgroup cols="3" align="char" rowsep="1" colsep="0">
@@ -2618,8 +2618,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
</tbody>
</tgroup>
- </table>
- </para>
+ </table>
<para>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.</para>
- <para><table frame="all" rowsep="0" colsep="0">
+ <table frame="all" rowsep="0" colsep="0">
<title>Board Info Fields For GCC &amp; GDB</title>
<tgroup cols="3" align="char" rowsep="1" colsep="0">
@@ -2832,8 +2831,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
</tbody>
</tgroup>
- </table>
- </para>
+ </table>
</sect2>
@@ -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.</para>
<para>Adding a GCC test can be very simple: just add the C code
- to any directory beginning with <filename>gcc</filename>. and it
- runs on the next <programlisting>runtest --tool
- gcc</programlisting>.</para>
+ to any directory beginning with <filename>gcc</filename> and it
+ runs on the next: </para>
+ <programlisting>runtest --tool gcc</programlisting>
<para>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
<para>Always escape punctuation, such as <emphasis>(</emphasis>
or <emphasis>&quot;</emphasis>, in your patterns; for example, write
<emphasis>\(</emphasis>. If you forget to escape punctuation,
- you will usually see an error message like <programlisting>extra
- characters after close-quote.</programlisting></para>
+ you will usually see an error message like:</para>
+ <programlisting>extra characters after close-quote</programlisting>
<para>If you have trouble understanding why a pattern does not
match the program output, try using the <option>--debug</option>