From Fedora Project Wiki
(Remove leftover template goop)
(Upstream is committing to making sdl12-compat a full replacement, so let's adapt accordingly :))
Line 63: Line 63:
 
** Package [https://github.com/libsdl-org/sdl12-compat libsdl12-compat] ([https://bugzilla.redhat.com/show_bug.cgi?id=1960960 RH#1960960])
 
** Package [https://github.com/libsdl-org/sdl12-compat libsdl12-compat] ([https://bugzilla.redhat.com/show_bug.cgi?id=1960960 RH#1960960])
 
** Adjust {{package|SDL}} to not ship the main library package and use the one from <code>libsdl12-compat</code>
 
** Adjust {{package|SDL}} to not ship the main library package and use the one from <code>libsdl12-compat</code>
 +
** Once [https://github.com/libsdl-org/sdl12-compat/issues/34 replacement development headers are available], retire {{package|SDL}} completely.
  
 
* Other developers: N/A <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
* Other developers: N/A <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
Line 101: Line 102:
 
-->
 
-->
  
1. Swap SDL for sdl12-compat: <code>dnf swap SDL sdl12-compat</code>
+
1. Swap <code>SDL</code> for <code>sdl12-compat</code>: <code>dnf swap SDL sdl12-compat</code>
  
 
2. Run something that uses SDL 1.2 like {{package|quake3}} and see that it works.
 
2. Run something that uses SDL 1.2 like {{package|quake3}} and see that it works.
Line 120: Line 121:
  
 
<!-- 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: Restore the <code>SDL</code> package in {{package|SDL}}  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
* Contingency mechanism: Restore the <code>SDL</code> package in {{package|SDL}}. If {{package|SDL}} has been fully retired, then unretire it. <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
<!-- 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: Final Freeze  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
* Contingency deadline: Final Freeze  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->

Revision as of 02:42, 17 May 2021


Replace SDL 1.2 with sdl12-compat using SDL 2.0

Summary

This Change proposes to replace SDL 1.2 with sdl12-compat, which uses SDL 2.0.

Owner


Current status

  • Targeted release: Fedora Linux 35
  • Last updated: 2021-05-17
  • FESCo issue: <will be assigned by the Wrangler>
  • Tracker bug: <will be assigned by the Wrangler>
  • Release notes tracker: <will be assigned by the Wrangler>

Detailed Description

SDL 1.2 development ended long ago, with SDL 2.0 replacing it. However, many older games still use SDL 1.2 and cannot change to SDL 2.0. In order to help move SDL 1.2 games into the modern world, let's replace SDL 1.2 with sdl12-compat, which uses SDL 2.0.

Feedback

Benefit to Fedora

Switching SDL 1.2 powered games to use sdl12-compat offers significant advantages:

  • Automatic support for Wayland with SDL 2.0.16+
  • Native support for PipeWire for audio
  • Massively improved support for inputs (including gamepads)

Ultimately, SDL 2.0 is actively maintained and developed. We want applications that use SDL to use an actively maintained codebase.

Scope

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

Upgrade/compatibility impact

The SDL package would be transparently upgraded to libsdl12-compat package and games using it should just transparently start using SDL 2.0.


How To Test

1. Swap SDL for sdl12-compat: dnf swap SDL sdl12-compat

2. Run something that uses SDL 1.2 like Package-x-generic-16.pngquake3 and see that it works.


User Experience

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

Dependencies

Contingency Plan

  • Contingency mechanism: Restore the SDL package in Package-x-generic-16.pngSDL. If Package-x-generic-16.pngSDL has been fully retired, then unretire it.
  • Contingency deadline: Final Freeze
  • Blocks release? N/A (not a System Wide Change), Yes/No


Documentation

N/A (not a System Wide Change)

Release Notes

Games that use SDL 1.2 will now transparently use SDL 2.0 through the sdl12-compat package. This makes it so applications that historically used SDL 1.2 now use SDL 2.0.