summaryrefslogtreecommitdiffstats
path: root/contrib/gnatsparse/README
blob: 737bd18eb5e08225903b2e9a603f5402467d5332 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
gnatsparse
==========

Author: Daniel Berlin <dan@dberlin.org>

gnatsparse is a simple Python program that imports a GNATS database
into a Bugzilla system. It is based on the gnats2bz.pl Perl script
but it's a rewrite at the same time. Its parser is based on gnatsweb,
which gives a 10 times speed improvement compared to the previous code.

Features
--------

* Chunks audit trail into separate comments, with the right From's, times, etc.

* Handles followup emails that are in the report, with the right From's, times,
etc.

* Properly handles duplicates, adding the standard bugzilla duplicate message.

* Extracts and handles gnatsweb attachments, as well as uuencoded attachments
appearing in either followup emails, the how-to-repeat field, etc.  Replaces
them with a message to look at the attachments list, and adds the standard
"Created an attachment" message that bugzilla uses.  Handling them includes
giving them the right name and mime-type. "attachments" means multiple
uuencoded things/gnatsweb attachments are handled properly.

* Handles reopened bug reports.

* Builds the cc list from the people who have commented on the report,
and the reporter.

Requirements
------------

It requires python 2.2+, it won't work with 1.5.2 (Linux distributions
ship with 2.2+ these days, so that shouldn't be an issue).

Documentation
-------------

Documentation can be found inside the scripts. The source code is self
documenting.