[libapp-stacktrace-perl] 03/04: Normalize docs

[Axel Beckert]

This is an automated email from the git hooks/post-receive script.

abe pushed a commit to annotated tag v0.09
in repository libapp-stacktrace-perl.

commit 71ccb86ceab2841ca4bb0a2c9f1e7d3ae597cef5
Author: Josh ben Jore <jjore at cpan.org>
Date:   Tue Aug 2 08:40:06 2011 -0700

    Normalize docs
---
 bin/perl-stacktrace   | 32 +++++++++++++++++++++++++-------
 lib/App/Stacktrace.pm |  1 +
 2 files changed, 26 insertions(+), 7 deletions(-)

diff --git a/bin/perl-stacktrace b/bin/perl-stacktrace
index 65c4b18..b6ada29 100644
--- a/bin/perl-stacktrace
+++ b/bin/perl-stacktrace
@@ -4,18 +4,36 @@
 
 perl-stacktrace - Stack trace
 
+=head1 SYNOPSIS
+
+  perl-stacktrace [option] pid
+
+    -m      Prints a gdb script
+    -v      Verbose debugging
+    -c      Additionally, prints C stacktrace
+    --help  Show this help
+
+    --exec  exec() into gdb
+
 =head1 DESCRIPTION
 
-pstack prints Perl stack traces of Perl threads for a given Perl
-process. For each Perl frame, filename and line number, if available,
+perl-stacktrace prints Perl stack traces of Perl threads for a given
+Perl process. For each Perl frame, the full file name and line number
 are printed.
 
-=head1 SYNOPSIS
+For example, a stack dump of a running perl program:
+
+    $ ps x | grep cpan
+    24077 pts/12   T      0:01 /usr/local/bin/perl /usr/local/bin/cpan
+    24093 pts/12   S+     0:00 grep cpan
 
-  perl-stacktrace [pid]
-    --help
-    -m      Print gdb script
-    -v      Verbose
+    $ perl-stacktrace 24077
+    0x00d73416 in __kernel_vsyscall ()
+    /usr/local/bin/cpan:11
+    /usr/local/lib/perl5/5.12.2/App/Cpan.pm:364
+    /usr/local/lib/perl5/5.12.2/App/Cpan.pm:295
+    /usr/local/lib/perl5/5.12.2/CPAN.pm:339
+    /usr/local/lib/perl5/5.12.2/Term/ReadLine.pm:198
 
 =cut
 
diff --git a/lib/App/Stacktrace.pm b/lib/App/Stacktrace.pm
index 960efd3..8d633fc 100644
--- a/lib/App/Stacktrace.pm
+++ b/lib/App/Stacktrace.pm
@@ -10,6 +10,7 @@ App::Stacktrace - Stack trace
 
     -m      Prints a gdb script
     -v      Verbose debugging
+    -c      Additionally, prints C stacktrace
     --help  Show this help
 
     --exec  exec() into gdb

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libapp-stacktrace-perl.git