From c97e5cfe3c3b5bfc869a3464d9b6b855c7751e45 Mon Sep 17 00:00:00 2001 From: Nikola Pajkovsky Date: Tue, 10 May 2011 10:02:15 +0200 Subject: Ticket #232 document abrt-action-bugzilla Signed-off-by: Nikola Pajkovsky --- src/plugins/Makefile.am | 3 +- src/plugins/abrt-Bugzilla.7 | 43 ---------------- src/plugins/abrt-action-bugzilla.txt | 96 ++++++++++++++++++++++++++++++++++++ 3 files changed, 98 insertions(+), 44 deletions(-) delete mode 100644 src/plugins/abrt-Bugzilla.7 create mode 100644 src/plugins/abrt-action-bugzilla.txt (limited to 'src/plugins') diff --git a/src/plugins/Makefile.am b/src/plugins/Makefile.am index b0d93c8b..6360a32c 100644 --- a/src/plugins/Makefile.am +++ b/src/plugins/Makefile.am @@ -67,7 +67,8 @@ MAN_TXT = \ abrt-action-trim-files.txt \ abrt-action-generate-backtrace.txt \ abrt-action-analyze-backtrace.txt \ - abrt-action-mailx.txt + abrt-action-mailx.txt \ + abrt-action-bugzilla.txt # Manual pages are generated from .txt via Docbook man1_MANS = ${MAN_TXT:%.txt=%.1} diff --git a/src/plugins/abrt-Bugzilla.7 b/src/plugins/abrt-Bugzilla.7 deleted file mode 100644 index 708695c7..00000000 --- a/src/plugins/abrt-Bugzilla.7 +++ /dev/null @@ -1,43 +0,0 @@ -.TH abrt "7" "1 Jun 2009" "" -.SH NAME -Bugzilla plugin for abrt(8) -.SH DESCRIPTION -.P -.I abrt -is a daemon that watches for application crashes. When a crash occurs, -it collects the problem data and takes action according to -its configuration. This manual page describes the \fIBugzilla\fP plugin -for \fIabrt\fP. -.P -This plugin is used to report the crash to a Bugzilla instance. The -plugin will determine the package name and distribution version. The -problem data is attached to the bug report. -.SH INVOCATION -The plugin is invoked in the \fIabrt.conf\fP configuration file. -No parameters are necessary. -.SH CONFIGURATION -The \fIBugzilla.conf\fP configuration file contains several -entries in the format "Option = Value". The options are: -.SS BugzillaURL -The URL of the Bugzilla instance that you want to use, including the -path to the xmlrpc. The default is https://bugzilla.redhat.com/xmlrpc.cgi -.SS Login -Your Bugzilla login. If you have no Bugzilla account, you cannot -use the plugin. -.SS Password -Your Bugzilla password. -.SH EXAMPLES -.P -This is a snippet from the \fIabrt.conf\fP configuration file. -When something crashes, use the Bugzilla plugin: -.P -[common] -.br -ActionsAndReporters = Bugzilla -.SH "SEE ALSO" -.IR abrt (8), -.IR abrt.conf (5), -.IR abrt-plugins (7) -.SH AUTHOR -Written by Zdenek Prikryl . -Manual page written by Daniel Novotny . diff --git a/src/plugins/abrt-action-bugzilla.txt b/src/plugins/abrt-action-bugzilla.txt new file mode 100644 index 00000000..313e5b19 --- /dev/null +++ b/src/plugins/abrt-action-bugzilla.txt @@ -0,0 +1,96 @@ +abrt-action-buzilla(1) +==================== + +NAME +---- +abrt-action-bugzilla - Sends problem information to bugzilla. + +SYNOPSIS +-------- +'abrt-action-bugzilla' [-v] [-c CONFFILE] -d DIR + +DESCRIPTION +----------- +The tool reads a problem dump direcotry. Firstly, the tool is trying to find +duplication of bug. If duplication is 'not' found, then a new bug is created. +Otherwise if duplication 'is' found and bug is closed as duplication of the +other bug, than, so called, 'hoping' begin. It means, that tool is going to try +track the origin bug. + +Example of bug stages are: +------------ +CLOSED DUPLICATE -> CLOSED DUPLICATE -> NEW +------------ +Third one is the origin of the same problem. The tool adds a new comment to bug, +logouts from bugzilla and return link to bug. + +Properties of bugzilla can be specified in a configuration file, +and via environment variables. + +Configuration file +~~~~~~~~~~~~~~~~~~ +Configuration file contains entries in a format "Option = Value". + +The options are: + +'Login':: + Login to Bugzilla account. + +'Password':: + Password to Bugzilla account. + +'BugzillaURL':: + Bugzilla http address. (default: https://bugzilla.redht.com) + +'SSLVerify':: + Use yes/true/on/1 to verify Bugzilla ssl certificate. (default: yes) + +Integration with ABRT events +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +'abrt-action-bugzilla' can be used as a reporter, to allow users report +problems to bugzilla when they decide to do it. This usage is +pre-configured in /etc/abrt/events.d/ccpp_events.conf and +/etc/abrt/abrt_events.conf. + +For python problems (/etc/abrt/abrt_events.conf) +------------ +EVENT=report_Bugzilla analyzer=Python + abrt-action-bugzilla -c /etc/abrt/plugins/Bugzilla.conf +------------ + +For C/C++ problems (/etc/abrt/events.d/ccpp_events.conf) +------------ +EVENT=report_Bugzilla analyzer=CCpp + abrt-action-bugzilla -c /etc/abrt/plugins/Bugzilla.conf +------------ + +OPTIONS +------- +-d DIR:: + Path to dump directory. + +-c CONFFILE:: + Path to configration file. When used in ABRT event system, the file + contains site-wide configuration. Users can change the values via + environment variables. + +ENVIRONMENT VARIABLES +--------------------- +Environment variables take precedence over values provided in +the configuration file. + +'Bugzilla_Login':: + Login to Bugzilla account. + +'Bugzilla_Password':: + Password to Bugzilla account. + +'Bugzilla_BugzillaURL':: + Bugzilla http address. (default: https://bugzilla.redht.com) + +'Bugzilla_SSLVerify':: + Use yes/true/on/1 to verify Bugzilla ssl certificate. (default: yes) + +AUTHORS +------- +* ABRT team -- cgit