From Fedora Project Wiki
(Fix up the Category and procedure for getting this to the FPC)
(Write out the compat guarantees section)
Line 23: Line 23:
  
 
== Detailed Description ==
 
== Detailed Description ==
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
+
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. This should let end users know more about the platform that the SCL is attempting to create.  -->
  
 
== Packages in the Platform ==
 
== Packages in the Platform ==
  
<!-- The platform that the SCL is creating  -->
+
<!-- The platform that the SCL is creating is implemented by a set of rpm packages.  There may be additional packages in Fedora that are built for the SCL but are not part of the platform.  This section of the SCL Definition makes it clear to end users what packages are part of the platform so they do not have false expectations. -->
 +
 
 +
The following packages are part of the platform that this SCL implements.  Packages which are built for the SCL but not mentioned here are not part of the platform and may be removed or changed in incompatible ways according to normal Fedora Policies (Usually, when a new release of Fedora is made).
 +
 
 +
* <package name>
 +
* <package2 name>
  
 
=== Compatibility Guarantees ===
 
=== Compatibility Guarantees ===
  
<!-- Do not erase the following lineIt's there to warn end users: -->
+
The packages in an SCL's platform are often more concerned with maintaining backwards compatibility than other packages in Fedora as SCLs exist to provide you with a more stable platform to build your own cross-platform software.  As such, many of the packages in the SCL have specific compatibility guarantees.  This section defines which packages in this SCL have more strict backwards compatibility guarantees and what those guarantees are so that you know what to expect.
 +
 
 +
<!-- Do not erase the following two linesThey're there to warn end users: -->
 
{{admon/warning|Security trumps compatibility|If a security issue needs to be fixed but that breaks backwards compatibility, the security issue will be fixed despite violating the guarantee. This page will be updated to mention the Fedora versions and the version of the relevant packages from the SCL which needed a backwards incompatible change to fix the issue).}}
 
{{admon/warning|Security trumps compatibility|If a security issue needs to be fixed but that breaks backwards compatibility, the security issue will be fixed despite violating the guarantee. This page will be updated to mention the Fedora versions and the version of the relevant packages from the SCL which needed a backwards incompatible change to fix the issue).}}
 +
{{admon/warning|Guarantees are only best effort|SCL maintainers attempt to keep these backwards compatibility guarantees but the guarantees are not set in stone.  As an example, the guarantees could be changed if the maintainer of an SCL decides to orphan it and someone new takes over.  The new maintainer may decide to guarantee backwards compatibility for a smaller set of packages or make incompatible updates to some of the existing packages.  These types of changes can only occur between Fedora releases.}}
 +
  
(Bug for bug compat?)
+
<!-- Fill in this section with any guarantees you wish to make for packages in the SCL.  See https://fedoraproject.org/wiki/User:Toshio/SCL_Guidelines_%28draft%29#Compatibility_Guarantees for examples of what makes a good guarantee. -->
()
 
  
 
[[Category:SCL Definiton (draft)]]
 
[[Category:SCL Definiton (draft)]]

Revision as of 03:42, 9 January 2014

Important.png
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 "edit" link.
Copy the source to a new page before making changes! DO NOT EDIT THIS TEMPLATE FOR YOUR SCL REQUEST.


Warning.png
This page is a draft only
It is still under construction and content may change. Do not rely on the information on this page. This is a draft SCL Definition. It needs to be approved by the FPC before an SCL following this draft can be created. The FPC uses the criteria on https://fedoraproject.org/wiki/User:Toshio/SCL_Guidelines_(draft)#SCL_Criteria to evaluate whether the SCL is okay for Fedora.


SCL Name

Summary

Maintainers

Detailed Description

Packages in the Platform

The following packages are part of the platform that this SCL implements. Packages which are built for the SCL but not mentioned here are not part of the platform and may be removed or changed in incompatible ways according to normal Fedora Policies (Usually, when a new release of Fedora is made).

  • <package name>
  • <package2 name>

Compatibility Guarantees

The packages in an SCL's platform are often more concerned with maintaining backwards compatibility than other packages in Fedora as SCLs exist to provide you with a more stable platform to build your own cross-platform software. As such, many of the packages in the SCL have specific compatibility guarantees. This section defines which packages in this SCL have more strict backwards compatibility guarantees and what those guarantees are so that you know what to expect.

Warning.png
Security trumps compatibility
If a security issue needs to be fixed but that breaks backwards compatibility, the security issue will be fixed despite violating the guarantee. This page will be updated to mention the Fedora versions and the version of the relevant packages from the SCL which needed a backwards incompatible change to fix the issue).
Warning.png
Guarantees are only best effort
SCL maintainers attempt to keep these backwards compatibility guarantees but the guarantees are not set in stone. As an example, the guarantees could be changed if the maintainer of an SCL decides to orphan it and someone new takes over. The new maintainer may decide to guarantee backwards compatibility for a smaller set of packages or make incompatible updates to some of the existing packages. These types of changes can only occur between Fedora releases.