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: @@
-{{Cleanup}}
+{{mininav| [[Development]] {{l2| [[Troubleshooting]] }} }}
-So, you think you've found a bug?  Great!  Thanks for being proactive enough to make it this far.  If you want to ensure that your report gets attention from the right people it is paramount that you answer the following questions.  Please read this document in its entirety before continuing on your adventure.
-==Has the bug been reported already?==
-Duplicate bug reports only clutter the communications channels with the developers.  Keeping the discussion in one place not only makes the topic easy to follow but centralizes all details for easier review.  Before posting your bug report, it is important to ensure that you haven't been beat to it.  There are two places to look, the [http://forum.xbmc.org XBMC Forum] and [http://trac.xbmc.org Bug Tracker].  Both have a search button.  Please use it!  If you find a thread on the forum or ticket on the bug tracker, please read through it and add any new information that you can provide.  "Me too" and "bump" posts don't really help the matter without additional details, so please refrain.
-==Ok, so my bug is new.  Now what?==
+__TOC__
-Now that you have made sure that your problem is unique, it is time to open a dialog with the community.  Where to do this is a question of your certainty that the problem is in fact a bug.  Keep in mind that reporting the bug puts some responsibility on you to answer any questions a developer may have.  You may want to consider "subscribing" to your forum thread (you'll be CC'd updates automatically by the bug tracker) and ensure that your registered email is one that you keep track of!
-===Yes! This must be a bug!===
-If you are sure that you're dealing with a bug, (crash, hang, failed playback, corruption, etc) please go straight to the [http://trac.xbmc.org Bug Tracker] and create a new ticket.  Be sure to fill in as many of the fields in the form as possible, use your best judgment.
-===Hrm...I think this is a bug...===
+= Introduction =
-If the problem is more one of behavior you didn't expect, please start in the [http://forum.xbmc.org forums] first.  XBMC has many features, with these features comes design decisions.  It is very possible that the behavior you expect is not that which the developer envisioned.  There is also a possibility that the feature is very complicated at the code level and that the behavior you expect would be very difficult or impossible to create.  Regardless, bouncing your ideas off of forum users (most developers are forums users too!) to confirm and clarify before opening a ticket on the [http://trac.xbmc.org Bug Tracker].  You may be opening a feature request instead! ;)
+So, you think you've found a bug and not sure how to report it?
-==Right, so what "information" do you guys need?==
+{{kodi}} accepts bug reports on both the '''[http://forum.kodi.tv Kodi Forum]''' and '''[https://github.com/xbmc/xbmc/issues Github Issue reports]'''
-Regardless of where you're posting your report, if you expect someone to take interest in it, they will expect details from you.  Don't forget, we're doing this stuff in our free time, too!  Post as much of this stuff as you can upfront.  We'd rather spend our time fixing problems than digging for details.  If you need further help obtaining something, feel free to ask (then come back and update the wiki!).
-===Debug Log===
-A '''[[Log file|debug log]]''' is '''essential''' to any and all bug reports.  Without it your report stands a good chance of being overlooked.  It provides nearly all of the information about what was going on and what you were doing in the application.  The log file also contains some of the details you'll need to fill out a new ticket on the [http://trac.xbmc.org Bug Tracker].  So it might pay to glance through it yourself.
-===Detailed Instructions To Reproduce===
-To actually solve your problem, we need to be able to reproduce it.  The more descriptive the instructions, the better chances are that they'll work for others.  Sit down and reproduce the problem a few times, first, to make sure you understand it.  If the problem is "random," [[Log file#Enable Debugging|enable debugging]] during normal use.  Restart the application often to keep the log file short.  The more time you spend isolating the problem, the quicker a developer will be able to reproduce and fix it.  Please take your time with this step!
-===Sample File===
+= Check for existing reports =
-If your problem has to do with playback of video, audio or subtitles, or display of a picture a sample file will go far in getting it fixed.  The file should be as small as possible while still reproducing the issue.  There are several audio/video cutting applications available (just google it until someone makes a list here).  If you're posting on the [http://trac.xbmc.org Bug Tracker] there is a limit of 10MB.  Otherwise, you'll have to use a file hosting site like [http://www.mediafire.com/ MediaFire].
+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.
-===Crash Report===
+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.
-If XBMC has crashed, there are good odds that a crash report is available.  How these are handled is platform dependent.
-:{|
-====Linux====
-The file will be in your user's home directory or the working directory if XBMC was launched from a terminal.  It will be named "xbmc_crashlog-[DATE]-[TIME].log" and contain some system information at the top, followed by a stack trace and the contents of xbmc.log.  If you didn't have [[Log file#Enable Debugging|debugging]] enabled at the time, please enable it and recreate the problem.  This feature was added in SVN revision 22194 and relies on the gnu debugger GDB being installed to work.
-====Mac OS X====
-Both OSX and AppleTVs will always create a Crashreporter log if any application crashes. These are found in
-/Users/username/Library/Logs/CrashReporter/CrashReporter.log where 'username' is the login username. For the AppleTV, the 'username' is 'frontrow'.
-====Windows====
-For XBMC v9.11 (Camelot) Alpha1 and earlier, the file will be in your XBMC installation directory. It will be named "xbmc.r[REVISION].dmp"
-For XBMC v9.11 (Camelot) Beta1 and later, the file will be in the same location as the [[Log file|debug log]] and named "xbmc_crashlog-[DATE]-[TIME].dmp".
-|}
-==See also==
+= Reporting a bug =
-*[[Troubleshooting]]
+Once you have confirmed there are no other similar reports, it is time to open a dialog with the community.
-[[category:How-to|Submit a Proper Bug Report]]
+Where to report the issue:
-[[category:Development]]
-[[Category:Trac]]
+==== 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 '''[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

Latest revision as of 02:24, 22 February 2023

Contents

Introduction

Check for existing reports

Reporting a bug

Forum

Github

Supporting evidence

Not a bug

See also

Navigation menu

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

Latest revision as of 02:24, 22 February 2023

Introduction

Check for existing reports

Reporting a bug

Forum

Github

Supporting evidence

Not a bug

See also

Navigation menu

Search