Difference between revisions of "Reporting Bugs"

From Navit's Wiki
Jump to: navigation, search
(Mention forum, autotools -> cmake)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
All bugs and feature requests are to be reported to the Navit developers through [http://trac.navit-project.org Trac]. Please read the guidlines below before submitting your bug - this is so that the developers receive a clear and helpful bug report.
+
All bugs and feature requests are to be reported to the Navit developers through [http://trac.navit-project.org Trac] or [https://github.com/navit-gps/navit/issues Github issues]. 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=
 
=Reporting a bug=
 +
{{note
 +
|You should also head over to the [[Contacts#Forums|Forums]] or 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.
 +
}}
 +
 
# Register on this wiki, choosing a suitable username and password
 
# Register on this wiki, choosing a suitable username and password
# Head over to http://trac.navit-project.org and login with the same username and password
+
# Ask at [http://forum.navit-project.org/ forum] or [[Contacts|IRC]] for feedback/if bug is known
 +
# Head over to http://trac.navit-project.org or https://github.com/navit-gps/navit/issues and search for existing tickets on that bug
 +
# When going on trac.navit-project.org, login via openid and your wiki profiles URL e.g ''http://wiki.navit-project.org/index.php/User:cp15''
 
# '''Read the guidelines below'''
 
# '''Read the guidelines below'''
# Create and compile your bug report, and submit it
+
# Create and compile your bug report, and submit it via g pull request on Github
 
+
# Be patient and wait on feedback and discussion (usually after some days)
Note: It doesn't seem possible to log in at the moment (17 Jan 2013) into the Trac system using the Navit wiki accounts. The only available option is an OpenID account. I wish someone would amend the Trac front page with this information as well - as I've spent a lot of time looking for a way to log into the Trac system using the Navit wiki account.
+
# Help to reproduce the bug or give more details on your idea
 
 
Note that you can also head over to the [[Contacts#IRC| IRC channel]] or to the [[Contacts#Forums|Forums]] 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]].
 
  
 
=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==
 
First, please perform a "clean" build: Delete and recreate your build directory, then perform a complete build (cmake + make). Normally, re-running ''cmake'' after an svn update or other change should be enough, but if you run into problems, a clean build is better.
 
* 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==
 
==For usage problems==
Line 32: Line 28:
  
 
===Reporting coordinates for problems===
 
===Reporting coordinates for problems===
Assuming a fresh install of Navit:
+
Assuming you are using [[OpenStreetMap]] map packages:
* '''GTK GUI''':  
+
# Browse at http://www.openstreetmap.org to the area
*# Right click on the map at the specific position.
+
# Pick the "share" tool from the right toolbox.
*# The first item on the context menu is ''Point'' - enter this submenu.
+
# Copy the link from the editbox
*# 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''':
 
*# Drag and zoom the map to the right coordinate, and enter the menu by clicking on the map at correct position.
 
*# Go into the ''Actions Menu''.
 
*#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===
 
===Routing errors===
Line 53: Line 42:
 
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.
* '''GTK GUI''':
 
*# Click on the ''Map'' item in the toolbar.
 
*# Enable the ''navigation:' map.
 
 
* '''Internal GUI''':
 
* '''Internal GUI''':
 
*# Click anywhere on the map to enter the menu.
 
*# Click anywhere on the map to enter the menu.
 
*# Enter the ''Settings'' submenu, followed by the ''Maps'' submenu.
 
*# Enter the ''Settings'' submenu, followed by the ''Maps'' submenu.
 
*# Enable the ''Navigation'' map.
 
*# Enable the ''Navigation'' map.
 +
* '''GTK GUI''':
 +
*# Click on the ''Map'' item in the toolbar.
 +
*# 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
 
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
Line 67: Line 56:
  
 
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] or [http://www.fosm.org FreeOpenStreetMap]
 
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] or [http://www.fosm.org FreeOpenStreetMap]
 +
 +
===Announcement errors===
 +
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.
 +
* * [[#Reporting coordinates for problems| Report the coordinate(s) where the error occurs, where you came from and your destination (if routing was enabled)]].
 +
* If possible, provide an NMEA log (see [[Configuration]]) and add the time at which the problem occured.
 +
* If an incorrect vehicle position was shown, specify where you were in real-life, and where Navit indicated you to be.
  
 
===Tracking errors===
 
===Tracking errors===
Line 74: Line 70:
 
* 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===
+
==For compile/install problems==
Problems may include announcements too early, announcements too late, incorrect announcements, repeated announcements, missing announcements etc.
+
First, please perform a "clean" build: Delete and recreate your build directory, then perform a complete build (cmake + make). Normally, re-running ''cmake'' after an svn update or other change should be enough, but if you run into problems, a clean build is better.
* First try to determine whether this isn't a [[#Tracking errors| tracking]] and or [[#Navigation | navigation]] problem.
+
* Which version of navit you are using.
* * [[#Reporting coordinates for problems| Report the coordinate(s) where the error occurs, where you came from and your destination (if routing was enabled)]].
+
* What operating system and distribution you are using, and what platform.
* If possible, provide an NMEA log (see [[Configuration]]) and add the time at which the problem occured.
+
* The source of the sourcecode or installation files (provide a link if possible).
* If an incorrect vehicle position was shown, specify where you were in real-life, and where Navit indicated you to be.
+
* 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).
 +
 
 +
=Keywords=
 +
As Navit consists on a lot of components, we use tracs keywords feature, to search,filter and group tickets:
 +
* routing
 +
* map
 +
* layout
 +
* download
 +
* input
 +
* testing
 +
* i18n
 +
* crash
 +
* platform (tomtom, linux, win, android)
 +
* maptool
 +
* OSM
 +
* patches
 +
 
 +
=Not to enter=
 +
The ticket offers some attributes, that you as a contributor doesn't have to enter:
 +
# version
 +
# milestone
 +
# component
 +
# owner
 +
 
 +
 
 +
Anyway, we will review your ticket and try to improve it, if required.[br]
 +
Thanks for your submission, the Navit team.
 +
 
 +
=See also=
 +
*[[Submitting patches]]
 +
*[[Translations]]
 +
*[[Commit guidelines]]
  
 
[[Category:Support]]
 
[[Category:Support]]

Latest revision as of 23:55, 19 April 2018

All bugs and feature requests are to be reported to the Navit developers through Trac or Github issues. 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[edit]

  1. Register on this wiki, choosing a suitable username and password
  2. Ask at forum or IRC for feedback/if bug is known
  3. Head over to http://trac.navit-project.org or https://github.com/navit-gps/navit/issues and search for existing tickets on that bug
  4. When going on trac.navit-project.org, login via openid and your wiki profiles URL e.g http://wiki.navit-project.org/index.php/User:cp15
  5. Read the guidelines below
  6. Create and compile your bug report, and submit it via g pull request on Github
  7. Be patient and wait on feedback and discussion (usually after some days)
  8. Help to reproduce the bug or give more details on your idea

Information you should provide[edit]

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 usage problems[edit]

  • 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).
  • Ideally, reproduce your problem with the shipped navit.xml. If that is not possible, try to find the minimal change necessary to reproduce it. If you are unable to narrow down the problem, include your complete navit.xml, as an attachment 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[edit]

Assuming you are using OpenStreetMap map packages:

  1. Browse at http://www.openstreetmap.org to the area
  2. Pick the "share" tool from the right toolbox.
  3. Copy the link from the editbox

Routing errors[edit]

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[edit]

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

  • 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.
  • GTK GUI:
    1. Click on the Map item in the toolbar.
    2. 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 or FreeOpenStreetMap

Announcement errors[edit]

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

Tracking errors[edit]

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

For compile/install problems[edit]

First, please perform a "clean" build: Delete and recreate your build directory, then perform a complete build (cmake + make). Normally, re-running cmake after an svn update or other change should be enough, but if you run into problems, a clean build is better.

  • 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).

Keywords[edit]

As Navit consists on a lot of components, we use tracs keywords feature, to search,filter and group tickets:

  • routing
  • map
  • layout
  • download
  • input
  • testing
  • i18n
  • crash
  • platform (tomtom, linux, win, android)
  • maptool
  • OSM
  • patches

Not to enter[edit]

The ticket offers some attributes, that you as a contributor doesn't have to enter:

  1. version
  2. milestone
  3. component
  4. owner


Anyway, we will review your ticket and try to improve it, if required.[br] Thanks for your submission, the Navit team.

See also[edit]