PATCH: Fix errors in reference documentation

Mark Mitchell mark at codesourcery.com
Mon Sep 29 00:51:22 UTC 2003


This patch fixes several errors in the reference documentation.

-- 
Mark Mitchell <mark at codesourcery.com>
CodeSourcery, LLC
-------------- next part --------------
2003-09-28  Mark Mitchell  <mark at codesourcery.com>

	* qm/test/doc/reference.xml: Remove documentation for non-existant
	--summary and --no-summary options to "qmtest run".  Fix typo in
	-O documentation for "qmtest summarize".  Improve --pid-file
	documentation.

Index: qm/test/doc/reference.xml
===================================================================
RCS file: /home/sc/Repository/qm/qm/test/doc/reference.xml,v
retrieving revision 1.32
diff -c -5 -p -r1.32 reference.xml
*** qm/test/doc/reference.xml	20 Aug 2003 19:43:28 -0000	1.32
--- qm/test/doc/reference.xml	29 Sep 2003 00:36:41 -0000
***************
*** 1332,1368 ****
         linkend="sec-testcmd-create"/>.</para>
        </listitem>
       </varlistentry>
  
       <varlistentry>
-       <term><option>-s</option> <replaceable>file</replaceable></term>
-       <term>
-        <option>&dashdash;summary</option> <replaceable>file</replaceable> 
-       </term>
-       <listitem>
-        <para>Write a summary of the test run to
-        <replaceable>file</replaceable>.  Specify "<literal>-</literal>"
-        (a hyphen) to write results to standard output (the
-        default).</para>
- 
-        <para>&qmtest; prints a summary of test results, including
-        statistics and the names of tests that did not pass.  If
-        expected outcomes were specified, the the names of tests that
-        had unexpected results are printed, instead of the names of
-        tests that did not pass.</para>
-       </listitem>
-      </varlistentry>
- 
-      <varlistentry>
-       <term><option>-S</option></term>
-       <term><option>&dashdash;no-summary</option></term>
-       <listitem> 
-        <para>Do not produce a summary of the test run.</para>
-       </listitem>
-      </varlistentry>
- 
-      <varlistentry>
        <term>
         <option>&dashdash;seed</option> <replaceable>integer</replaceable>
        </term>
        <listitem>
         <para>If the <option>&dashdash;random</option> is used, &qmtest;
--- 1332,1341 ----
***************
*** 1448,1458 ****
       </varlistentry>
    
       <varlistentry>
        <term><option>-O</option> <replaceable>file</replaceable></term>
        <term>
!        <option>&dashdash;option</option> <replaceable>file</replaceable>
        </term>
        <listitem>
         <para>For details about this option, see the description of the 
         <command>qmtest run</command> command.</para>
        </listitem>
--- 1421,1431 ----
       </varlistentry>
    
       <varlistentry>
        <term><option>-O</option> <replaceable>file</replaceable></term>
        <term>
!        <option>&dashdash;outcomes</option> <replaceable>file</replaceable>
        </term>
        <listitem>
         <para>For details about this option, see the description of the 
         <command>qmtest run</command> command.</para>
        </listitem>
***************
*** 1538,1550 ****
        <glossterm>
         <property>pid-file</property>
        </glossterm>
        <glossdef>
         <para>The default path to use when creating a PID file with the
!        <option>&dashdash;pid-file</option> option.  If this entry is
!        not present, an appropriate platform-specific default value is
!        used.</para>
        </glossdef>
       </glossentry>
      </glosslist>
  
    </section> <!-- sec-config-file -->
--- 1511,1524 ----
        <glossterm>
         <property>pid-file</property>
        </glossterm>
        <glossdef>
         <para>The default path to use when creating a PID file with the
!        <option>&dashdash;pid-file</option> option.  (See <xref
!        linkend="sec-testcmd-gui"/> for more information about this
!        option.) If this entry is not present, an appropriate
!        platform-specific default value is used.</para>
        </glossdef>
       </glossentry>
      </glosslist>
  
    </section> <!-- sec-config-file -->


More information about the qmtest mailing list