aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Elliston <bje@gnu.org>2009-07-06 21:29:22 +1000
committerBen Elliston <bje@gnu.org>2009-07-06 21:29:22 +1000
commiteae3e56b4bef67aa967f1d2d81acef50074f2404 (patch)
treea89b35bc08bd796a746f1f3ae651763a8421e73f
parentd66480a1fb60281e8d7deb4af6425fedae724e2e (diff)
downloaddejagnu-eae3e56b4bef67aa967f1d2d81acef50074f2404.zip
dejagnu-eae3e56b4bef67aa967f1d2d81acef50074f2404.tar.gz
dejagnu-eae3e56b4bef67aa967f1d2d81acef50074f2404.tar.bz2
* doc/dejagnu.xml, doc/ref.xml, doc/user.xml: Mark up options with
<option> not <emphasis>. Apply other grammatical fixes from Reuben Thomas. * doc/dejagnu.texi: Regenerate.
-rw-r--r--ChangeLog7
-rw-r--r--doc/dejagnu.texi42
-rw-r--r--doc/dejagnu.xml2
-rw-r--r--doc/ref.xml6
-rw-r--r--doc/user.xml34
5 files changed, 49 insertions, 42 deletions
diff --git a/ChangeLog b/ChangeLog
index 6c3acd3..ed2fd79 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
2009-07-06 Ben Elliston <bje@gnu.org>
+ * doc/dejagnu.xml, doc/ref.xml, doc/user.xml: Mark up options with
+ <option> not <emphasis>. Apply other grammatical fixes from
+ Reuben Thomas.
+ * doc/dejagnu.texi: Regenerate.
+
+2009-07-06 Ben Elliston <bje@gnu.org>
+
* configure.ac: Check for docbook2x-texi.
* configure: Regenerate.
diff --git a/doc/dejagnu.texi b/doc/dejagnu.texi
index 6e80aeb..cecb048 100644
--- a/doc/dejagnu.texi
+++ b/doc/dejagnu.texi
@@ -189,7 +189,7 @@ This release has a number of substantial changes over version
included in the release are up-to-date with the current stable net
releases. The biggest change is years of modifications to the
target configuration system, used for cross testing. While this
-greatly improved cross testing, is has made that subsystem very
+greatly improved cross testing, it has made that subsystem very
complicated. The goal is to have this entirely rewritten using
iTcl by the next release. Other changes
are:
@@ -1406,7 +1406,7 @@ produce unexpected results; that is, tests with status
@emph{FAIL} (unexpected failure),
@emph{XPASS} (unexpected success), or
@emph{ERROR} (a severe error in the test case
-itself). Specify @emph{--all} to see output for tests
+itself). Specify @code{--all} to see output for tests
with status @emph{PASS} (success, as expected)
@emph{XFAIL} (failure, as expected), or
@emph{WARNING} (minor error in the test case
@@ -1429,11 +1429,11 @@ affects @emph{only} DejaGnu procedures that compare the
host string with particular values. The procedures
@emph{ishost}, @emph{istarget},
@emph{isnative}, and @emph{setup}xfail@}
-are affected by @emph{--host}. In this usage,
+are affected by @code{--host}. In this usage,
@emph{host} refers to the machine that the tests are to
be run on, which may not be the same as the
-@emph{build} machine. If @emph{--build}
-is also specified, then @emph{--host} refers to the
+@emph{build} machine. If @code{--build}
+is also specified, then @code{--host} refers to the
machine that the tests wil, be run on, not the machine DejaGnu is run
on.
@@ -1456,10 +1456,10 @@ debugging output. Debugging output is displayed as part of the
@file{dbg.log}. The extra debugging output does
@emph{not} appear on standard output, unless the
verbose level is greater than 2 (for instance, to see debug output
-immediately, specify @emph{--debug}-v -v@}). The
+immediately, specify @code{--debug}-v -v@}). The
debugging output shows all attempts at matching the test output of
the tool with the scripted patterns describing expected output. The
-output generated with @emph{--strace} also goes into
+output generated with @code{--strace} also goes into
@file{dbg.log}.
@item @code{--help} (-he)
@@ -1500,11 +1500,11 @@ rebooting takes a lot of time.
Use @file{path} as the top directory
for test scripts to run. @emph{runtest} looks in this
directory for any subdirectory whose name begins with the toolname
-(specified with @emph{--tool}). For instance, with
-@emph{--tool}gdb@}, @emph{runtest} uses
+(specified with @code{--tool}). For instance, with
+@code{--tool}gdb@}, @emph{runtest} uses
tests in subdirectories @file{gdb.*} (with the usual
shell-like filename expansion). If you do not use
-@emph{--srcdir}, @emph{runtest} looks for
+@code{--srcdir}, @emph{runtest} looks for
test directories under the current working
directory.
@@ -1516,13 +1516,13 @@ multi-level Tcl statements. This allows you to ignore some levels of
@emph{case} or @emph{if} statements.
Each procedure call or control structure counts as one ``level''. The
output is recorded in the same file, @file{dbg.log},
-used for output from @emph{--debug}.
+used for output from @code{--debug}.
@item @code{--connect [program]}
Connect to a target testing environment as specified
by @emph{type}, if the target is not the computer
running @emph{runtest}. For example, use
-@emph{--connect} to change the program used to connect
+@code{--connect} to change the program used to connect
to a ``bare board'' boot monitor. The choices for
@emph{type} in the DejaGnu 1.4 distribution are
@emph{rlogin}, @emph{telnet},
@@ -1662,7 +1662,7 @@ Test output follows, ending with:
@end example
-You can use the option @emph{--srcdir} to point to
+You can use the option @code{--srcdir} to point to
some other directory containing a collection of tests:
@example
@@ -1675,10 +1675,10 @@ By default, @code{runtest} prints only the
names of the tests it runs, output from any tests that have unexpected
results, and a summary showing how many tests passed and how many
failed. To display output from all tests (whether or not they behave
-as expected), use the @emph{--all} option. For more
+as expected), use the @code{--all} option. For more
verbose output about processes being run, communication, and so on, use
-@emph{--verbose}. To see even more output, use multiple
-@emph{--verbose} options. for a more detailed explanation
+@code{--verbose}. To see even more output, use multiple
+@code{--verbose} options. for a more detailed explanation
of each @code{runtest} option.
Test output goes into two files in your current directory:
@@ -1686,7 +1686,7 @@ summary output in @file{tool.sum},
and detailed output in @file{
tool.log}. (@emph{tool}
refers to the collection of tests; for example, after a run with
-@emph{--tool} gdb, look for output files
+@code{--tool} gdb, look for output files
@file{gdb.sum} and
@file{gdb.log}.)
@@ -3322,7 +3322,7 @@ test.
@section The dejagnu.h Header File
DejaGnu uses a single header file to assist in unit
-testing. As this file also produces it's one test state output,
+testing. As this file also produces its one test state output,
it can be run standalone, which is very useful for testing on
embedded systems. This header file has a C and C++ API for the
test states, with simple totals, and standardized
@@ -3365,7 +3365,7 @@ associated defaults); then you can proceed to installing it.
It is usually best to configure in a directory separate from the
source tree, specifying where to find the source with the optional
-@emph{--srcdir} option to
+@code{--srcdir} option to
@emph{configure}. DejaGnu uses the GNU
@emph{autoconf} to configure itself. For more info on using
autoconf, read the GNU autoconf manual. To configure, execute the
@@ -3384,7 +3384,7 @@ system or a cross system. That is determined at runtime by using the
config files.
You may also want to use the @code{configure} option
-@emph{--prefix} to specify where you want DejaGnu and its
+@code{--prefix} to specify where you want DejaGnu and its
supporting code installed. By default, installation is in subdirectories
of @file{/usr/local}, but you can select any alternate
directory @code{altdir} by including
@@ -3407,7 +3407,7 @@ suites.
To install DejaGnu in your filesystem (either in
@file{/usr/local}, or as specified by your
-@emph{--prefix} option to @emph{configure}),
+@code{--prefix} option to @emph{configure}),
execute.
@example
diff --git a/doc/dejagnu.xml b/doc/dejagnu.xml
index 7dd5527..aaf31c6 100644
--- a/doc/dejagnu.xml
+++ b/doc/dejagnu.xml
@@ -173,7 +173,7 @@
included in the release are up-to-date with the current stable net
releases. The biggest change is years of modifications to the
target configuration system, used for cross testing. While this
- greatly improved cross testing, is has made that subsystem very
+ greatly improved cross testing, it has made that subsystem very
complicated. The goal is to have this entirely rewritten using
<productname>iTcl</productname> by the next release. Other changes
are:</para>
diff --git a/doc/ref.xml b/doc/ref.xml
index 3257881..570fbc0 100644
--- a/doc/ref.xml
+++ b/doc/ref.xml
@@ -25,7 +25,7 @@
<para>It is usually best to configure in a directory separate from the
source tree, specifying where to find the source with the optional
- <emphasis>--srcdir</emphasis> option to
+ <option>--srcdir</option> option to
<emphasis>configure</emphasis>. &dj; uses the GNU
<emphasis>autoconf</emphasis> to configure itself. For more info on using
autoconf, read the GNU autoconf manual. To configure, execute the
@@ -42,7 +42,7 @@
config files.</para>
<para>You may also want to use the <command>configure</command> option
- <emphasis>--prefix</emphasis> to specify where you want &dj; and its
+ <option>--prefix</option> to specify where you want &dj; and its
supporting code installed. By default, installation is in subdirectories
of <filename>/usr/local</filename>, but you can select any alternate
directory <symbol>altdir</symbol> by including
@@ -67,7 +67,7 @@
<para>To install &dj; in your filesystem (either in
<filename>/usr/local</filename>, or as specified by your
- <emphasis>--prefix</emphasis> option to <emphasis>configure</emphasis>),
+ <option>--prefix</option> option to <emphasis>configure</emphasis>),
execute.</para>
<screen>
diff --git a/doc/user.xml b/doc/user.xml
index b79adac..164554b 100644
--- a/doc/user.xml
+++ b/doc/user.xml
@@ -933,7 +933,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
<emphasis>FAIL</emphasis> (unexpected failure),
<emphasis>XPASS</emphasis> (unexpected success), or
<emphasis>ERROR</emphasis> (a severe error in the test case
- itself). Specify <emphasis>--all</emphasis> to see output for tests
+ itself). Specify <option>--all</option> to see output for tests
with status <emphasis>PASS</emphasis> (success, as expected)
<emphasis>XFAIL</emphasis> (failure, as expected), or
<emphasis>WARNING</emphasis> (minor error in the test case
@@ -960,11 +960,11 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
host string with particular values. The procedures
<emphasis>ishost</emphasis>, <emphasis>istarget</emphasis>,
<emphasis>isnative</emphasis>, and <emphasis>setup</emphasis>xfail}
- are affected by <emphasis>--host</emphasis>. In this usage,
+ are affected by <option>--host</option>. In this usage,
<emphasis>host</emphasis> refers to the machine that the tests are to
be run on, which may not be the same as the
- <emphasis>build</emphasis> machine. If <emphasis>--build</emphasis>
- is also specified, then <emphasis>--host</emphasis> refers to the
+ <emphasis>build</emphasis> machine. If <option>--build</option>
+ is also specified, then <option>--host</option> refers to the
machine that the tests wil, be run on, not the machine &dj; is run
on.</para></listitem>
</varlistentry>
@@ -993,10 +993,10 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
<filename>dbg.log</filename>. The extra debugging output does
<emphasis>not</emphasis> appear on standard output, unless the
verbose level is greater than 2 (for instance, to see debug output
- immediately, specify <emphasis>--debug</emphasis>-v -v}). The
+ immediately, specify <option>--debug</option>-v -v}). The
debugging output shows all attempts at matching the test output of
the tool with the scripted patterns describing expected output. The
- output generated with <emphasis>--strace</emphasis> also goes into
+ output generated with <option>--strace</option> also goes into
<filename>dbg.log</filename>.</para></listitem>
</varlistentry>
@@ -1049,11 +1049,11 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
<listitem><para>Use <filename>path</filename> as the top directory
for test scripts to run. <emphasis>runtest</emphasis> looks in this
directory for any subdirectory whose name begins with the toolname
- (specified with <emphasis>--tool</emphasis>). For instance, with
- <emphasis>--tool</emphasis>gdb}, <emphasis>runtest</emphasis> uses
+ (specified with <option>--tool</option>). For instance, with
+ <option>--tool</option>gdb}, <emphasis>runtest</emphasis> uses
tests in subdirectories <filename>gdb.*</filename> (with the usual
shell-like filename expansion). If you do not use
- <emphasis>--srcdir</emphasis>, <emphasis>runtest</emphasis> looks for
+ <option>--srcdir</option>, <emphasis>runtest</emphasis> looks for
test directories under the current working
directory.</para></listitem>
</varlistentry>
@@ -1067,7 +1067,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
<emphasis>case</emphasis> or <emphasis>if</emphasis> statements.
Each procedure call or control structure counts as one ``level''. The
output is recorded in the same file, <filename>dbg.log</filename>,
- used for output from <emphasis>--debug</emphasis>.</para></listitem>
+ used for output from <option>--debug</option>.</para></listitem>
</varlistentry>
<varlistentry>
@@ -1075,7 +1075,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
<listitem><para>Connect to a target testing environment as specified
by <emphasis>type</emphasis>, if the target is not the computer
running <emphasis>runtest</emphasis>. For example, use
- <emphasis>--connect</emphasis> to change the program used to connect
+ <option>--connect</option> to change the program used to connect
to a ``bare board'' boot monitor. The choices for
<emphasis>type</emphasis> in the &dj; 1.4 distribution are
<emphasis>rlogin</emphasis>, <emphasis>telnet</emphasis>,
@@ -1236,7 +1236,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
/usr/latest/bin/gdb version 4.14.4 -nx
</screen>
- <para>You can use the option <emphasis>--srcdir</emphasis> to point to
+ <para>You can use the option <option>--srcdir</option> to point to
some other directory containing a collection of tests:</para>
<screen>
@@ -1247,10 +1247,10 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
names of the tests it runs, output from any tests that have unexpected
results, and a summary showing how many tests passed and how many
failed. To display output from all tests (whether or not they behave
- as expected), use the <emphasis>--all</emphasis> option. For more
+ as expected), use the <option>--all</option> option. For more
verbose output about processes being run, communication, and so on, use
- <emphasis>--verbose</emphasis>. To see even more output, use multiple
- <emphasis>--verbose</emphasis> options. for a more detailed explanation
+ <option>--verbose</option>. To see even more output, use multiple
+ <option>--verbose</option> options. for a more detailed explanation
of each <command>runtest</command> option.</para>
<para>Test output goes into two files in your current directory:
@@ -1258,7 +1258,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
and detailed output in <filename>
tool.log</filename>. (<emphasis>tool</emphasis>
refers to the collection of tests; for example, after a run with
- <emphasis>--tool</emphasis> gdb, look for output files
+ <option>--tool</option> gdb, look for output files
<filename>gdb.sum</filename> and
<filename>gdb.log</filename>.)</para>
</sect3>
@@ -3148,7 +3148,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o
<title>The dejagnu.h Header File</title>
<para>&dj; uses a single header file to assist in unit
- testing. As this file also produces it's one test state output,
+ testing. As this file also produces its one test state output,
it can be run standalone, which is very useful for testing on
embedded systems. This header file has a C and C++ API for the
test states, with simple totals, and standardized