HOW-TO:Submit a bug report: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Dandar3
(Generic Windows log file location;)
mNo edit summary
 
(98 intermediate revisions by 23 users not shown)
Line 1: Line 1:
{{Incomplete}}
{{mininav| [[Development]] {{l2| [[Troubleshooting]] }} }}


=Collecting an XBMC debug log=
To an XBMC developer, the most valuable piece of information you can provide is a debug log from a session where you are having the problem you are trying to get help with.


__TOC__


'''IMPORTANT!''' The normal XBMC log '''IS NOT''' a debug log, to enable debug logging you must toggle it on in [[System Settings#Hardware|System Settings]].
*The log (xbmc.log) can be found in the same location as the XBMC executable (like on the Xbox or [[XBMC_for_Windows_specific_FAQ#Where_is_user_specific_data_stored.3F|Windows in Platform mode]]), OR
**"'''''~/.xbmc/temp/'''''" for Linux
**"'''''~/Library/Logs/'''''" on the Mac
**"'''''/mnt/Scratch/Users/frontrow/Library/Logs/'''''" on Apple TV
**"'''''%APPDATA%\XBMC\'''''" on Windows.


:'''Note!''' Please '''do not''' cut and paste logs into a post on the XBMC Community Forum, instead use one of the many pasting websites such as [http://pastebin.com pastebin.com] or [http://pastebin.ca pastebin.ca] to upload your '''entire''' log and then only post the link to that web page. Thank you in advance for not cluttering the XBMC Community Forum with logs.
= Introduction =
So, you think you've found a bug and not sure how to report it?


=How to submit a bug report=
{{kodi}} accepts bug reports on both the '''[http://forum.kodi.tv Kodi Forum]''' and '''[https://github.com/xbmc/xbmc/issues Github Issue reports]'''
# First check whether or not there has been a bug reported before, as your bug may already have been fixed or may be in the process of being fixed. Do that by searching on [http://trac.xbmc.org/ Trac] (our tracker-system) to see whether a similar bug report have already been filed or not, (if an existing ticket already exist as is open then add your experiences and logs to that bug report instead of creating a new report). You may also try searching in the [http://forum.xbmc.org XBMC Community Forum] to see whether others are having the same problems.<br><br>
# If you're not sure whether it is a legitimate bug then please post on the forums and give as much information as you can, including a debug log.<br><br>
# If you are sure that it is a genuine bug (or the issue have been confirmed by others) then please post a bug report on [http://trac.xbmc.org/ Trac] (our tracker-system). The following information is always essential:
## Information as to which platform (operating-system/hardware) and version of XBMC (exact SVN revision) you are running.
## Clear steps as to how someone else can reproduce the problem that you see (very few bugs are truly "random", and getting it reproducible by others is 90% on the way to fixing it).
## A full _debug log_ of when the error occurs.
## Anything else that may be of assistance to developers (eg. screenshots, the skin you are using if not the default PMIII and so on).<br><br>
# Make sure you follow up the bug report with any information that is requested by a developer as soon as possible.


===Getting a Stack Trace (backtrace)===
You probably got to this page because someone asked you for additional information in a bug report that you filed. This extra bit of information they asked for is a stack trace (also known as a backtrace), and it is important for developers that the stack trace you obtain contains certain details (called debugging symbols). Below are listed all the steps we would like you to take to provide us with the helpful information. It should only take 10-15 minutes of your time, and it will help us tremendously to improve the software you are using.
====Installing debugging information packages====
You need to install debug packages for the program that crashed. These debug packages are additional packages that do not affect your existing program, but provide extra information (debugging symbols) needed by developers. This makes it a lot easier to find the exact place in the program code where that problem occurs, and to fix it. We ask you to also install debug packages for some of the program's major dependencies.


=Help with Bug Reports and Quality Assurance=
You can help the XBMC development team keep up with the bug reports by closing duplicates, helping to clarify a reported problem, and confirming that you can reproduce bugs. You can via [http://trac.xbmc.org our tracking system] view the entire list of open bugs, or browse XBMC bugs by various attributes (ones with unreviewed patches, etc). You may not have permissions to do much at first except comment - which you should feel free to do.


For more information please read our [[HOW-TO help with Quality Assurance]] for tips on how to best help us with the reported bugs.
= Check for existing reports =
Duplicate bug reports only clutter the communications channels with the developers. Before posting your bug report, it is important to ensure that you have not been beaten to it.


=Tips and tricks on how XBMC tracking-system (Trac) works=
If you find a forum thread or a Github issue report, please read through it. It may provide a solution to the issue, if not then add any new information that you can provide to describe the issue.
Here are some basics explained as well as quick tips and tricks on how to use [http://trac.xbmc.org trac] (XBMC tracking-system). Trac may do some things from time to time that help or hinder, so knowing what they are when they happen can be useful.


===Trac basics explained===
*Who may submit a new bug ticket?
**Anyone who have a registed account on [http://forum.xbmc.org XBMC Community Forum] may submit a new bug report to [http://trac.xbmc.org Trac] (as well as feature requests, and patches).
*What the reporter can do
**The reporter of a bug can modify any aspect of their own bug (e.g. close it, reopen it, etc.).
*Who can add comments
**Anyone can to anyone else's ticket on Trac, so long as they have created a [http://forum.xbmc.org XBMC Community Forum] account.


===Exploiting Trac in order to increase your productivity===
*Custom bookmarks
**Custom keywords allow you to jump to a known bug ID without having to browse to Trac first.


= Reporting a bug =
Once you have confirmed there are no other similar reports, it is time to open a dialog with the community.


Where to report the issue:


[[category:How To|Submit a Proper Bug Report]]
==== Forum ====
[[category:Inner Workings]]
If you are uncertain whether it is a bug - maybe it is a problem with your music or video file, maybe a problem with your hardware, or you simply don't know if it is normal behaviour - then start on the '''[http://forum.kodi.tv Kodi Forum]'''.
[[Category:Quality Assurance]]
 
[[Category:To-Do]]
Please provide the supporting evidence described below.
 
 
==== Github ====
For the more experienced user and if you are absolutely certain it is a bug then report the issue on our '''[https://github.com/xbmc/xbmc/issues Github Tracker]'''.
 
If you report here, you are required to fill in the template. If you choose to ignore the template, or delete it, then your report will be closed. '''Ensure you follow the template'''.
 
Please provide the supporting evidence described below.
 
Do not use Github for support, or disguising a support request as a bug. These will be immediately closed and ignored. Use the forum for support.
 
 
 
= Supporting evidence =
Regardless of where you post your report, if you expect someone to take interest in it, they will expect details from you. Don't forget, we're doing this in our free time, too!
 
Post as much details as you can upfront. It becomes very frustrating when we are drip-fed information.
 
Information we need:
 
* Clearly describe your setup including hardware, operating system, connections etc.
* Clearly describe the problem.
* Clearly outline the steps to replicate the problem.
* Provide supporting evidence, such as:
** A '''[[Log file|debug log]]''' that captures the problem. Don't paste logs directly into the forum post or github report. Use '''[https://paste.kodi.tv Kodi Paste]''' to submit logs and provide the link.
** If the problem is visible on screen, then provide '''[[Settings/System/Logging#Screenshot_folder|screenshots]]''' so we can clearly see the problem
** If you have the time, a short video can also be very helpful.
** If it is an issue with a particular type of file, then a sample of the file will be helpful also.
 
We need as much information as possible, so we can reliably replicate the issue you are experiencing.
 
 
 
= Not a bug =
Not every problem you experience will be classified as a bug. Some reasons why...
 
* Your hardware is too old, or may be a very cheap Android box with a hacked Android OS
* You are using an old version of {{kodi}}. Only the current stable release and the current master development branch are supported.
* What you are experiencing is intended behaviour.
 
 
 
= See also =
* [[Log file]]
* [[Bug tracker]]
* [[Troubleshooting]]
 
 
 
 
 
{{top}}
{{updated|20}}
 
[[Category:How-to]]
[[Category:Development]]
[[Category:Troubleshooting]]

Latest revision as of 02:24, 22 February 2023

Home icon grey.png   ▶ Development
▶ Troubleshooting		 ▶ HOW-TO:Submit a bug report



Introduction

So, you think you've found a bug and not sure how to report it?

Kodi accepts bug reports on both the Kodi Forum and Github Issue reports


Check for existing reports

Duplicate bug reports only clutter the communications channels with the developers. Before posting your bug report, it is important to ensure that you have not been beaten to it.

If you find a forum thread or a Github issue report, please read through it. It may provide a solution to the issue, if not then add any new information that you can provide to describe the issue.


Reporting a bug

Once you have confirmed there are no other similar reports, it is time to open a dialog with the community.

Where to report the issue:

Forum

If you are uncertain whether it is a bug - maybe it is a problem with your music or video file, maybe a problem with your hardware, or you simply don't know if it is normal behaviour - then start on the Kodi Forum.

Please provide the supporting evidence described below.


Github

For the more experienced user and if you are absolutely certain it is a bug then report the issue on our Github Tracker.

If you report here, you are required to fill in the template. If you choose to ignore the template, or delete it, then your report will be closed. Ensure you follow the template.

Please provide the supporting evidence described below.

Do not use Github for support, or disguising a support request as a bug. These will be immediately closed and ignored. Use the forum for support.


Supporting evidence

Regardless of where you post your report, if you expect someone to take interest in it, they will expect details from you. Don't forget, we're doing this in our free time, too!

Post as much details as you can upfront. It becomes very frustrating when we are drip-fed information.

Information we need:

  • Clearly describe your setup including hardware, operating system, connections etc.
  • Clearly describe the problem.
  • Clearly outline the steps to replicate the problem.
  • Provide supporting evidence, such as:
    • A debug log that captures the problem. Don't paste logs directly into the forum post or github report. Use Kodi Paste to submit logs and provide the link.
    • If the problem is visible on screen, then provide screenshots so we can clearly see the problem
    • If you have the time, a short video can also be very helpful.
    • If it is an issue with a particular type of file, then a sample of the file will be helpful also.

We need as much information as possible, so we can reliably replicate the issue you are experiencing.


Not a bug

Not every problem you experience will be classified as a bug. Some reasons why...

  • Your hardware is too old, or may be a very cheap Android box with a hacked Android OS
  • You are using an old version of Kodi. Only the current stable release and the current master development branch are supported.
  • What you are experiencing is intended behaviour.


See also



Return to top
Retrieved from "https://kodi.wiki/index.php?title=HOW-TO:Submit_a_bug_report&oldid=244319"