Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
report_issue [2021/10/01 01:47] – [How to not get your issue investigated] added info about beta testing atarireport_issue [2023/12/16 05:26] (current) – [What issue reports are NOT for] maximumentropy
Line 3: Line 3:
 Recommended reading: https://iancos.wordpress.com/2013/01/14/kepner-tregoe-problem-analysis/ Recommended reading: https://iancos.wordpress.com/2013/01/14/kepner-tregoe-problem-analysis/
  
-So, you've found an issue with Batocera. A true, genuine bug with the way Batocera functions. You've gone through the [[:troubleshooting|troubleshooting page]] and confirmed it's not a misconfiguration, you've gotten other operating systems running fine on the machine so it's not a hardware fault, you've tested the ROMs and BIOS files with another emulator on another system and they're working fine there, or maybe it's a regression (where things were working fine with a previous version, but the most recent stable version has the issue).+So, you've found an issue with Batocera. A true, genuine bug with the way Batocera functions. You've gone through the [[:troubleshooting|troubleshooting page]] and confirmed it's not a misconfiguration, you've gotten other operating systems running fine on the machine so it's not a hardware fault and you've tested the ROMs and BIOS files with another emulator on another system where they work fine. Or maybe things were working fine in a previous version, and in a newer version they do not, and you've tested [[:upgrade_manually|downgrading]] to see that the issue is indeed not present on the older version (this is referred to as a regression).
  
 And now you want to report that bug. And now you want to report that bug.
Line 9: Line 9:
 Here's a guide on how to report a bug and giving the highest chances of it being actually fixed by the next major release of Batocera. Batocera is a very complicated project, and it's only by the efforts of multiple contributors that it can be made and released for so many platforms. Usually, devices are worked on by the individuals who have those devices for testing and have the technical know-how on how to implement it, so not all devs have access to all devices at all times. In essence, don't expect a dev to reply to you quickly, especially if you're on a platform that's "less common" like an SBC. Remember, Batocera is entirely a volunteer project, we all work on this in our spare time. Here's a guide on how to report a bug and giving the highest chances of it being actually fixed by the next major release of Batocera. Batocera is a very complicated project, and it's only by the efforts of multiple contributors that it can be made and released for so many platforms. Usually, devices are worked on by the individuals who have those devices for testing and have the technical know-how on how to implement it, so not all devs have access to all devices at all times. In essence, don't expect a dev to reply to you quickly, especially if you're on a platform that's "less common" like an SBC. Remember, Batocera is entirely a volunteer project, we all work on this in our spare time.
  
-<WRAP center round tip 60%> +<WRAP center round tip> 
-First, check that there isn't already a duplicate issue on the [[https://github.com/batocera-linux/batocera.linux/issues|Github issues page]] which you could contribute your information to instead. After you've made certain your issue is unique, submit it using the formal report format as an issue to that page.+First, check that there isn't already a duplicate issue on the [[https://github.com/batocera-linux/batocera.linux/issues|batocera.linux]] or [[https://github.com/batocera-linux/batocera-emulationstation/issues|batocera-emulationstation]] Github issues page which you could contribute your information to instead. After you've made certain your issue is unique, submit it using the formal report format as specified below to a new "issue" to the respective repository's issues page (you may need to create a Github account to do this).
  
 Although you can also report issues on our Discord server, these are likely to be missed by our devs as we receive hundreds of messages per day on there! Although you can also report issues on our Discord server, these are likely to be missed by our devs as we receive hundreds of messages per day on there!
Line 20: Line 20:
  
 Here is a list of things you should **not** use the issues page for and the alternative location for them: Here is a list of things you should **not** use the issues page for and the alternative location for them:
