public inbox for frysk-cvs@sourceware.org
help / color / mirror / Atom feed
* [SCM]  master: More man page cleanups.
@ 2008-04-08 17:13 cagney
  0 siblings, 0 replies; only message in thread
From: cagney @ 2008-04-08 17:13 UTC (permalink / raw)
  To: frysk-cvs

The branch, master has been updated
       via  7509f5f0103b0527781d4d8ccde451e3ea71266c (commit)
      from  cbb50856fe829fa9491ad30a89cd6ce846969693 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email.

- Log -----------------------------------------------------------------
commit 7509f5f0103b0527781d4d8ccde451e3ea71266c
Author: Andrew Cagney <cagney@redhat.com>
Date:   Tue Apr 8 13:12:33 2008 -0400

    More man page cleanups.
    
    frysk-core/frysk/pkglibdir/ChangeLog
    2008-04-08  Andrew Cagney  <cagney@redhat.com>
    
    	* funit-threads.xml-in: Add version information.
    	* fparser.xml-in: Ditto.
    	* funit-exec.xml-in: Ditto.
    	* funit-exit.xml-in: Ditto.
    	* funit-slave.xml-in: Ditto.

-----------------------------------------------------------------------

Summary of changes:
 frysk-core/frysk/pkglibdir/ChangeLog            |    8 +
 frysk-core/frysk/pkglibdir/fparser.xml-in       |   89 ++++---------
 frysk-core/frysk/pkglibdir/funit-exec.xml-in    |  168 ++++++++++++----------
 frysk-core/frysk/pkglibdir/funit-exit.xml-in    |   87 +++---------
 frysk-core/frysk/pkglibdir/funit-slave.xml-in   |   85 +++---------
 frysk-core/frysk/pkglibdir/funit-threads.xml-in |  105 ++++----------
 6 files changed, 190 insertions(+), 352 deletions(-)

First 500 lines of diff:
diff --git a/frysk-core/frysk/pkglibdir/ChangeLog b/frysk-core/frysk/pkglibdir/ChangeLog
index 4d27f70..23fd5b2 100644
--- a/frysk-core/frysk/pkglibdir/ChangeLog
+++ b/frysk-core/frysk/pkglibdir/ChangeLog
@@ -1,3 +1,11 @@
+2008-04-08  Andrew Cagney  <cagney@redhat.com>
+
+	* funit-threads.xml-in: Add version information.
+	* fparser.xml-in: Ditto.
+	* funit-exec.xml-in: Ditto.
+	* funit-exit.xml-in: Ditto.
+	* funit-slave.xml-in: Ditto.
+
 2008-04-07  Sami Wagiaalla  <swagiaal@redhat.com>
 
 	* funit-elf-symbols.S: New test file.
diff --git a/frysk-core/frysk/pkglibdir/fparser.xml-in b/frysk-core/frysk/pkglibdir/fparser.xml-in
index 352e330..9bbaf02 100644
--- a/frysk-core/frysk/pkglibdir/fparser.xml-in
+++ b/frysk-core/frysk/pkglibdir/fparser.xml-in
@@ -44,26 +44,33 @@
 -->
 
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-
-<!-- http://docbook.sourceforge.net/snapshots/xsl/manpages/README -->
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
+ [
+ <!ENTITY version SYSTEM "@abs_root_srcdir@/common/version.in">
+ <!ENTITY command "fparser">
+ <!ENTITY volume "8">
+ ]
+>
 
 <refentry id="fparser">
 
   <refentryinfo>
-    <title>fparser</title>
-    <date>March 14 2008</date>
+    <title>Frysk</title>
+    <date>April 2008</date>
   </refentryinfo>
   
   <refmeta>
-    <refentrytitle>fparser</refentrytitle>
-    <manvolnum>1</manvolnum>
+    <refentrytitle>&command;</refentrytitle>
+    <manvolnum>&volume;</manvolnum>
+    <refmiscinfo class='source'>Frysk</refmiscinfo>
+    <refmiscinfo class='version'>&version;</refmiscinfo>
   </refmeta>
 
   <refnamediv>
     <refname>fparser</refname>
