Difference between revisions of "Frameworks/Epics/Splitting kdepimlibs"

(Created page with "== kdepimlibs splitting epic == === Important Forewords === If you are working on splitting a framework, make sure to consult [[Frameworks/Epics/Splitting_kdelibs/Common_Soluti...")
 
(Blanked the page)
 
Line 1: Line 1:
== kdepimlibs splitting epic ==
 
  
=== Important Forewords ===
 
 
If you are working on splitting a framework, make sure to consult [[Frameworks/Epics/Splitting_kdelibs/Common_Solutions|our list of common issues]]. It will give you an overview of the solutions you're supposed to use to deal with some of the dependencies.
 
 
Also, when splitting out a framework, it is part of being done to comply with the [[Frameworks/Policies|KDE Frameworks Policies]], it will also need to follow this [[Frameworks/Epics/Splitting_kdepimlibs#Policies|Epic Policies]]. Any framework in the staging area cannot move to its final place without following those policies.
 
 
And last but not least, if you create a new framework, please consider being its maintainer as well. We need people to ensure the stewardship of all the frameworks.
 
 
== Existing frameworks ==
 
 
Definition of done:
 
* No dependency on kdeui or kdecore
 
* Modularized CMakeLists.txt
 
* Follows the [[Frameworks/Strategy_and_Policies#Framework_directory_structure|policy on directory organization]]
 
* [[Frameworks/Strategy_and_Policies#Frameworks_have_automatic_unit_tests|Unit tested]]
 
* Has an appointed maintainer
 
* Maintains [[Frameworks/Epics/Splitting_kdepimlibs#Strive_for_Source_Compatibility|source compatibility over kdepimlibs]]
 
 
 
{| class="sortable" border="1" cellpadding="5" cellspacing="0" style="border: gray solid 1px; border-collapse: collapse; text-align: left; width:100%;"
 
|- style="background: #ececec; white-space:nowrap;"
 
! Status
 
! Framework
 
! Tier
 
! Type
 
! width=120 | Maintainer
 
! Comment
 
|-
 
{{FrameworkInProgress|name|Tier X|Functional|??|??}}
 
 
|}
 
 
== Backlog ==
 
 
Yet to be produced frameworks (foreseen tier and type, not set in stone):
 
* akonadi
 
* kblog
 
* kcalcore
 
* kholidays
 
* kimap
 
* kldap
 
* kmbox
 
* kmime
 
* kpimutils
 
* ktnef
 
* kxmlrpcclient
 
* microblog
 
* gpgme++/qgpgme
 
* syndication
 
* kontactinterface
 
* kpimidentities
 
* kpimtexteditor
 
* mailtransport
 
 
 
 
== Policies ==
 
 
=== Strive for Source Compatibility ===
 
 
Avoid removing API from the frameworks branch, even if it is replaced or deprecated. Prefer to implement the old API in terms of the new API.
 
 
In some cases this is very easy. For example, many APIs in KGlobal will be replaced as part of the frameworks effort.
 
 
* KGlobal::charsets() -> KCharsets::charsets()
 
* KGlobal::dirs() -> KStandardDirs::global() (or something?)
 
* KGlobal::ref() -> qApp->ref()
 
* KGlobal::deref() -> qApp->deref()
 
 
etc.
 
 
Removing this API from KGlobal is not necessary in most cases, and it introduces a porting burden which is best avoided.
 
 
There is unlikely to be a 1:1 mapping of old API to new API in every case, so how to implement the old API may not always be obvious. However, attempting to ensure that the older API remains useful should be at the front of our efforts and standards in the frameworks branch.
 
 
=== Binary compatibility policy relaxed ===
 
 
During the execution of this epic, the binary compatibility contraints from the global policy list is lifted.
 

Latest revision as of 06:44, 10 February 2015


This page was last edited on 10 February 2015, at 06:44. Content is available under Creative Commons License SA 4.0 unless otherwise noted.