Latest revision as of 02:24, 22 February 2023

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.

@@ Line 1: / Line 1: @@
-=====“I found a bug... which i want fixed. Where can i report this...”=====
+{{mininav| [[Development]] {{l2| [[Troubleshooting]] }} }}
-The reason this page is written is that there are often faulty, vague or even double bug-reports posted on the forum.
-The information below is to streamline this a bit.
-To start, make sure you use the last possible XBMC version. The last possible XBMC version is the one you build yourself. This is quite technical and most users will never attempt to do this.
+__TOC__
-Most of you get XBMC from P2P networks. There is always a date added to these builds. Please use a RECENT build, a recent build is never more then a few days old!
-Here you can check the [http://xbmc.cvs.sourceforge.net/xbmc/XBMC/Changelog.txt?view=markup Changelog] since XBMC version 1.0. Maybe your bug has been fixed in the last few hours?
-The bug is still in the “latest” version? read on...
-* First search the [http://sourceforge.net/tracker/?func=browse&group_id=87054&atid=581838 sourceforge bugtracker] if this bug has been reported before. If so, all you can do is wait or post a message in the forum thread regarding this bug.
-* The next thing you should do, if there is no bug report, use the [http://www.xboxmediaplayer.de/cgi-bin/forums/ikonboard.pl?s=1baf3be6ad82849fe2b755f9d9b734ac;act=Search;CODE=00; search function in the forum].
+= Introduction =
+So, you think you've found a bug and not sure how to report it?
-Make sure you search in the bug report section!
+{{kodi}} accepts bug reports on both the '''[http://forum.kodi.tv Kodi Forum]''' and '''[https://github.com/xbmc/xbmc/issues Github Issue reports]'''
-At the bottom of the page is also the timeframe you set to not limit your search within the last 30 days.
-Some bug reports are more then 30 days old. Set the timeframe to a year.
-===Posting the bug===
-You should first report the bug on the [http://www.xboxmediaplayer.de/cgi-bin/forums/ikonboard.pl forum], after this (and it is confirmed by others) you can do an official bug report on the [http://sourceforge.net/tracker/?func=browse&group_id=87054&atid=581838 sourceforge bugtracker].
-===Rules of posting a bug report – the short version===
-*Make sure you are the first to report it.
+= Check for existing reports =
-*Make separate threads for each bug (if you have found more) (for easier manageability)
+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.
-*Give a good overview.
-===Useful info for bug reports, for use on the forum===
+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.
-Everytime you run XBMC it makes a logfile. This log file is stored in the XBMC directory and is called “xbmc.log”. This information can be read in any notepad\texteditor. You can post *parts* of the log on the forum as it might help developers pinpoint the problem.
-Please read the log file and post only the parts you think are usefull. The first part is logging every setting which most of the time is not useful.
-If you think you need to make a [[Taking Screenshots of XBMC|screenshot]] of XBMC to show on the forum you can do so by pressing the left thumb stick.
-If you have trouble with a video file playing please use the program [http://www.headbands.com/gspot/ gspot] to find out which codecs it needs
+= Reporting a bug =
+Once you have confirmed there are no other similar reports, it is time to open a dialog with the community.
-===What Information Should Be Included with Bug Reports===
+Where to report the issue:
-You need to provide all relevant information about your setup and the bug/problem, if you do not know if something is relative or not then incude that information just in case. Information such as kind of what TV you have PAL-50/60 or NTSC-M/J or HDTV and if you have a 16:9 Widescreen or normal 4:3 etc. What Xbox™ you got (modchip, BIOS it’s using, what DVD-ROM it has and if it can read CD-R or not), which primary dashboard you use, which build version of XBMC and XStream you’re using, if you’re running XBMC from the hard drive or of a CD-R/RW/DVD-R/RW+R/RW? (inc. file structure) and if you’re playing the media file of DVD-ROM, Hard Drive or XStream (setup & version), if streaming file what kind of network you have. Most importantly you need to provide a very detailed problem description together with step-by-step instructions how others can replicate the problem you see. You may also have to post the contents of some of your xml files. Provide detailed info of the media file (use Gspot, YAAI or similar tool to get this info). For media bugs you also need to provide a URL where the developers can download a sample of the file (AVI,MPG,MP3,JPG …etc.) that show the problem, see how-to create a sample here. Note! If you have problem when playing a file over the network or from the DVD-ROM you need to at least test to play or view the exact same file from the Xbox Hard Drive to see if the problem is the same from there.<br>
-PS! You must check that the bug exist in the very latest XBMC latest CVS code/build before.<br>
+==== Forum ====
-Note! Do not e-mail or PM us directly to report a bug, we do not do personal 1 to 1 handling.
+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]'''.
+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]]

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