-    <refpurpose>runs the frysk standalone source code parser
-                utility</refpurpose>
+    <refpurpose>
+      parse source code marking it up with XML
+    </refpurpose>
   </refnamediv>
   
   <refsynopsisdiv>
@@ -84,17 +91,20 @@
   <refsect1>
     <title>DESCRIPTION</title>
 
-    <para><function>fparser</function> Executes the frysk standalone source code parser utility.</para>
-
-    <para>fparser is a utility that will parse the source files listed in the header of an executable.
-                  It is used to test the internal parser for the frysk source window. </para>
+    <para>
+      <function>fparser</function> is a utility that will parse the
+      source files listed in the header of an executable.  It is used
+      to test the internal parser for the frysk source window.
+    </para>
 
     <variablelist>
       <varlistentry>
 	<term>-o <replaceable>[file to write DOM to]</replaceable></term>
 	<listitem>
-          <para> This allows a DOM to be output to an xml file that can be viewed/analyzed 
-          with an editor.</para>
+          <para>
+	    This allows a DOM to be output to an xml file that can be
+            viewed/analyzed with an editor.
+	  </para>
         </listitem>
       </varlistentry>
     <varlistentry>
@@ -106,68 +116,19 @@
     </variablelist>
   </refsect1>
   
-  <!-- refsect1>
-    <title>EXIT STATUS</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>RETURN VALUES</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>ENVIRONMENT</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>FILES</title>
-    <para></para>
-  </refsect1 -->
-  
   <refsect1>
     <title>EXAMPLE</title>
     <screen>fparser /home/foo/bar</screen>
   </refsect1>
-   
-  <!-- refsect1>
-    <title>DIAGNOSTICS</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>ERRORS</title>
-      <para></para>   
-  </refsect1 -->    
 
   <refsect1>
     <title>SEE ALSO</title>
     <para>frysk(7)</para>
   </refsect1>
   
-  <!-- refsect1>
-    <title>STANDARDS</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>HISTORY</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>AUTHORS</title>
-    <para></para>
-  </refsect1 -->
-  
   <refsect1>
     <title>BUGS</title>
     <para>Report bugs to <ulink url="http://sourceware.org/frysk"/></para>
   </refsect1>
-  
-  <!-- refsect1>
-    <title>SECURITY CONSIDERATIONS</title>
-  </refsect1 -->
 
 </refentry>
diff --git a/frysk-core/frysk/pkglibdir/funit-exec.xml-in b/frysk-core/frysk/pkglibdir/funit-exec.xml-in
index 345d5cb..f12c83f 100644
--- a/frysk-core/frysk/pkglibdir/funit-exec.xml-in
+++ b/frysk-core/frysk/pkglibdir/funit-exec.xml-in
@@ -44,25 +44,33 @@
 -->
 
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
+ [
+ <!ENTITY version SYSTEM "@abs_root_srcdir@/common/version.in">
+ <!ENTITY command "funit-exec">
+ <!ENTITY volume "8">
+ ]
+>
 
-<!-- http://docbook.sourceforge.net/snapshots/xsl/manpages/README -->
-
-<refentry id="funit">
+<refentry>
 
   <refentryinfo>
-    <title>funit-exec</title>
-    <date>March 14 2008</date>
+    <title>Frysk</title>
+    <date>April 2008</date>
   </refentryinfo>
   
   <refmeta>
-    <refentrytitle>funit-exec</refentrytitle>
-    <manvolnum>8</manvolnum>
+    <refentrytitle>&command;</refentrytitle>
+    <manvolnum>&volume;</manvolnum>
+    <refmiscinfo class='source'>Frysk</refmiscinfo>
+    <refmiscinfo class='version'>&version;</refmiscinfo>
   </refmeta>
 
   <refnamediv>
     <refname>funit-exec</refname>
-    <refpurpose>Slave program for frysk's JUnit tests</refpurpose>
+    <refpurpose>
+      on CNTRL-C exec the specified program
+    </refpurpose>
   </refnamediv>
   
   <refsynopsisdiv>
@@ -72,7 +80,10 @@
         <option><replaceable>OPTION</replaceable></option>
       </arg>
       <arg choice="req">
