From Fedora Project Wiki
(Start Adapting the Change Template to an SCL Template)
 
(Add release notes section to the template.)
 
(4 intermediate revisions by the same user 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 "edit" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR SCL REQUEST.'''}}
{{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 "edit" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR SCL REQUEST.'''}}
{{draft|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.}}


<!--
<!--
Line 10: Line 12:


== Summary ==
== Summary ==
<!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release. -->
<!-- A sentence or two summarizing what platform this SCL will establish. This information is used to tell end users what the SCL is all about. -->


== Owner ==
== Maintainers ==
<!--  
<!--  
For change proposals to quality as self-contained, owners of all affected packages need to be included here. Alternatively, a SIG can be listed as an owner if it owns all affected packages.  
Specific people that are the owners of this SCL. Once the SCL and SCL Metapackage are approved, the owners will be listed in the PackageDB as the Owners of the SCL Metapackage. This section is who to contact before approval.
This should link to your home wiki page so we know who you are.
-->
* Name: [[User:FASAcountName| Your Name]]
<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
* Email: <your email address so we can contact you, invite you to meetings, etc.>
* Release notes owner: <!--- To be assigned by docs team [[User:FASAccountName| Release notes owner name]] <email address> -->
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
-->
 
== Current status ==
* Targeted release: [[Releases/<number> | Fedora <number> ]]
* Last updated: (DATE)
<!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page
Bugzilla states meaning as usual:
NEW -> change proposal is submitted and announced
ASSIGNED -> accepted by FESCo with on going development
MODIFIED -> change is substantially done and testable
ON_QA -> change is code completed and could be tested in the Beta release (optionally by QA)
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
-->
-->
* Tracker bug: <will be assigned by the Wrangler>
* Names:
** [[User:FASAcountName| Maintainer Name]] - <email address>  <!-- email addresses may be used to reach the maintainers prior to the SCL being approved -->
** [[User:FASAcountName| Maintainer2 Name]] - <maintainer2 email address>


== 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.  -->


== Benefit to Fedora ==
== Packages in the Platform ==
<!-- What is the benefit to the platform?  If this is a major capability update, what has changed?  If this is a new functionality, what capabilities does it bring? Why will Fedora become a better distribution or project because of this proposal?-->


== Scope ==
<!-- 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.  -->
<!-- What work do the developers have to accomplish to complete the change in time for release? Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->


* Proposal owners:
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).
<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->


* Other developers: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
* <package name>
<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
* <package2 name>


* Release engineering: N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
=== Compatibility Guarantees ===
<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuid required?  If a rel-eng ticket exists, add a link here.  -->


* Policies and guidelines: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
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 the packaging guidelines or other documents need to be updated for this feature?  If so, does it need to happen before or after the implementation is done?  If a FPC ticket exists, add a link here. -->
 
== Upgrade/compatibility impact ==
<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)
 
== 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.  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.  
 
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.
 
A good "how to test" should answer these four questions:
 
0. What special hardware / data / etc. is needed (if any)?
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?
-->


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- Do not erase the following two lines.  They're there to warn end users: -->
N/A (not a System Wide Change)
{{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.}}


== User Experience ==
<!-- If this change proposal is noticeable by its target audience, how will their experiences change as a result?  Describe what they will see or notice. -->
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)


== Dependencies ==
<!-- 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. -->
<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this change depends? In other words, completion of another change owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel change)? -->


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
== Release Notes and Change History ==
N/A (not a System Wide Change)


== Contingency Plan ==
<!-- Change N to the Fedora release that this SCL is first appearing in -->
<!-- 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.  -->
=== Fedora N  ===
* Contingency mechanism: (What to do?  Who will do it?) N/A (not a System Wide Change)  <!-- 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. -->
* Contingency deadline: N/A (not a System Wide Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- 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 -->


== Documentation ==
<!-- Fill in this section with information that should go in the release notes for this new SCL -->
<!-- Is there upstream documentation on this change, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->


<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
<!-- If the Compat Guarantees change or you must change something in the Compat Guarantees in an incompatible manner be sure to update this section with additional entries:
N/A (not a System Wide Change)


== Release Notes ==
=== Fedora N2 ===
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this change, indicate them here.  A link to upstream documentation will often satisfy this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release.


Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.  
* Had to change the behaviour of url.get() when retrieving https sites due to security risk.  This function now fails if the server's certificates are invalid or cannot be verified.  An optional parameter, allow_broken, can restore the former behaviour if you are willing to assume the security risk.
* The db library code was updated because upstream no longer supports the old library and the old code had too many security flaws.  The new version has an incompatible file format.  We ship a script /usr/bin/convert_db that can convert from the old format to the new one but it must be run on each db file before the library can read it.  It's beyond the scope of this SCL to determine what an application chooses to do if it encounters a db file it doesn't know what to do with so there's the chance that an application may choose to overwrite old db files instead of letting you upgrade them.  Please take backups.
-->
-->


[[Category:ChangePageIncomplete]]
<!-- When your change proposal page is completed and ready for review and announcement -->
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
<!-- The Wrangler announces the Change to the devel-announce list and changes the category to Category:ChangeAnnounced (no action required) -->
<!-- After review, the Wrangler will move your page to Category:ChangeReadyForFesco... if it still needs more work it will move back to Category:ChangePageIncomplete-->


<!-- Select proper category, default is Self Contained Change -->
[[Category:SCL Definiton (draft)]]
[[Category:SelfContainedChange]]
<!-- When your SCL Request is ready for review by the FPC:
<!-- [[Category:SystemWideChange]] -->
    * Go to https://fedorahosted.org/fpc/
    * Log in with your Fedora Account
    * Open a new ticket https://fedorahosted.org/fpc/newticket
    * Set the Component to SCL Request
    * In the description, be sure to link to this page.
  -->

Latest revision as of 18:21, 22 May 2014

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.


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.

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).
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.


Release Notes and Change History

Fedora N

Retrieved from "https://fedoraproject.org/w/index.php?title=User:Toshio/SCL_Request_Template&oldid=378654"