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/abrt-action-bugzilla.txt | 96 ++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 src/plugins/abrt-action-bugzilla.txt (limited to 'src/plugins/abrt-action-bugzilla.txt') 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