From 1aff7ef0f75128b2b8d082fbd00b7655f25d2590 Mon Sep 17 00:00:00 2001
From: Denys Vlasenko <dvlasenk@redhat.com>
Date: Tue, 3 May 2011 22:07:13 +0200
Subject: add abrt-action-analyze-backtrace manpage. Closes #227

Signed-off-by: Denys Vlasenko <dvlasenk@redhat.com>
---
 src/plugins/Makefile.am                       |  1 +
 src/plugins/abrt-action-analyze-backtrace.c   |  2 +-
 src/plugins/abrt-action-analyze-backtrace.txt | 53 +++++++++++++++++++++++++++
 3 files changed, 55 insertions(+), 1 deletion(-)
 create mode 100644 src/plugins/abrt-action-analyze-backtrace.txt

(limited to 'src/plugins')

diff --git a/src/plugins/Makefile.am b/src/plugins/Makefile.am
index 8744a7d9..482ac39f 100644
--- a/src/plugins/Makefile.am
+++ b/src/plugins/Makefile.am
@@ -61,6 +61,7 @@ man_MANS = \
     abrt-plugins.7
 
 MAN_TXT = \
+    abrt-action-analyze-backtrace.txt \
     abrt-action-mailx.txt
 
 # Manual pages are generated from .txt via Docbook
diff --git a/src/plugins/abrt-action-analyze-backtrace.c b/src/plugins/abrt-action-analyze-backtrace.c
index f25f379c..0e41b6eb 100644
--- a/src/plugins/abrt-action-analyze-backtrace.c
+++ b/src/plugins/abrt-action-analyze-backtrace.c
@@ -21,7 +21,7 @@
 #include "../btparser/location.h"
 #include "parse_options.h"
 
-#define PROGNAME "abrt-action-generate-backtrace"
+#define PROGNAME "abrt-action-analyze-backtrace"
 
 static const char *dump_dir_name = ".";
 
diff --git a/src/plugins/abrt-action-analyze-backtrace.txt b/src/plugins/abrt-action-analyze-backtrace.txt
new file mode 100644
index 00000000..7a3f096c
--- /dev/null
+++ b/src/plugins/abrt-action-analyze-backtrace.txt
@@ -0,0 +1,53 @@
+abrt-action-analyze-backtrace(1)
+================================
+
+NAME
+----
+abrt-action-analyze-backtrace - Analyzes C/C++ backtrace, generates
+duplication hash, backtrace rating, and identifies crash function
+in dump directory DIR.
+
+
+SYNOPSIS
+--------
+'abrt-action-analyze-backtrace' [-v] [-d DIR]
+
+DESCRIPTION
+-----------
+The tool reads a file named 'backtrace' from problem dump directory,
+generates duplication hash, backtrace rating, and identifies
+crash function. Then it saves this data as new elements 'global_uuid',
+'rating', 'crash_function' in this dump directory.
+
+Integration with ABRT events
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+'abrt-action-analyze-backtrace' can be used as a secondary analyzer,
+after backtrace has been generated. The data generated by
+'abrt-action-analyze-backtrace' is useful for reporting the crash
+to bug databases: rating makes it possible to prevent reporting of bugs
+with low quality (non-informative) backtraces, duplication hash
+is used to find already filed bugs about similar crashes.
+
+Example usage in abrt_event.conf:
+
+------------
+EVENT=analyze analyzer=CCpp
+        abrt-action-generate-backtrace || exit $?
+        abrt-action-analyze-backtrace
+------------
+
+OPTIONS
+-------
+-d DIR::
+   Path to dump directory.
+
+-v::
+   Be more verbose. Can be given multiple times.
+
+AUTHORS
+-------
+* ABRT team
+
+SEE ALSO
+--------
+abrt-action-generate-backtrace
-- 
cgit