-  * Feature requests should instead be put in the #wish channel on [[https://discord.com/invite/JXhfRTr|the Discord server]] or [[https://forum.batocera.org/|the forum]]. +  * Feature requests should instead be put in the [[https://discord.gg/V7j6vPG85N|#batocera-linux-requests channel on the Discord server]]. 
-  * Implementation/PR assistance (for developing Batocera) should instead be guided towards the #developers / #developers-emulationstation channel on the Discord.+  * Implementation/PR assistance (for developing Batocera) should instead be guided towards the #developers and #developers-emulationstation channel on the Discord.
   * Issues specific to the emulator and the game it is running. Usually they should be reported to the dev of the emulator itself, as it is outside of the scope of Batocera. This includes things such as "weird geometry corruption in my Dreamcast game!" and "textures look weird on my PS2 game in PCSX2 but not Libretro/PCSX2". These emulators usually have their own documentation/wiki that you can check for and troubleshoot with instead first, it is recommended to do your research.   * Issues specific to the emulator and the game it is running. Usually they should be reported to the dev of the emulator itself, as it is outside of the scope of Batocera. This includes things such as "weird geometry corruption in my Dreamcast game!" and "textures look weird on my PS2 game in PCSX2 but not Libretro/PCSX2". These emulators usually have their own documentation/wiki that you can check for and troubleshoot with instead first, it is recommended to do your research.
   * Issues specific to EmulationStation (Batocera's front-end, the "main menu" essentially) should go to the [[https://github.com/batocera-linux/batocera-emulationstation|Github issue page specific to it]] instead. This includes things such as images appearing as white squares, text corrections, menu functions not behaving as intended, etc.   * Issues specific to EmulationStation (Batocera's front-end, the "main menu" essentially) should go to the [[https://github.com/batocera-linux/batocera-emulationstation|Github issue page specific to it]] instead. This includes things such as images appearing as white squares, text corrections, menu functions not behaving as intended, etc.
Line 55: Line 55:
 ==== Formal report ==== ==== Formal report ====
  
-Issues should be reported with the following format to give them the greatest chance of being fixed (erase the placeholder text and put in your own):+Issues should be reported with the following format to [[https://github.com/batocera-linux/batocera.linux/issues|the Batocera Github issue page]] to give them the greatest chance of being fixed (erase the placeholder text and put in your own):
  
 **Issue:** A laconic explanation of the issue, including your platform and version of Batocera. Keep this to a single sentence. **Issue:** A laconic explanation of the issue, including your platform and version of Batocera. Keep this to a single sentence.
Line 69: Line 69:
 **Logs and data:** Provide all the [[:troubleshooting#emulators_not_launching_emulationstation_logs|relevant logs]] and information relevant to the issue. Include any information about the platform you are on, the hardware being used (most applicable for x86 and x86_64 platforms), the stable versions of Batocera the issue is present/not present on, whether the issue is present on a fresh install or not, etc. **Logs and data:** Provide all the [[:troubleshooting#emulators_not_launching_emulationstation_logs|relevant logs]] and information relevant to the issue. Include any information about the platform you are on, the hardware being used (most applicable for x86 and x86_64 platforms), the stable versions of Batocera the issue is present/not present on, whether the issue is present on a fresh install or not, etc.
  
-If you are not certain which logs are relevant or the logs you do have don't describe the issue, [[:troubleshooting#create_a_batocera_support_file|create a support file]] instead. Do note that this file can contain personal information (your Wi-Fi SSID and password is in ''system/batocera.conf'' and ''system/batocera-boot.conf'', your RetroAcheivements username and password are in ''system/batocera.conf''), so be sure to either scrub it first if the issue isn't relevant to that information or just use a temporary password to be changed after the report. A fresh flash of Batocera doesn't have any personal info in it yet.+If you are not certain which logs are relevant or the logs you do have don't describe the issue, [[:troubleshooting#create_a_batocera_support_file|create a support file]] instead. Do note that this file can contain the following personal information: 
 +  * Your IP address is in ''system/ifconfig.txt'', ''system/messages'' and ''system/netstat.txt'' 
 +  * Your Wi-Fi SSID and password is in ''system/batocera.conf'' and ''system/batocera-boot.conf'' 
 +  * Your RetroAchievements username and password are in ''system/batocera.conf'', ''configs/retroarch/retroarchcustom.cfg'' and any configuration override files if you've made them 
 +  * Your scraper API account is in ''system/es_settings.cfg'' and ''configs/emulationstation/es_settings.cfg'' 
 +  * Your NAS login details are in ''system/batocera-boot.conf'' 
 + 
 +Be sure to either scrub it first if the issue isn't relevant to that information or just use a temporary password to be changed after the report.
  
 === Example of a good report === === Example of a good report ===
Line 100: Line 107:
  
 The purpose of the betas are to (hopefully) catch major bugs and fix them before going into release candidate/major release stage. The purpose of the betas are to (hopefully) catch major bugs and fix them before going into release candidate/major release stage.
 +
 +<WRAP center round info>
 +A timeline of when certain changes are allowed to be merged upstream can be found here: https://batocera.org/timeline
 +
 +A list of platforms Batocera is currently available on can be found here: https://mirrors.o2switch.fr/batocera/installs.txt
 +</WRAP>
  
 ==== Major issues with the beta ==== ==== Major issues with the beta ====
  • report_issue.1633052858.txt.gz
  • Last modified: 5 years ago
  • by atari