Bugreports

Version 5 (Paolo Cavallini, 12/27/2011 02:08 am)

1 1
h1. Bugreports - the redmine style
2 1
3 1
This page summarizes how to use redmine with QGIS and provides links to specific information about features and operating procedures.
4 1
5 1
h2. Login
6 1
7 1
You must have an OSGeo account and login in order to submit bug reports. To get started, first  create an OSGeo account.
8 1
https://www2.osgeo.org/cgi-bin/ldap_create_user.py
9 1
10 1
Once you have your account, use http://hub.qgis.org/projects/quantum-gis/issues to login and search if the issue you'd like to report is probably already entered.
11 1
12 1
h2. Tickets
13 1
14 3 Paolo Cavallini
Tickets are used to report bugs, request enhancements and submit patches. Redmine is more than a bug reporting system. Tickets can be associated with a  QGIS Milestone, allowing you to see progress towards completion. Completion of a Milestone not only requires closing bugs, but completing other tasks related to a release such as documentation, web site updates, packaging, and announcements.
15 1
16 1
h2. Opening a Ticket
17 1
18 3 Paolo Cavallini
Before filing a bug, review the currently open issues to make sure that you aren't creating a duplicate. If you have additional information on an issue, you can add it to the ticket. Third party plugins might also cause problems. If you have installed any, you should also verify that the problem is still reproducible without them.
19 5 Paolo Cavallini
Please don't report multiple unrelated bugs in a single bug report.
20 1
To report a bug choose New Issue from the menu bar. Note: You can also request an enhancement or submit a patch using the Ticket system.
21 1
22 1
Important information needed when opening a ticket:
23 5 Paolo Cavallini
* Tracker - choose the ticket type from the drop-down list
24 5 Paolo Cavallini
** Bug - bug
25 5 Paolo Cavallini
** Feature - new feature request
26 5 Paolo Cavallini
** Bounty - ticket for which a bounty has been defined
27 5 Paolo Cavallini
* Subject - a short description of the issue
28 5 Paolo Cavallini
* Description
29 5 Paolo Cavallini
Provide a full description of the problem including steps to repeat it; if you tink the bug could be related to a certain platform version or dependencies package version (GDAL, OGR, GEOS etc) include that as well.
30 5 Paolo Cavallini
If your QGIS crashes if might be useful to include a backtrace (see below) 
31 5 Paolo Cavallini
* Priority - provide an estimate of the severity of the problem
32 5 Paolo Cavallini
** Low - a problem which doesn't affect QGIS usefulness, and is presumably trivial to fix.
33 5 Paolo Cavallini
** Normal - the default value, applicable to most bugs.
34 5 Paolo Cavallini
** High - a bug which has a major effect on the usability of a package, without rendering it completely unusable to everyone.
35 5 Paolo Cavallini
** Urgent - makes QGIS unusable or mostly so, or causes data loss.
36 5 Paolo Cavallini
** Immediate - makes QGIS  totally unusable, or causes serious data loss.
37 5 Paolo Cavallini
* Component - Choose the aspect of the application that is most closely associated with the problem
38 5 Paolo Cavallini
* Milestone - If this issue affects a particular Milestone in the project choose it from the drop-down list
39 5 Paolo Cavallini
* Version of QGIS this issue affects
40 5 Paolo Cavallini
* Platform - Choose the platform you are using 
41 1
42 1
h2. Creating a backtrace
43 1
44 5 Paolo Cavallini
If you have a crash it might be useful to include a backtrace as the bug might be not reproducible on an other machine. On Unix you can create a backtrace using a core dump and gdb. A core dump is a memory dump of the state of the process when the crash happened.
45 5 Paolo Cavallini
Depending on you distribution the automatic creation of core dumps might be disabled. In that case you only see for instance Segmentation fault and not Segmentation fault (core dumped) in the shell you started QGIS from and you need to run ulimit -c unlimited before starting QGIS. You could also include that in your .profile.
46 5 Paolo Cavallini
Start qgis from the shell and repeat the steps to reproduce the crash. After the crash the core file will be located in the current directory.
47 5 Paolo Cavallini
To produce a backtrace from it you start gdb /path/to/the/qgis/binary core. The binary is usually /usr/bin/qgis or /usr/bin/qgis.bin on Debian with the GRASS plugin installed.
48 5 Paolo Cavallini
In gdb you run bt which will produce the backtrace.
49 1
50 5 Paolo Cavallini
h2. Creating a patch
51 1
52 5 Paolo Cavallini
To be done