summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDenys Vlasenko <dvlasenk@redhat.com>2011-05-19 13:37:09 +0200
committerDenys Vlasenko <dvlasenk@redhat.com>2011-05-19 13:37:09 +0200
commit643d9abf858e979a19fbd85ecc386d167fe384d3 (patch)
treede89cfc51f8d3758dff65e3d7b4c2c2955d4b5f5 /src
parent9db9c8de91981886a8ac9678b36390e6346bf335 (diff)
downloadabrt-643d9abf858e979a19fbd85ecc386d167fe384d3.tar.gz
abrt-643d9abf858e979a19fbd85ecc386d167fe384d3.tar.xz
abrt-643d9abf858e979a19fbd85ecc386d167fe384d3.zip
abrt-action-bugzilla: better help/manpage. Closes bz#557943
Signed-off-by: Denys Vlasenko <dvlasenk@redhat.com>
Diffstat (limited to 'src')
-rw-r--r--src/plugins/abrt-action-bugzilla.c21
-rw-r--r--src/plugins/abrt-action-bugzilla.txt77
2 files changed, 44 insertions, 54 deletions
diff --git a/src/plugins/abrt-action-bugzilla.c b/src/plugins/abrt-action-bugzilla.c
index e56ce99b..53b48cf0 100644
--- a/src/plugins/abrt-action-bugzilla.c
+++ b/src/plugins/abrt-action-bugzilla.c
@@ -235,7 +235,26 @@ int main(int argc, char **argv)
const char *program_usage_string = _(
"\b [-v] -c CONFFILE -d DIR\n"
"\n"
- "Reports problem to Bugzilla"
+ "Reports problem to Bugzilla.\n"
+ "\n"
+ "The tool reads DIR. Then it logs in to Bugzilla and tries to find a bug\n"
+ "with the same abrt_hash:HEXSTRING in 'Whiteboard'.\n"
+ "\n"
+ "If such bug is not found, then a new bug is created. Elements of DIR\n"
+ "are stored in the bug as part of bug description or as attachments,\n"
+ "depending on their type and size.\n"
+ "\n"
+ "Otherwise, if such bug is found and it is marked as CLOSED DUPLICATE,\n"
+ "the tool follows the chain of duplicates until it finds a non-DUPLICATE bug.\n"
+ "The tool adds a new comment to found bug.\n"
+ "\n"
+ "The URL to new or modified bug is printed to stdout and recorded in\n"
+ "'reported_to' element.\n"
+ "\n"
+ "CONFFILE lines should have 'PARAM = VALUE' format.\n"
+ "Recognized string parameters: BugzillaURL, Login, Password.\n"
+ "Recognized boolean parameter (VALUE should be 1/0, yes/no): SSLVerify.\n"
+ "Parameters can be overridded via $Bugzilla_PARAM environment variables."
);
enum {
OPT_v = 1 << 0,
diff --git a/src/plugins/abrt-action-bugzilla.txt b/src/plugins/abrt-action-bugzilla.txt
index 313e5b19..3dca857e 100644
--- a/src/plugins/abrt-action-bugzilla.txt
+++ b/src/plugins/abrt-action-bugzilla.txt
@@ -3,7 +3,7 @@ abrt-action-buzilla(1)
NAME
----
-abrt-action-bugzilla - Sends problem information to bugzilla.
+abrt-action-bugzilla - Reports problem to Bugzilla.
SYNOPSIS
--------
@@ -11,27 +11,23 @@ SYNOPSIS
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.
+The tool reads problem dump directory DIR. Then it logs in to Bugzilla
+and tries to find a bug with the same abrt_hash:HEXSTRING in 'Whiteboard'.
-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.
+If such bug is not found, then a new bug is created. Elements of DIR
+are stored in the bug as part of bug description or as attachments,
+depending on their type and size.
+
+Otherwise, if such bug is found and it is marked as CLOSED DUPLICATE,
+the tool follows the chain of duplicates until it finds a non-DUPLICATE bug.
+The tool adds a new comment to found bug.
-Properties of bugzilla can be specified in a configuration file,
-and via environment variables.
+The URL to new or modified bug is printed to stdout and recorded in
+'reported_to' element in DIR.
Configuration file
~~~~~~~~~~~~~~~~~~
-Configuration file contains entries in a format "Option = Value".
-
-The options are:
+Configuration file lines should have 'PARAM = VALUE' format. The parameters are:
'Login'::
Login to Bugzilla account.
@@ -40,28 +36,22 @@ The options are:
Password to Bugzilla account.
'BugzillaURL'::
- Bugzilla http address. (default: https://bugzilla.redht.com)
+ Bugzilla http(s) address. (default: https://bugzilla.redht.com)
'SSLVerify'::
Use yes/true/on/1 to verify Bugzilla ssl certificate. (default: yes)
+Parameters can be overridded via $Bugzilla_PARAM environment variables.
+
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.
+'abrt-action-bugzilla' can be used as an ABRT reporter. Example
+fragment for /etc/abrt/abrt_events.conf:
-For python problems (/etc/abrt/abrt_events.conf)
------------
+# Report Python crashes
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
+ abrt-action-bugzilla -d . -c /etc/abrt/plugins/Bugzilla.conf
------------
OPTIONS
@@ -70,27 +60,8 @@ OPTIONS
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.
+ Path to configration 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
+SEE ALSO
+--------
+abrt_event.conf