public inbox for frysk-cvs@sourceware.org
help / color / mirror / Atom feed
From: cagney@sourceware.org
To: frysk-cvs@sourceware.org
Subject: [SCM]  master: Implement man-page includes using fstack as an example.
Date: Mon, 31 Mar 2008 18:44:00 -0000	[thread overview]
Message-ID: <20080331184414.23202.qmail@sourceware.org> (raw)

The branch, master has been updated
       via  888eca8cb8d14ed37d0901755701c817d79381fe (commit)
      from  8983411653f8a41593abda4232dab5525c617e47 (commit)

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

- Log -----------------------------------------------------------------
commit 888eca8cb8d14ed37d0901755701c817d79381fe
Author: Andrew Cagney <cagney@redhat.com>
Date:   Mon Mar 31 14:42:51 2008 -0400

    Implement man-page includes using fstack as an example.
    
    frysk-core/frysk/bindir/ChangeLog
    2008-03-31  Andrew Cagney  <cagney@redhat.com>
    
    	* fstack.xml: Use stack-options.xml, standard-options.xml, and
    	version.in.
    
    frysk-core/frysk/util/ChangeLog
    2008-03-31  Andrew Cagney  <cagney@redhat.com>
    
    	* standard-options.xml: New.
    	* stack-options.xml: New.

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

Summary of changes:
 frysk-core/frysk/bindir/ChangeLog                  |    5 +
 frysk-core/frysk/bindir/fstack.xml                 |   49 ++++-------
 frysk-core/frysk/util/ChangeLog                    |    5 +
 .../frysk/util/stack-options.xml                   |   92 ++++++++------------
 .../frysk/util/standard-options.xml                |   83 ++++++------------
 5 files changed, 92 insertions(+), 142 deletions(-)
 copy frysk-common/frysk.xml => frysk-core/frysk/util/stack-options.xml (56%)
 copy frysk-common/frysk.xml => frysk-core/frysk/util/standard-options.xml (62%)

First 500 lines of diff:
diff --git a/frysk-core/frysk/bindir/ChangeLog b/frysk-core/frysk/bindir/ChangeLog
index a5d7c1d..aec0252 100644
--- a/frysk-core/frysk/bindir/ChangeLog
+++ b/frysk-core/frysk/bindir/ChangeLog
@@ -1,3 +1,8 @@
+2008-03-31  Andrew Cagney  <cagney@redhat.com>
+
+	* fstack.xml: Use stack-options.xml, standard-options.xml, and
+	version.in.
+
 2008-03-27  Stan Cox  <scox@redhat.com>
 
 	* fexe.java (executeLive): Also show sysrooted exe path.
diff --git a/frysk-core/frysk/bindir/fstack.xml b/frysk-core/frysk/bindir/fstack.xml
index aaba593..6dca143 100644
--- a/frysk-core/frysk/bindir/fstack.xml
+++ b/frysk-core/frysk/bindir/fstack.xml
@@ -44,20 +44,27 @@
 -->
 
 <!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"
 
-<!-- http://docbook.sourceforge.net/snapshots/xsl/manpages/README -->
+ [
+ <!ENTITY stackoptions SYSTEM "@abs_srcdir@/frysk/util/stack-options.xml">
+ <!ENTITY standardoptions SYSTEM "@abs_srcdir@/frysk/util/standard-options.xml">
+ <!ENTITY version SYSTEM "@abs_srcdir@/common/version.in">
+ ]
+>
 
 <refentry id="fstack">
 
   <refentryinfo>
-    <title>fstack</title>
-    <date>March 14 2008</date>
+    <title>Frysk Utilities</title>
+    <date>March 31 2008</date>
   </refentryinfo>
   
   <refmeta>
     <refentrytitle>fstack</refentrytitle>
     <manvolnum>1</manvolnum>
+    <refmiscinfo class='source'>Frysk</refmiscinfo>
+    <refmiscinfo class='version'>&version;</refmiscinfo>
   </refmeta>
 
   <refnamediv>
@@ -68,43 +75,21 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>fstack</command>
-       <arg choice="opt">
-        <option>--console <replaceable>LOG=LEVEL,...</replaceable></option>
-      </arg>
-      <arg choice="opt">
-        <option>--log <replaceable>LOG=LEVEL,...</replaceable></option>
-      </arg>
       <arg rep="repeat" choice="plain">
         <replaceable>pids</replaceable>
       </arg>
-      <!-- arg choice="opt">
-        <option>-list of options</option>
-      </arg -->
     </cmdsynopsis>
   </refsynopsisdiv>
   
   <refsect1>
     <title>DESCRIPTION</title>
 
