From Fedora Project Wiki
(Initial Change document)
 
(submitting change to fesco)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choose the "view source" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR CHANGE PROPOSAL.'''}}
{{admon/tip | Guidance | For details on how to fill out this form, see the [https://docs.fedoraproject.org/en-US/program_management/changes_guide/ documentation].}}
{{admon/tip | Report issues | To report an issue with this template, file an issue in the [https://pagure.io/fedora-pgm/pgm_docs pgm_docs repo].}}
<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name.  This keeps all change proposals in the same namespace -->
= Replace SDL 2 with sdl2-compat using SDL 3 =
= Replace SDL 2 with sdl2-compat using SDL 3 =


Line 28: Line 20:


== Current status ==
== Current status ==
[[Category:ChangePageIncomplete]]
[[Category:ChangeReadyforFesco]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
Line 46: Line 38:
ON_QA -> change is fully code complete
ON_QA -> change is fully code complete
-->
-->
* [Announced]
* [https://lists.fedoraproject.org/archives/list/devel-announce@lists.fedoraproject.org/thread/RITSN3NDUESKAVMOO4GBW6ZKANCVWJZ6/ Announced]
* [<will be assigned by the Wrangler> Discussion thread]
* [https://discussion.fedoraproject.org/t/f42-change-proposal-replace-sdl-2-with-sdl2-compat-using-sdl-3-self-contained/138987 Discussion thread]
* FESCo issue: <will be assigned by the Wrangler>
* FESCo issue: [https://pagure.io/fesco/issue/3301 #3301]
* Tracker bug: <will be assigned by the Wrangler>
* Tracker bug: <will be assigned by the Wrangler>
* Release notes tracker: <will be assigned by the Wrangler>
* Release notes tracker: <will be assigned by the Wrangler>


== Detailed Description ==
== Detailed Description ==
SDL 2 feature development ended some time ago with efforts being focused on SDL 3. However, many older games still use SDL 2 and cannot change to SDL 3. In order to continue to support SDL 2 games in the modern world, let's replace SDL 2 with sdl2-compat, which uses SDL 3.
SDL 2 feature development ended some time ago with efforts being focused on SDL 3. However, many older games still use SDL 2 and cannot change to SDL 3. In order to continue to support SDL 2 games in the modern world, let's replace SDL 2 with sdl2-compat, which uses SDL 3. This also has the effect of moving SDL 1.2 games to SDL3 through sdl12-compat running on sdl2-compat.




Line 60: Line 52:


== Benefit to Fedora ==
== Benefit to Fedora ==
Switching SDL 2 powered games to use <code>sdl2-compat</code> ensures that SDL-based applications continue to use the actively developed codebase.
Switching SDL 2 powered games to use <code>sdl2-compat</code> ensures that SDL-based applications continue to use the actively developed codebase. This also has the effect of SDL 1.2 powered games that use <code>sdl12-compat</code> to run on SDL3 as well through the fully supported path of <code>sdl12-compat</code> running on <code>sdl2-compat</code> running on SDL3.


== Scope ==
== Scope ==
* Proposal owners:
* Proposal owners:
** Package [https://github.com/libsdl-org/sdl2-compat libsdl2-compat] ([https://bugzilla.redhat.com/show_bug.cgi?id=2316576 RH#2316576])
** Package [https://github.com/libsdl-org/sdl2-compat libsdl2-compat] (native: [https://bugzilla.redhat.com/2316576 RH#2316576], mingw: [https://bugzilla.redhat.com/2330101 RH#2330101])
** Retire {{package|SDL2}} completely
** Retire {{package|SDL2}} and {{package|mingw-SDL2}} completely
** Do the same thing for the mingw counterparts


* Other developers: <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Other developers: <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
Line 88: Line 79:


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
== Early Testing (Optional) ==
<!-- This is an optional step for system-wide changes to avail of. If you would like to build an initial proof of concept of your change and have a member of Fedora QA help you write and/or run some initial basic tests on your code, please email tests@fedoraproject.org and include the link to your change proposal. This step is *optional*. -->
Do you require 'QA Blueprint' support? Y/N <!-- Optional Step for System-Wide Changes only -->


== How To Test ==
== How To Test ==
<!-- This does not need to be a full-fledged document. Describe the dimensions of tests that this change implementation is expected to pass when it is done.  This can be based off of the above section if early testing has been completed. If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.
The testing steps are simple:


Remember that you are writing this how to for interested testers to use to check out your change implementation - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your change.
0. Enable the [https://copr.fedorainfracloud.org/coprs/ngompa/SDL2onSDL3/ <code>SDL2onSDL3</code> COPR]: <code>dnf copr enable ngompa/SDL2onSDL3</code>


A good "how to test" should answer these four questions:
1. Swap <code>SDL2</code> for <code>sdl2-compat</code>: <code>dnf swap SDL2 sdl2-compat</code>


0. What special hardware / data / etc. is needed (if any)?
2. Run something that uses SDL 2 like {{package|supertuxkart}} and see that it works.
1. How do I prepare my system to test this change? What packages
need to be installed, config files edited, etc.?
2. What specific actions do I perform to check that the change is
working like it's supposed to?
3. What are the expected results of those actions?
-->


1. Swap <code>SDL2</code> for <code>sdl2-compat</code>: <code>dnf swap SDL2 sdl2-compat</code>
3. Run something that uses SDL 1.2 like {{package|icebreaker}} and see that it works.


2. Run something that uses SDL 2 like {{package|supertuxkart}} and see that it works.
Issues should be reported upstream for the fastest response: https://github.com/libsdl-org/sdl2-compat/issues




Line 128: Line 108:


<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
* Contingency mechanism: (What to do?  Who will do it?) N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Contingency mechanism: Revert back to shipping SDL2 / mingw-SDL2 packages
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
* Contingency deadline: N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Contingency deadline: Final Freeze
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
* Blocks release? N/A (not a System Wide Change), Yes/No <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* Blocks release? N/A (not a System Wide Change)
 


== Documentation ==
== Documentation ==
Line 147: Line 126:
Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.  
Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.  
-->
-->
Games that use SDL 2 will now transparently use SDL 3 through the <code>sdl2-compat</code> package. This makes it so applications that historically used SDL 2 now use SDL 3.
Applications that use SDL 2 will now transparently use SDL 3 through the <code>sdl2-compat</code> package. This makes it so applications that historically used SDL 2 now use SDL 3.

Latest revision as of 20:51, 16 December 2024

Replace SDL 2 with sdl2-compat using SDL 3

This is a proposed Change for Fedora Linux.
This document represents a proposed Change. As part of the Changes process, proposals are publicly announced in order to receive community feedback. This proposal will only be implemented if approved by the Fedora Engineering Steering Committee.

Summary

This Change proposes to replace SDL 2 with sdl2-compat, which uses SDL 3.

Owner


Current status

Detailed Description

SDL 2 feature development ended some time ago with efforts being focused on SDL 3. However, many older games still use SDL 2 and cannot change to SDL 3. In order to continue to support SDL 2 games in the modern world, let's replace SDL 2 with sdl2-compat, which uses SDL 3. This also has the effect of moving SDL 1.2 games to SDL3 through sdl12-compat running on sdl2-compat.


Feedback

Benefit to Fedora

Switching SDL 2 powered games to use sdl2-compat ensures that SDL-based applications continue to use the actively developed codebase. This also has the effect of SDL 1.2 powered games that use sdl12-compat to run on SDL3 as well through the fully supported path of sdl12-compat running on sdl2-compat running on SDL3.

Scope

  • Other developers:
  • Policies and guidelines: N/A (not needed for this Change)
  • Trademark approval: N/A (not needed for this Change)
  • Alignment with the Fedora Strategy: N/A (not needed for this Change)

Upgrade/compatibility impact

The SDL2 package would be transparently upgraded to libsdl2-compat package and games using it should just transparently start using SDL 3.0.


How To Test

The testing steps are simple:

0. Enable the SDL2onSDL3 COPR: dnf copr enable ngompa/SDL2onSDL3

1. Swap SDL2 for sdl2-compat: dnf swap SDL2 sdl2-compat

2. Run something that uses SDL 2 like supertuxkart and see that it works.

3. Run something that uses SDL 1.2 like icebreaker and see that it works.

Issues should be reported upstream for the fastest response: https://github.com/libsdl-org/sdl2-compat/issues


User Experience

There shouldn't be a noticeable user impact, other than possibly a smoother experience because applications are using SDL 3.0.

Dependencies

Contingency Plan

  • Contingency mechanism: Revert back to shipping SDL2 / mingw-SDL2 packages
  • Contingency deadline: Final Freeze
  • Blocks release? N/A (not a System Wide Change)

Documentation

N/A (not a System Wide Change)

Release Notes

Applications that use SDL 2 will now transparently use SDL 3 through the sdl2-compat package. This makes it so applications that historically used SDL 2 now use SDL 3.

Retrieved from "https://fedoraproject.org/w/index.php?title=Changes/SDL2onSDL3&oldid=727335"