-        <replaceable>PROGRAM-ARGS</replaceable>
+        <replaceable>program</replaceable>
+      </arg>
+      <arg rep="repeat" choice="opt">
+	<replaceable>arg</replaceable>
       </arg>
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -80,57 +91,101 @@
   <refsect1>
     <title>DESCRIPTION</title>
 
-    <para>Wait for a SIGINT (cntrl-c) signal and then exec
-    <replaceable>PROGRAM-ARGS</replaceable>, the first parameter being
-    the executable and the remainder being arguments.  Sending a
-    SIGUSR1 signal will cause a random non-main thread to make the
-    exec call.</para>
+    <para>
+      Wait for a SIGINT (cntrl-c) signal and then exec
+      <replaceable>program</replaceable> passing
+      it <replaceable>args</replaceable>.
+    </para>
+
+    <para>
+      Sending a SIGUSR1 signal will cause a random non-main thread to
+      make the exec call.
+    </para>
 
     <variablelist>
 
       <varlistentry>
-	<term> <option>-m <replaceable>PID</replaceable>
-	</option> </term> <listitem><para>The PID of the master
-	process that should be sent a signal once this program is
-	running (default 0).</para> </listitem>
+	<term>
+	  <option>-m <replaceable>pid</replaceable></option>
+	</term>
+	<listitem>
+	  <para>
+	    The <replaceable>pid</replaceable> of the master process
+	    that should be sent a signal once this program is running
+	    (default 0).
+	  </para>
+	</listitem>
       </varlistentry>
 
       <varlistentry>
-	<term> <option>-s <replaceable>SIGNAL</replaceable>
-	</option> </term> <listitem> <para>The SIGNAL to send to the
-	master process once this program is running (default
-	0).</para> </listitem>
+	<term>
+	  <option>-s <replaceable>signal</replaceable></option>
+	</term>
+	<listitem>
+	  <para>
+	    The <replaceable>signal</replaceable> to send to the
+	    master process once this program is running (default
+	    0).
+	  </para>
+	</listitem>
       </varlistentry>
 
       <varlistentry>
-	<term> <option>-t <replaceable>TIMEOUT</replaceable> </option>
-	</term> <listitem> <para>Exit after TIMEOUT seconds exit</para>
+	<term>
+	  <option>-t <replaceable>timeout</replaceable></option>
+	</term>
+	<listitem>
+	  <para>
+	    Exit after <replaceable>timeout</replaceable> seconds.
+	  </para>
 	</listitem>
       </varlistentry>
 
       <varlistentry>
-	<term> <option>-c <replaceable>COUNT</replaceable> </option>
-	</term> <listitem> <para>Create COUNT threads before sending
-	the master TIMEOUT seconds exit</para> </listitem>
+	<term>
+	  <option>-c <replaceable>count</replaceable></option>
+	</term>
+	<listitem>
+	  <para>
+	    Create <replaceable>count</replaceable> threads.
+	  </para>
+	</listitem>
       </varlistentry>
 
       <varlistentry>
-	<term> <option>-e <replaceable>EXECUTABLE</replaceable>
-	</option> </term> <listitem> <para>The EXECUTABLE to exec
-	(default is the first PROGRAM-ARGS parameter).</para>
+	<term>
+	  <option>-e <replaceable>executable</replaceable></option>
+	</term>
+	<listitem>
+	  <para>
+	    The <replaceable>executable</replaceable> to exec (default
+	    is the <replaceable>program</replaceable>).
+	  </para>
 	</listitem>
       </varlistentry>
 
        <varlistentry>
-	<term> <option>-b</option> </term> <listitem> <para>Brand the
-	exec with the thread that initiated it by setting argv[0] to
-	the string TID:PID.</para> </listitem>
+	<term>
+	  <option>-b</option>
+	</term>
+	<listitem>
+	  <para>
+	    Brand the exec with the thread that initiated it by
+	    setting argv[0] to the string TID:PID.
+	  </para>
+	</listitem>
       </varlistentry>
 
       <varlistentry>
-	<term><replaceable>PROGRAM-ARGS</replaceable></term>
-	<listitem><para>The program and arguments to pass to the exec
-	call.</para></listitem> </varlistentry>
+	<term>
+	  <replaceable>program</replaceable> <replaceable>arg</replaceable>...
+	</term>
+	<listitem>
+	  <para>
+	    The program and arguments to pass to the exec call.
+	  </para>
+	</listitem>
+      </varlistentry>
 
     </variablelist>
 
