Difference between revisions of "Reporting Bugs"

From Navit's Wiki
Jump to: navigation, search
m (Navigation errors: Typo)
(Reporting a bug: Layout)
Line 9: Line 9:
 
Note that you can also head over to the [[Contacts#IRC| IRC channel]] if you want to discuss the bug before submitting a report - for example, it may just be that your local configuration is wrong, which can quickly be diagnosed by the developers on the channel. If there is a bug in Navit, it often gets fixed on the spot if reported on the [[Contacts#IRC | IRC channel]].
 
Note that you can also head over to the [[Contacts#IRC| IRC channel]] if you want to discuss the bug before submitting a report - for example, it may just be that your local configuration is wrong, which can quickly be diagnosed by the developers on the channel. If there is a bug in Navit, it often gets fixed on the spot if reported on the [[Contacts#IRC | IRC channel]].
  
==Additional information you should provide==
+
=Information you should provide=
 
The following information for each type of problem will enable the developers to very quickly isolate the section of code which is causing problems, and hopefully fix it. Please provide the requested information in your bug report.
 
The following information for each type of problem will enable the developers to very quickly isolate the section of code which is causing problems, and hopefully fix it. Please provide the requested information in your bug report.
  
===For compile/install problems===
+
==For compile/install problems==
 
Make sure you have re-run ''autogen.sh'' and ''configure'' after an svn update
 
Make sure you have re-run ''autogen.sh'' and ''configure'' after an svn update
 
  ~$ svn up && ./autogen.sh && ./configure
 
  ~$ svn up && ./autogen.sh && ./configure
Line 21: Line 21:
 
* The complete output of make (if you don't know how to do this, leave this step out).
 
* The complete output of make (if you don't know how to do this, leave this step out).
  
===For usage problems===
+
==For usage problems==
 
* Which version of navit you are using, and whether you have compiled it yourself or where you downloaded the install file from.
 
* Which version of navit you are using, and whether you have compiled it yourself or where you downloaded the install file from.
 
* What operating system and distribution you are using, and what platform.
 
* What operating system and distribution you are using, and what platform.
Line 30: Line 30:
 
In addition, please provide the following (where appropriate):
 
In addition, please provide the following (where appropriate):
  
====Reporting coordinates for problems====
+
===Reporting coordinates for problems===
 
Assuming a fresh install of Navit:
 
Assuming a fresh install of Navit:
 
* '''GTK GUI''':  
 
* '''GTK GUI''':  
Line 43: Line 43:
 
You could add a bookmark to save you from writing down the coordinates.
 
You could add a bookmark to save you from writing down the coordinates.
  
====Routing errors====
+
===Routing errors===
 
Problems may include illegal routes (such as the wrong way on a one-way road), routes which are sub-optimum or no route found at all!
 
Problems may include illegal routes (such as the wrong way on a one-way road), routes which are sub-optimum or no route found at all!
 
* [[#Reporting coordinates for problems| Report the coordinates of your position and your destination]].
 
* [[#Reporting coordinates for problems| Report the coordinates of your position and your destination]].
Line 49: Line 49:
 
* If you are able to route, but there is something wrong with the route, report what Navit gave you and what you expected.
 
* If you are able to route, but there is something wrong with the route, report what Navit gave you and what you expected.
  
====Navigation errors====
+
===Navigation errors===
 
Problems may include missing announcements, wrong and/or misleading announcements, and unnecessary announcements.
 
Problems may include missing announcements, wrong and/or misleading announcements, and unnecessary announcements.
 
Please enable the navigation map to diagnose such problems.
 
Please enable the navigation map to diagnose such problems.
Line 67: Line 67:
 
Note that quite a few navigation problems occur due to bad map data - this can only be solved by improving the data in [http://www.openstreetmap.org OpenStreetMap]
 
Note that quite a few navigation problems occur due to bad map data - this can only be solved by improving the data in [http://www.openstreetmap.org OpenStreetMap]
  
====Tracking errors====
+
===Tracking errors===
 
Problems may include the indication of an incorrect vehicle position, or jumping between correct and incorrect positions.
 
Problems may include the indication of an incorrect vehicle position, or jumping between correct and incorrect positions.
 
* [[#Reporting coordinates for problems| Report the coordinate(s) where the error occurs, where you came from and your destination (if routing was enabled)]].
 
* [[#Reporting coordinates for problems| Report the coordinate(s) where the error occurs, where you came from and your destination (if routing was enabled)]].
Line 73: Line 73:
 
* If an incorrect vehicle position was shown, specify where you were in real-life, and where Navit indicated you to be.
 
* If an incorrect vehicle position was shown, specify where you were in real-life, and where Navit indicated you to be.
  
====Announcement errors====
+
===Announcement errors===
 
Problems may include announcements too early, announcements too late, incorrect announcements, repeated announcements, missing announcements etc.
 
Problems may include announcements too early, announcements too late, incorrect announcements, repeated announcements, missing announcements etc.
 
* First try to determine whether this isn't a [[#Tracking errors| tracking]] and or [[#Navigation | navigation]] problem.
 
* First try to determine whether this isn't a [[#Tracking errors| tracking]] and or [[#Navigation | navigation]] problem.

Revision as of 19:32, 13 January 2011

All bugs and feature requests are to be reported to the Navit developers through Trac. Please read the guidlines below before submitting your bug - this is so that the developers receive a clear and helpful bug report.

Reporting a bug

  1. Register on this wiki, choosing a suitable username and password
  2. Head over to http://trac.navit-project.org and login with the same username and password
  3. Read the guidelines below
  4. Create and compile your bug report, and submit it

Note that you can also head over to the IRC channel if you want to discuss the bug before submitting a report - for example, it may just be that your local configuration is wrong, which can quickly be diagnosed by the developers on the channel. If there is a bug in Navit, it often gets fixed on the spot if reported on the IRC channel.

Information you should provide

The following information for each type of problem will enable the developers to very quickly isolate the section of code which is causing problems, and hopefully fix it. Please provide the requested information in your bug report.

For compile/install problems

Make sure you have re-run autogen.sh and configure after an svn update

~$ svn up && ./autogen.sh && ./configure
  • Which version of navit you are using.
  • What operating system and distribution you are using, and what platform.
  • The source of the sourcecode or installation files (provide a link if possible).
  • The complete output of configure (if you don't know how to do this, leave this step out).
  • The complete output of make (if you don't know how to do this, leave this step out).

For usage problems

  • Which version of navit you are using, and whether you have compiled it yourself or where you downloaded the install file from.
  • What operating system and distribution you are using, and what platform.
  • The output of the locale command if using an Unix-based OS (Linux/Mac).
  • Preferably include your complete navit.xml, or at least what you have changed in the shipped navit.xml (as verbose as possible). Please attach this to the ticket.
  • What maps you have used, and where you have downloaded them from (if applicable).

In addition, please provide the following (where appropriate):

Reporting coordinates for problems

Assuming a fresh install of Navit:

  • GTK GUI:
    1. Right click on the map at the specific position.
    2. The first item on the context menu is Point - enter this submenu.
    3. The coordinates are shown as the second and third items of the subsequent menu (Degrees/Minutes/Seconds format and decimal degrees format respectively)
  • Internal GUI:
    1. Drag and zoom the map to the right coordinate, and enter the menu by clicking on the map at correct position.
    2. Go into the Actions Menu.
    3. The coordinates are displayed under the globe in Degrees/Minutes/Seconds format.

You could add a bookmark to save you from writing down the coordinates.

Routing errors

Problems may include illegal routes (such as the wrong way on a one-way road), routes which are sub-optimum or no route found at all!

Navigation errors

Problems may include missing announcements, wrong and/or misleading announcements, and unnecessary announcements. Please enable the navigation map to diagnose such problems.

  • GTK GUI:
    1. Click on the Map item in the toolbar.
    2. Enable the navigation:' map.
  • Internal GUI:
    1. Click anywhere on the map to enter the menu.
    2. Enter the Settings submenu, followed by the Maps submenu.
    3. Enable the Navigation map.

You should see a navigation symbol at every point where an action is required. If the map looks correct, but Navit provided an incorrect announcement, the problem is most likely tracking and/or announcement related

Note that quite a few navigation problems occur due to bad map data - this can only be solved by improving the data in OpenStreetMap

Tracking errors

Problems may include the indication of an incorrect vehicle position, or jumping between correct and incorrect positions.

Announcement errors

Problems may include announcements too early, announcements too late, incorrect announcements, repeated announcements, missing announcements etc.