|
 |
78a2f7 |
From d20626db00428ccf0343ad4e87af6b59c00b2bf8 Mon Sep 17 00:00:00 2001
|
|
|
78a2f7 |
From: Jakub Filak <jfilak@redhat.com>
|
|
|
78a2f7 |
Date: Mon, 20 Jan 2014 09:54:48 +0100
|
|
|
78a2f7 |
Subject: [PATCH 35/39] Add a manual page for the analysis tool
|
|
|
78a2f7 |
|
|
|
78a2f7 |
Related to #29
|
|
|
78a2f7 |
Related to rhbz#1054737
|
|
|
78a2f7 |
---
|
|
|
78a2f7 |
utils/CMakeLists.txt | 2 +
|
|
|
78a2f7 |
utils/abrt-action-analyze-java.1 | 81 ++++++++++++++++++++++++++++++++++++++++
|
|
|
78a2f7 |
2 files changed, 83 insertions(+)
|
|
|
78a2f7 |
create mode 100644 utils/abrt-action-analyze-java.1
|
|
|
78a2f7 |
|
|
|
78a2f7 |
diff --git a/utils/CMakeLists.txt b/utils/CMakeLists.txt
|
|
|
78a2f7 |
index c358968..517c130 100644
|
|
|
78a2f7 |
--- a/utils/CMakeLists.txt
|
|
|
78a2f7 |
+++ b/utils/CMakeLists.txt
|
|
|
78a2f7 |
@@ -32,3 +32,5 @@ target_link_libraries(abrt-action-analyze-java ${PC_LIBREPORT_LIBRARIES})
|
|
|
78a2f7 |
target_link_libraries(abrt-action-analyze-java ${PC_ABRT_LIBRARIES})
|
|
|
78a2f7 |
|
|
|
78a2f7 |
install(TARGETS abrt-action-analyze-java DESTINATION ${BIN_INSTALL_DIR})
|
|
|
78a2f7 |
+
|
|
|
78a2f7 |
+install(FILES abrt-action-analyze-java.1 DESTINATION ${MAN_INSTALL_DIR}/man1)
|
|
|
78a2f7 |
diff --git a/utils/abrt-action-analyze-java.1 b/utils/abrt-action-analyze-java.1
|
|
|
78a2f7 |
new file mode 100644
|
|
|
78a2f7 |
index 0000000..eda4d6a
|
|
|
78a2f7 |
--- /dev/null
|
|
|
78a2f7 |
+++ b/utils/abrt-action-analyze-java.1
|
|
|
78a2f7 |
@@ -0,0 +1,81 @@
|
|
|
78a2f7 |
+'\" t
|
|
|
78a2f7 |
+.\" Title: abrt-action-analyze-java
|
|
|
78a2f7 |
+.\" Author: [see the "AUTHORS" section]
|
|
|
78a2f7 |
+.\" Date: 01/19/2014
|
|
|
78a2f7 |
+.\" Manual: ABRT Manual
|
|
|
78a2f7 |
+.\" Language: English
|
|
|
78a2f7 |
+.\"
|
|
|
78a2f7 |
+.TH "ABRT\-ACTION\-ANALYZ" "1" "01/19/2014" "abrt-java-connector" "ABRT Manual"
|
|
|
78a2f7 |
+.\" -----------------------------------------------------------------
|
|
|
78a2f7 |
+.\" * Define some portability stuff
|
|
|
78a2f7 |
+.\" -----------------------------------------------------------------
|
|
|
78a2f7 |
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
78a2f7 |
+.\" http://bugs.debian.org/507673
|
|
|
78a2f7 |
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
|
78a2f7 |
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
78a2f7 |
+.ie \n(.g .ds Aq \(aq
|
|
|
78a2f7 |
+.el .ds Aq '
|
|
|
78a2f7 |
+.\" -----------------------------------------------------------------
|
|
|
78a2f7 |
+.\" * set default formatting
|
|
|
78a2f7 |
+.\" -----------------------------------------------------------------
|
|
|
78a2f7 |
+.\" disable hyphenation
|
|
|
78a2f7 |
+.nh
|
|
|
78a2f7 |
+.\" disable justification (adjust text to left margin only)
|
|
|
78a2f7 |
+.ad l
|
|
|
78a2f7 |
+.\" -----------------------------------------------------------------
|
|
|
78a2f7 |
+.\" * MAIN CONTENT STARTS HERE *
|
|
|
78a2f7 |
+.\" -----------------------------------------------------------------
|
|
|
78a2f7 |
+.SH "NAME"
|
|
|
78a2f7 |
+abrt-action-analyze-java \- Calculate and save UUID & DUPHASH and determine the level of usability for reporting of a Java stack trace\&.
|
|
|
78a2f7 |
+.SH "SYNOPSIS"
|
|
|
78a2f7 |
+.sp
|
|
|
78a2f7 |
+\fIabrt\-action\-analyze\-java\fR [\-v] [\-d DIR] [\-o] [\-f FILE]
|
|
|
78a2f7 |
+.SH "DESCRIPTION"
|
|
|
78a2f7 |
+.sp
|
|
|
78a2f7 |
+The tool reads the file named \fIbacktrace\fR from a problem data directory, processes it and generates a universally unique identifier (UUID)\&. Then it saves this data as new element \fIuuid\fR\&. It also checks whether the stack trace contains a remote address in any of its frames and if so it creates \fInot-reportable\fR element whose contents explains why the stack trace should not be reported into a bug tracking system\&.
|
|
|
78a2f7 |
+.SS "Integration with ABRT events"
|
|
|
78a2f7 |
+.sp
|
|
|
78a2f7 |
+\fIabrt\-action\-analyze\-java\fR can be used to generate the UUID & DUPHAS of a newly saved Java stack trace\&.
|
|
|
78a2f7 |
+.sp
|
|
|
78a2f7 |
+.if n \{\
|
|
|
78a2f7 |
+.RS 4
|
|
|
78a2f7 |
+.\}
|
|
|
78a2f7 |
+.nf
|
|
|
78a2f7 |
+EVENT=post\-create analyzer=Java abrt\-action\-analyze\-java
|
|
|
78a2f7 |
+.fi
|
|
|
78a2f7 |
+.if n \{\
|
|
|
78a2f7 |
+.RE
|
|
|
78a2f7 |
+.\}
|
|
|
78a2f7 |
+.SH "OPTIONS"
|
|
|
78a2f7 |
+.PP
|
|
|
78a2f7 |
+\-d DIR
|
|
|
78a2f7 |
+.RS 4
|
|
|
78a2f7 |
+Path to a problem directory\&. The tool reads the backtrace from stdin when neither this option nor -f is provided\&.
|
|
|
78a2f7 |
+.RE
|
|
|
78a2f7 |
+.PP
|
|
|
78a2f7 |
+\-f FILE
|
|
|
78a2f7 |
+.RS 4
|
|
|
78a2f7 |
+Path to a stack trace\&. The tool reads the backtrace from stdin when neither this option nor -d is provided\&.
|
|
|
78a2f7 |
+.RE
|
|
|
78a2f7 |
+.PP
|
|
|
78a2f7 |
+\-o
|
|
|
78a2f7 |
+.RS 4
|
|
|
78a2f7 |
+Print the result to stdout\&.
|
|
|
78a2f7 |
+.RE
|
|
|
78a2f7 |
+.PP
|
|
|
78a2f7 |
+\-v
|
|
|
78a2f7 |
+.RS 4
|
|
|
78a2f7 |
+Be more verbose\&. Can be given multiple times\&.
|
|
|
78a2f7 |
+.RE
|
|
|
78a2f7 |
+.SH "AUTHORS"
|
|
|
78a2f7 |
+.sp
|
|
|
78a2f7 |
+.RS 4
|
|
|
78a2f7 |
+.ie n \{\
|
|
|
78a2f7 |
+\h'-04'\(bu\h'+03'\c
|
|
|
78a2f7 |
+.\}
|
|
|
78a2f7 |
+.el \{\
|
|
|
78a2f7 |
+.sp -1
|
|
|
78a2f7 |
+.IP \(bu 2.3
|
|
|
78a2f7 |
+.\}
|
|
|
78a2f7 |
+ABRT team
|
|
|
78a2f7 |
+.RE
|
|
|
78a2f7 |
--
|
|
|
78a2f7 |
1.8.3.1
|
|
|
78a2f7 |
|