diff options
author | Filipe Brandenburger <filbranden@google.com> | 2015-05-15 20:39:05 +1000 |
---|---|---|
committer | Ben Elliston <bje@gnu.org> | 2015-05-15 20:39:05 +1000 |
commit | e625bb34105826335d5e9b807f0a31d5950f39fc (patch) | |
tree | c6f39c3de313b7a14aa417b1c0560ae84b9ebeff /doc | |
parent | 6fc810306d8e42cdad9d04418bfb335e1dd09143 (diff) | |
download | dejagnu-e625bb34105826335d5e9b807f0a31d5950f39fc.zip dejagnu-e625bb34105826335d5e9b807f0a31d5950f39fc.tar.gz dejagnu-e625bb34105826335d5e9b807f0a31d5950f39fc.tar.bz2 |
* doc/dejagnu.xml: Fix typos such as stray }'s and @samp{...},
possibly introduced in a conversion of .texi to SGML Docbook.
* doc/user.xml: Likewise.
* doc/ref.xml: Likewise.
* doc/dejagnu.texi: Regenerate.
Signed-off-by: Ben Elliston <bje@gnu.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/dejagnu.texi | 27 | ||||
-rw-r--r-- | doc/dejagnu.xml | 2 | ||||
-rw-r--r-- | doc/ref.xml | 6 | ||||
-rw-r--r-- | doc/user.xml | 19 |
4 files changed, 26 insertions, 28 deletions
diff --git a/doc/dejagnu.texi b/doc/dejagnu.texi index bc5d388..cac8dd7 100644 --- a/doc/dejagnu.texi +++ b/doc/dejagnu.texi @@ -429,7 +429,7 @@ monitor. DejaGnu uses the same output procedures to produce these messages for all testsuites and these procedures are already known to conform to POSIX 1003.3. For a DejaGnu testsuite to conform to POSIX 1003.3, -you must avoid the @emph{setup}xfail@} procedure as +you must avoid the @emph{setup_xfail} procedure as described in the @emph{PASS} section above and you must be careful to return @emph{UNRESOLVED} where appropriate, as described in the @emph{UNRESOLVED} section @@ -1427,7 +1427,7 @@ anything is actually configured unless --build is also specified; it 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@} +@emph{isnative}, and @emph{setup_xfail} 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 @@ -1455,7 +1455,7 @@ 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 @code{--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 @code{--strace} also goes into @@ -1479,10 +1479,9 @@ code. You can normally prepare any auxiliary files needed with @item @code{--outdir [path]} Write output logs in directory -@file{path}. The default is @emph{.@}, -the} directory where you start -@emph{runtest}. This option affects only the summary -and the detailed log files +@file{path}. The default is @emph{.}, +the directory where you start @emph{runtest}. This +option affects only the summary and the detailed log files @file{tool.sum} and @file{tool.log}. The DejaGnu debug log @file{dbg.log} always appears (when requested) in @@ -1507,7 +1506,7 @@ 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 @code{--tool}). For instance, with -@code{--tool}gdb@}, @emph{runtest} uses +@code{--tool gdb}, @emph{runtest} uses tests in subdirectories @file{gdb.*} (with the usual shell-like filename expansion). If you do not use @code{--srcdir}, @emph{runtest} looks for @@ -1581,7 +1580,7 @@ tool. @item @code{--verbose} (-v) Turns on more output. Repeating this option increases the amount of output displayed. Level one (@emph{-v}) -is simply test output. Level two (@emph{-v}-v@}) shows +is simply test output. Level two (@emph{-v -v}) shows messages on options, configuration, and process control. Verbose messages appear in the detailed (@file{*.log}) log file, but not in the summary (@file{*.sum}) log @@ -2765,7 +2764,7 @@ DejaGnu itself to remain target independent. Usually the best way to write a new initialization module is to edit an existing initialization module; some trial and error will be -required. If necessary, you can use the @@samp@{--debug@} option to see what +required. If necessary, you can use the @code{--debug} option to see what is really going on. When you code an initialization module, be generous in printing @@ -3263,7 +3262,7 @@ but they should never be changed. @item $prms_id The tracking system (e.g. GNATS) number identifying -a corresponding bugreport. (@emph{0}@} if you do not +a corresponding bugreport. (@emph{0} if you do not specify it in the test script.) @item $item bug_id @@ -3389,10 +3388,10 @@ You may also want to use the @code{configure} option supporting code installed. By default, installation is in subdirectories of @file{/usr/local}, but you can select any alternate directory @code{altdir} by including -@code{--prefix}@{altdir@}@} on the +@code{--prefix altdir} on the @code{configure} command line. (This value is captured in the Makefile variables @emph{prefix} and -@emph{exec}prefix@}.) +@emph{exec_prefix}.) Save for a small number of example tests, the DejaGnu distribution itself does not include any testsuites; these are available @@ -6176,7 +6175,7 @@ procedures, @code{$@{tool@}_exit} and arguments. The other two procedures, @code{$@{tool@}_start} -and @code{$@{tool@}_load}@}, are only called by the test +and @code{$@{tool@}_load}, are only called by the test suites themselves (or by testsuite-specific initialization code); they may take arguments or not, depending on the conventions used within each testsuite. diff --git a/doc/dejagnu.xml b/doc/dejagnu.xml index 8359196..01e870f 100644 --- a/doc/dejagnu.xml +++ b/doc/dejagnu.xml @@ -408,7 +408,7 @@ <para>&dj; uses the same output procedures to produce these messages for all testsuites and these procedures are already known to conform to POSIX 1003.3. For a &dj; testsuite to conform to POSIX 1003.3, - you must avoid the <emphasis>setup</emphasis>xfail} procedure as + you must avoid the <emphasis>setup_xfail</emphasis> procedure as described in the <emphasis>PASS</emphasis> section above and you must be careful to return <emphasis>UNRESOLVED</emphasis> where appropriate, as described in the <emphasis>UNRESOLVED</emphasis> section diff --git a/doc/ref.xml b/doc/ref.xml index 9389398..018888f 100644 --- a/doc/ref.xml +++ b/doc/ref.xml @@ -46,10 +46,10 @@ 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 - <option>--prefix</option>{altdir}} on the + <option>--prefix altdir</option> on the <command>configure</command> command line. (This value is captured in the Makefile variables <emphasis>prefix</emphasis> and - <emphasis>exec</emphasis>prefix}.)</para> + <emphasis>exec_prefix</emphasis>.)</para> <para>Save for a small number of example tests, the &dj; distribution itself does not include any testsuites; these are available @@ -3451,7 +3451,7 @@ arguments.</para> <para>The other two procedures, <symbol>${tool}_start</symbol> - and <symbol>${tool}_load</symbol>}, are only called by the test + and <symbol>${tool}_load</symbol>, are only called by the test suites themselves (or by testsuite-specific initialization code); they may take arguments or not, depending on the conventions used within each testsuite.</para> diff --git a/doc/user.xml b/doc/user.xml index c2c2e0a..a5693fe 100644 --- a/doc/user.xml +++ b/doc/user.xml @@ -964,7 +964,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o affects <emphasis>only</emphasis> &dj; procedures that compare the host string with particular values. The procedures <emphasis>ishost</emphasis>, <emphasis>istarget</emphasis>, - <emphasis>isnative</emphasis>, and <emphasis>setup</emphasis>xfail} + <emphasis>isnative</emphasis>, and <emphasis>setup_xfail</emphasis> 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 @@ -998,7 +998,7 @@ 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 <option>--debug</option>-v -v}). The + immediately, specify <option>--debug -v -v</option>). 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 <option>--strace</option> also goes into @@ -1030,10 +1030,9 @@ powerpc-linux-gcc -g -O2 -o calc calc.o <varlistentry> <term><option>--outdir [path]</option></term> <listitem><para>Write output logs in directory - <filename>path</filename>. The default is <emphasis>.}, - the</emphasis> directory where you start - <emphasis>runtest</emphasis>. This option affects only the summary - and the detailed log files + <filename>path</filename>. The default is <emphasis>.</emphasis>, + the directory where you start <emphasis>runtest</emphasis>. This + option affects only the summary and the detailed log files <filename>tool.sum</filename> and <filename>tool.log</filename>. The &dj; debug log <filename>dbg.log</filename> always appears (when requested) in @@ -1064,7 +1063,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o for test scripts to run. <emphasis>runtest</emphasis> looks in this directory for any subdirectory whose name begins with the toolname (specified with <option>--tool</option>). For instance, with - <option>--tool</option>gdb}, <emphasis>runtest</emphasis> uses + <option>--tool gdb</option>, <emphasis>runtest</emphasis> uses tests in subdirectories <filename>gdb.*</filename> (with the usual shell-like filename expansion). If you do not use <option>--srcdir</option>, <emphasis>runtest</emphasis> looks for @@ -1154,7 +1153,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o <term><option>--verbose</option> (-v)</term> <listitem><para>Turns on more output. Repeating this option increases the amount of output displayed. Level one (<emphasis>-v</emphasis>) - is simply test output. Level two (<emphasis>-v</emphasis>-v}) shows + is simply test output. Level two (<emphasis>-v -v</emphasis>) shows messages on options, configuration, and process control. Verbose messages appear in the detailed (<filename>*.log</filename>) log file, but not in the summary (<filename>*.sum</filename>) log @@ -2397,7 +2396,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o <para>Usually the best way to write a new initialization module is to edit an existing initialization module; some trial and error will be - required. If necessary, you can use the @samp{--debug} option to see what + required. If necessary, you can use the <option>--debug</option> option to see what is really going on.</para> <para>When you code an initialization module, be generous in printing @@ -3093,7 +3092,7 @@ powerpc-linux-gcc -g -O2 -o calc calc.o <varlistentry> <term>$prms_id</term> <listitem><para>The tracking system (e.g. GNATS) number identifying - a corresponding bugreport. (<emphasis>0</emphasis>} if you do not + a corresponding bugreport. (<emphasis>0</emphasis> if you do not specify it in the test script.)</para></listitem> </varlistentry> |