@@ -161,54 +216,15 @@
 </screen>
 
   </refsect1>
-   
-  <!-- refsect1>
-    <title>DIAGNOSTICS</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>ERRORS</title>
-    <variablelist>
-      <varlistentry>
-	<term>An error message.</term>
-	<listitem>
-          <para> This error can appear when Funit is terminated
-          abruptly (as during a loss of power).  Typically you need to
-          manually open the perspectives and views that you want.
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsect1 -->    
 
   <refsect1>
     <title>SEE ALSO</title>
     <para>frysk(7) funit(8)</para>
   </refsect1>
   
-  <!-- refsect1>
-    <title>STANDARDS</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>HISTORY</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>AUTHORS</title>
-    <para></para>
-  </refsect1 -->
-  
   <refsect1>
     <title>BUGS</title>
     <para>Report bugs to <ulink url="http:/sources.redhat.com/frysk"/></para>
   </refsect1>
-  
-  <!-- refsect1>
-    <title>SECURITY CONSIDERATIONS</title>
-  </refsect1 -->
 
 </refentry>
diff --git a/frysk-core/frysk/pkglibdir/funit-exit.xml-in b/frysk-core/frysk/pkglibdir/funit-exit.xml-in
index 513ab11..42bb49e 100644
--- a/frysk-core/frysk/pkglibdir/funit-exit.xml-in
+++ b/frysk-core/frysk/pkglibdir/funit-exit.xml-in
@@ -44,26 +44,34 @@
 -->
 
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
+ [
+ <!ENTITY version SYSTEM "@abs_root_srcdir@/common/version.in">
+ <!ENTITY command "funit-threads">
+ <!ENTITY volume "8">
+ ]
+>
 
-<!-- http://docbook.sourceforge.net/snapshots/xsl/manpages/README -->
-
-<refentry id="funit">
+<refentry>
 
   <refentryinfo>
-    <title>funit-exit</title>
-    <date>March 14 2008</date>
+    <title>Frysk</title>
+    <date>April 2008</date>
   </refentryinfo>
   
   <refmeta>
-    <refentrytitle>funit-exit</refentrytitle>
-    <manvolnum>8</manvolnum>
+    <refentrytitle>&command;</refentrytitle>
+    <manvolnum>&volume;</manvolnum>
+    <refmiscinfo class='source'>Frysk</refmiscinfo>
+    <refmiscinfo class='version'>&version;</refmiscinfo>
   </refmeta>
 
   <refnamediv>
     <refname>funit-exit</refname>
-    <refpurpose>exits with specified status,
-                or terminates with the specified signal</refpurpose>
+    <refpurpose>
+      exit with specified status, or terminate with the specified
+      signal
+    </refpurpose>
   </refnamediv>
   
   <refsynopsisdiv>
@@ -106,80 +114,21 @@
     </variablelist>
   </refsect1>
   
-  <!-- refsect1>
-    <title>EXIT STATUS</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>RETURN VALUES</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>ENVIRONMENT</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>FILES</title>
-    <para></para>
-  </refsect1 -->
-  
   <refsect1>
     <title>EXAMPLES</title>
     <para>Run the 32-bit version of the <command>funit-exit</command>
     program.</para>
     <screen>@pkglib32dir@/funit-exit 0</screen>
   </refsect1>
-   
-  <!-- refsect1>
-    <title>DIAGNOSTICS</title>
-    <para></para>
-  </refsect1 -->
-  
-  <!-- refsect1>
-    <title>ERRORS</title>
-    <variablelist>
-      <varlistentry>
-	<term>An error message.</term>
-	<listitem>
-          <para> This error can appear when Funit is terminated
-          abruptly (as during a loss of power).  Typically you need to
-          manually open the perspectives and views that you want.
-          </para>
-        </listitem>
-      </varlistentry>
-    </variablelist>


hooks/post-receive
--
frysk system monitor/debugger


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2008-04-08 17:13 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2008-04-08 17:13 [SCM] master: More man page cleanups cagney

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).