-    <para><function>fstack</function> Runs the frysk stack tracing utility.</para>
-
-    <para>fstack is a small utility that uses the frysk engine to display a process stack in a similar manner to pstack. </para>
-
-    <variablelist>
-    <varlistentry>
-	<term><option>--console <replaceable>LOG=LEVEL,...</replaceable></option></term>
-	<listitem>
-          <para> Enable logging to the console and at the specified
-          log level. The log level can be: [ OFF | SEVERE | WARNING | INFO | CONFIG | FINE | FINER | FINEST]. </para>
-        </listitem>
-      </varlistentry>
-      <varlistentry>
-	<term><option>--log <replaceable>LOG=LEVEL,...</replaceable></option></term>
-	<listitem>
-          <para> Specify the file logging level. The log level can be: [ OFF | SEVERE | WARNING | INFO | CONFIG | FINE | FINER | FINEST].</para>
-        </listitem>
-      </varlistentry>      
-    </variablelist>
+    <para><function>fstack</function> prints a stack back-trace of the
+    specified process, or core-file's threads.</para>
+
+    &stackoptions;
+    &standardoptions;
+
   </refsect1>
   
   <!-- refsect1>
diff --git a/frysk-core/frysk/util/ChangeLog b/frysk-core/frysk/util/ChangeLog
index fc7c4ee..76cf8eb 100644
--- a/frysk-core/frysk/util/ChangeLog
+++ b/frysk-core/frysk/util/ChangeLog
@@ -1,3 +1,8 @@
+2008-03-31  Andrew Cagney  <cagney@redhat.com>
+
+	* standard-options.xml: New.
+	* stack-options.xml: New.
+
 2008-03-31  Mark Wielaard  <mwielaard@redhat.com>
 
 	* ProcFollowUtil.java (updateForkedOffspring): Remove debug output.
diff --git a/frysk-common/frysk.xml b/frysk-core/frysk/util/stack-options.xml
similarity index 56%
copy from frysk-common/frysk.xml
copy to frysk-core/frysk/util/stack-options.xml
index 404b014..d2a246b 100644
--- a/frysk-common/frysk.xml
+++ b/frysk-core/frysk/util/stack-options.xml
@@ -1,5 +1,3 @@
-<?xml version='1.0'?> <!-- -*- xml -*- -->
-
 <!--
 
  This file is part of the program FRYSK.
@@ -43,62 +41,46 @@
 
 -->
 
-<!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 -->
-
-<refentry id="frysk">
+<para>Stack print options:</para>
 
-  <refentryinfo>
-    <title>fhpd</title>
-    <date>March 14 2008</date>
-  </refentryinfo>
-  
-  <refmeta>
-    <refentrytitle>frysk</refentrytitle>
-    <manvolnum>7</manvolnum>
-  </refmeta>
+<variablelist>
 
-  <refnamediv>
-    <refname>frysk</refname>
-    <refpurpose>The Frysk Debugging, Tracing, and Monitoring Tool Suite</refpurpose>
-  </refnamediv>
-  
-  <refsect1>
-    <title>DESCRIPTION</title>
+  <varlistentry>
+    <term><option>-number-of-frames <replaceable>count</replaceable></option></term>
+    <listitem>
+    <para>Limit the back-trace to <replaceable>count</replaceable>
+    frames.  The default is to limit the back-trace to 10 frames.
+    Specify 0 or "all" to print all frames.</para></listitem>
+  </varlistentry>
 
-    <para>The Frysk Tool Suite provides a collection of command line
-    and gnome utilities for the debugging, tracing, and monitoring of
-    user programs.</para>
+  <varlistentry>
+    <term><option>-lite</option></term>
+    <listitem>
+    <para>Perform a light-weight stack backtrace containing only
+    minimal information.  Equivalent to <command>-print
+    -</command>.</para></listitem>
+  </varlistentry>
 
-  </refsect1>
+  <varlistentry>
+    <term><option>-rich</option></term>
+    <listitem>
+    <para>Perform a detailed stack back-trace that includes, where
+    possible, inlined function calls, parameter names and values, and
+    debug-names.  Equivalent to <command>-print
+    inline,params,debug-names</command>.</para></listitem>
+  </varlistentry>
 
-  <refsect1>
-    <title>SEE ALSO</title>
-    <para>
-funit(8)
-fauxv(1)
-fcatch(1)
-fcore(1)
-fdebuginfo(1)
-ferror(1)
-fexe(1)
-fhpd(1)
-fmaps(1)
-fparser(1)
-fstack(1)
-fstep(1)
-ftrace(1)
-fdebugrpm(1)
-    </para>
-  </refsect1>
-  
-  <refsect1>
-    <title>BUGS</title>
-    <para>Report bugs to 
-    <ulink url="http://sourceware.org/frysk"></ulink>
-    </para>
-  </refsect1>
+  <varlistentry>
+    <term><option>-print <replaceable>print-option</replaceable>,...</option></term>
+    <listitem>
+    <para>Specify the level of detail to include in a stack
+    back-trace.  <replaceable>print-option</replaceable> can be any
+    of: debug-names - use debug information, such as DWARF, to
+    determine the name of functions; full-path - do not truncate file
+    paths; inline - include in-line function in back-trace; params -
+    include the values of any parameters.  To negate
+    a <replaceable>print-option</replaceable> prefix it with
+    "-".</para></listitem>
+  </varlistentry>
 
-</refentry>
+</variablelist>
diff --git a/frysk-common/frysk.xml b/frysk-core/frysk/util/standard-options.xml
similarity index 62%
copy from frysk-common/frysk.xml
copy to frysk-core/frysk/util/standard-options.xml
index 404b014..3e5f85f 100644
--- a/frysk-common/frysk.xml
+++ b/frysk-core/frysk/util/standard-options.xml
@@ -1,5 +1,3 @@
-<?xml version='1.0'?> <!-- -*- xml -*- -->
-
 <!--
 
  This file is part of the program FRYSK.
@@ -43,62 +41,37 @@
 
 -->
 
-<!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 -->
-
-<refentry id="frysk">
+<para>Standard Frysk options:</para>
 
-  <refentryinfo>
-    <title>fhpd</title>
-    <date>March 14 2008</date>
-  </refentryinfo>
-  
-  <refmeta>
-    <refentrytitle>frysk</refentrytitle>
-    <manvolnum>7</manvolnum>
-  </refmeta>
+<variablelist>
 
-  <refnamediv>
-    <refname>frysk</refname>
-    <refpurpose>The Frysk Debugging, Tracing, and Monitoring Tool Suite</refpurpose>
-  </refnamediv>
-  
-  <refsect1>
-    <title>DESCRIPTION</title>
+  <varlistentry>
+    <term><option>-exe</option></term>
+    <listitem><para>The full path of the executable to
+    read.</para></listitem>
+  </varlistentry>
 
-    <para>The Frysk Tool Suite provides a collection of command line
-    and gnome utilities for the debugging, tracing, and monitoring of
-    user programs.</para>
+  <varlistentry>
+    <term><option>-noexe</option></term>
+    <listitem><para>Do not attempt to read the corresponding
+    executable when loading a core file.</para></listitem>
+  </varlistentry>
 
-  </refsect1>
+  <varlistentry>
+    <term><option>-sysroot <replaceable>directory</replaceable></option></term>
+    <listitem><para>The system root directory under which all
+    executables, libraries, and source are located.</para></listitem>
+  </varlistentry>
 
-  <refsect1>
-    <title>SEE ALSO</title>
-    <para>
-funit(8)
-fauxv(1)
-fcatch(1)
-fcore(1)
-fdebuginfo(1)
-ferror(1)
-fexe(1)
-fhpd(1)
-fmaps(1)
-fparser(1)
-fstack(1)
-fstep(1)
-ftrace(1)
-fdebugrpm(1)
-    </para>
-  </refsect1>
-  
-  <refsect1>
-    <title>BUGS</title>
-    <para>Report bugs to 
-    <ulink url="http://sourceware.org/frysk"></ulink>
-    </para>
-  </refsect1>
+  <varlistentry>
+    <term><option>-debug <replaceable>class</replaceable>=<replaceable>level</replaceable>...</option></term>
+    <listitem><para>Set internal debug-tracing of the specified
+    Java <replaceable>class</replaceable>
+    to <replaceable>level</replaceable> (level can be NONE, INFO,
+    WARNING, FINE, and FINEST).  If
+    the <replaceable>level</replaceable> is absent, FINE is assumed;
+    if the <replaceable>class</replaceable> is absent, the global
+    level is set.</para></listitem>
+  </varlistentry>
 
-</refentry>
+</variablelist>


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


                 reply	other threads:[~2008-03-31 18:44 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20080331184414.23202.qmail@sourceware.org \
    --to=cagney@sourceware.org \
    --cc=frysk-cvs@sourceware.org \
    --cc=frysk@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).