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

Jump to: navigation, search
(kservice is in progress)
(khtml is tier 4 according to the maintainers list)
 
(128 intermediate revisions by 14 users not shown)
Line 12: Line 12:
  
 
Definition of done:
 
Definition of done:
* No dependency on kdecore, kdeui, kio, kparts...
+
* No dependency on kde4support, kdecore, kdeui, kio, kparts...
* Modularized CMakeLists.txt [using ECM]
+
* All unused dependencies are removed
* Installs a Config.cmake file for itself [this is done automatically by extra-cmake-modules]
+
* Tier1 modules depend only on Qt modules
 +
* Library name is in CamelCase
 +
* Modularized CMakeLists.txt [using extra-cmake-modules (ECM)]
 +
* Installs a Config.cmake file for itself
 
* Does not install any Find*.cmake modules itself
 
* Does not install any Find*.cmake modules itself
 
* Calls feature_summary at the end of the toplevel CMakeLists.txt (see kcoreaddons for an example)
 
* Calls feature_summary at the end of the toplevel CMakeLists.txt (see kcoreaddons for an example)
Line 22: Line 25:
 
* [[Frameworks/Strategy_and_Policies#Frameworks_have_automatic_unit_tests|Unit tested]]
 
* [[Frameworks/Strategy_and_Policies#Frameworks_have_automatic_unit_tests|Unit tested]]
 
* Maintains [[Frameworks/Epics/Splitting_kdelibs#Strive_for_Source_Compatibility|source compatibility over kdelibs]]
 
* Maintains [[Frameworks/Epics/Splitting_kdelibs#Strive_for_Source_Compatibility|source compatibility over kdelibs]]
* Does not use any Q_WS_* defines (for Qt 5).
+
* Does not use any Q_WS_* defines.
 
* Does not include config.h.
 
* Does not include config.h.
* Does not use QObject::tr(), but only QCoreApplication::translate() with an empty context, for gettext compatibility (po->ts, no context available). A bit ugly, could be removed later on, with either a PoTranslator (to load .po files directly) or whatever Oswald has in mind for a new Qt translation system.
+
* Does not use QObject::tr() static calls, but only use QCoreApplication::translate(), tr() in a non-static way, or i18n() if the framework depends on ki18n.
* See [[Frameworks/Epics/kdelibs_cleanups]] for more details
+
* Document all dependencies in CMakeList between frameworks (example in kauth)
  
  
Line 43: Line 46:
 
{{FrameworkDone|kplotting|Tier 1|Functional|Benjamin Port|}}
 
{{FrameworkDone|kplotting|Tier 1|Functional|Benjamin Port|}}
  
{{FrameworkDone|solid|Tier 1|Integration|Alex Fiestas|}}
+
{{FrameworkDone|solid|Tier 1|Integration|Àlex Fiestas|}}
  
 
{{FrameworkDone|threadweaver|Tier 1|Functional|Mirko Boehm|}}
 
{{FrameworkDone|threadweaver|Tier 1|Functional|Mirko Boehm|}}
Line 55: Line 58:
 
{{FrameworkDone|karchive|Tier 1|Functional|Mario Bensi|}}
 
{{FrameworkDone|karchive|Tier 1|Functional|Mario Bensi|}}
  
{{FrameworkDone|kconfig|Tier 2|Functional|?|
+
{{FrameworkDone|kconfig|Tier 1|Functional|David Faure|Contains KConfigGui + KConfigCore}}
[[KDE_Core/Platform_11/Settings|Details on KConfig/DConf, etc.]]
+
 
Benjamin completing for the move with Kevin's help
+
{{FrameworkDone|kidletime|Tier 1|Integration|Dario Freddi|}}
}}
+
 
 +
{{FrameworkDone|kservice|Tier 3|Solution|David Faure|in staging, tier 3 because of ki18n, could be tier2 otherwise}}
 +
 
 +
{{FrameworkDone|itemviews|Tier 1|Functional|Aurélien Gâteau|}}
 +
 
 +
{{FrameworkDone|kguiaddons|Tier 1|Functional|Martin Klapetek|}}
 +
 
 +
{{FrameworkDone|kjobwidgets|Tier 2|Functional|Kevin Ottens|}}
  
{{FrameworkDone|idletime|Tier 1|Integration|Dario Freddi|}}
+
{{FrameworkDone|kjs|Tier 1|Functional|David Faure|}}
  
{{FrameworkInProgress|kbookmarks|Tier ? (2 or 3)|Functional|Julien Desgats|Right now in kio/bookmarks.}}
+
{{FrameworkDone|ki18n|Tier 2|Functional|Chusslove Illich|}}
  
{{FrameworkInProgress|kservice|Tier 3|Solution|??|Right now in kdecore/services}}
+
{{FrameworkDone|kemoticons|Tier 3|Solution|David Gil|}}
  
{{FrameworkDone|kconfiggui|Tier 2|Functional|?|}}
+
{{FrameworkDone|xmlgui|Tier 3|Integration|Àlex Fiestas|}}
  
{{FrameworkTodo|itemviews|Tier 3|Functional|Stephen Kelly?|}}
+
{{FrameworkDone|sonnet|Tier 1|Functional|Martin Sandsmark|Contains SonnetCore + SonnetUi}}
  
{{FrameworkInProgress|kguiaddons|Tier 1|Functional|??|Will contain the non-QWidget based classes from kdelibs/kdeui}}
+
{{FrameworkDone|frameworkintegration|Tier 4|N/A|Kevin Ottens|}}
  
{{FrameworkInProgress|color widgets|Tier 2|Functional|??|Right now in kdeui/colors. Being splitted by Giorgos Tsiapaliwkas}}
+
{{FrameworkDone|kio|Tier 3|Solution|David Faure|incomplete, will contain KIOCore + KIOWidgets}}
  
{{FrameworkTodo|job widgets|Tier 2|Functional|Kevin Ottens|Right now in kdeui/jobs}}
+
{{FrameworkDone|knotifications|Tier 2|Integration|Aleix Pol|}}
  
{{FrameworkInProgress|dialogs|Tier 3|Functional|Valentin Rusu|Right now in kdeui/dialogs}}
+
{{FrameworkDone|kde4support|Tier 4|N/A|Kevin Ottens|}}
  
{{FrameworkTodo|widgets|Tier 2|Functional|??|Right now in kdeui/widgets. Decide which widgets are and should be 'KDE focussed', and which have use cases outside of KDE http://thread.gmane.org/gmane.comp.kde.devel.frameworks/473/  }}
+
{{FrameworkDone|kde4attic|Tier 4|N/A|Kevin Ottens|It's gone, dismantled}}
  
{{FrameworkDone|kjs|Tier 1|Functional|??|}}
+
{{FrameworkDone|kcodecs|Tier 1|Functional|Stephen Kelly|}}
  
{{FrameworkInProgress|ki18n|Tier 2|Functional|??|}}
+
{{FrameworkDone|kwidgetsaddons|Tier 1|Functional|Stephen Kelly|}}
  
{{FrameworkInProgress|emoticons|Tier 3|Functional|Valentin Rusu|}}
+
{{FrameworkDone|kcompletion|Tier 2|Functional|Aleix Pol|}}
  
{{FrameworkTodo|XMLGUI|Tier 3|Functional|??|Right now in kdeui/actions and kdeui/xmlgui}}
+
{{FrameworkDone|kconfigwidgets|Tier 3|Functional|Aurélien Gâteau|}}
  
{{FrameworkInProgress|sonnet|Tier 2|Functional|???|
+
{{FrameworkDone|kcrash|Tier 2|Solution|Martin Klapetek|}}
* Dependencies on kdecore}}
 
  
{{FrameworkTodo|kcmutils|Tier 4|N/A|??|Right now in kutils/kcmutils}}
+
{{FrameworkDone|kdoctools|Tier 2|Solution|Aleix Pol|}}
  
{{FrameworkTodo|kparts|Tier 4|N/A|??|Right now in kparts}}
+
{{FrameworkDone|kiconthemes|Tier 3|Solution|Àlex Fiestas|kpixmapsequence moved to kwidgetaddons}}
  
{{FrameworkTodo|kde "consistency"|Tier 4|N/A|??|}}
+
{{FrameworkDone|kinterprocesswindowing|Splitted in kwidgetsaddons and kwindowsystem|Integration|Aurélien Gâteau|}}
  
{{FrameworkInProgress|kio-core|Tier ?|Solution|David Faure|}}
+
{{FrameworkDone|ktextwidgets|Tier 3|Functional|Martin Klapetek|}}
  
{{FrameworkTodo|kio-widgets|Tier ?|Solution|David Faure|}}
+
{{FrameworkDone|kunitconversion|Tier 3|Functional|Aleix Pol|}}
  
{{FrameworkInProgress|KDE Notifications Frameworks|probably tier2+3+5|Functional or integration|Sune|
+
{{FrameworkDone|kwallet|Tier 2|Integration|Valentin Rusu|}}
* Work not really started, plan exists in Sune's head
 
* Will give a 'low level' collection of notifications
 
* Something like KNotification today
 
* No knotifydaemon
 
* Some gui thing for integration widgets as today
 
}}
 
  
{{FrameworkInProgress|libplasma2|Tier 3|Solution|Aaron Seigo, Marco Martin|
+
{{FrameworkDone|plasma-framework|Tier 3|Solution|Aaron Seigo, Marco Martin|
 
* libplasma2 already well under way
 
* libplasma2 already well under way
 
* need to identify and break out candidates that belong in lower tiers (e.g. ConfigReader -> kconfigxt++)
 
* need to identify and break out candidates that belong in lower tiers (e.g. ConfigReader -> kconfigxt++)
Line 119: Line 122:
 
}}
 
}}
  
{{FrameworkInProgress|kde4support|Tier 4|N/A|David Faure|}}
+
{{FrameworkDone|kbookmarks|Tier 3|Functional|Kevin Ottens|Uses xmlgui and kconfigwidgets}}
 +
 
 +
{{FrameworkDone|kcmutils|Tier 4|N/A|David Edmundson|In staging}}
 +
 
 +
{{FrameworkDone|kprintutils|Tier 3|?|David Edmundson and Martin Klapetek|}}
 +
 
 +
{{FrameworkDone|kparts|Tier 3|Functional|Aleix Pol|}}
 +
 
 +
{{FrameworkDone|dnssd|Tier 2|Integration|Aleix Pol|Tier2 because the mDnssd backend depends on KConfig. It should probably be stripped out}}
 +
 
 +
{{FrameworkDone|kdeclarative|Tier 3|?|Aleix Pol|}}
 +
 
 +
{{FrameworkDone|kdesu|Tier 3|?|Martin Klapetek|}}
 +
 
 +
{{FrameworkDone|kdewebkit|Tier 3|Functional|Aleix Pol|}}
 +
 
 +
{{FrameworkDone|khtml|Tier 4|?|David Edmundson|Right now in khtml}}
 +
 
 +
{{FrameworkDone|kssl|Tier ?|?|David Faure|Right now in kio/kssl}}
 +
 
 +
{{FrameworkDone|kjsembed|Tier 3|?|Aleix Pol|}}
 +
 
 +
{{FrameworkDone|knewstuff|Tier 3|?|Jeremy Whiting|Right now in knewstuff}}
 +
 
 +
{{FrameworkDone|kpty|Tier 3|?|David Edmundson}}
 +
 
 +
{{FrameworkDone|kross|Tier 3|?|Vishesh Handa|Right now in staging/kross - Tests failing}}
 +
 
 +
{{FrameworkDone|kded|Tier 3|Solution|Àlex Fiestas|}}
 +
{{FrameworkDone|kinit|Tier 3|?|Aleix Pol|In staging}}
 +
{{FrameworkDone|knotifyconfig|Tier 3|?|David Edmundson|In staging}}
 +
{{FrameworkDone|kmediaplayer|Tier 3|?|Alex Merry|
 +
* TESTS!
 +
* Replace/augment D-Bus interface using MPRIS2?
 +
* Above may need some new virtuals
 +
* Default Phonon-based part.
 +
}}
  
 
|}
 
|}
Line 131: Line 170:
 
Yet to be produced frameworks (foreseen tier and type, not set in stone):
 
Yet to be produced frameworks (foreseen tier and type, not set in stone):
  
* dnssd (easy one!)
+
* ...
* libkdebug (Tier 3 / Functional) / Depends on the results coming from qDebug() in Qt5
 
* kcompletion (all the KComboBox, KLineEdit completion features + KCompletion* classes)
 
 
 
 
And probably more...
 
And probably more...
  
Line 141: Line 177:
  
 
To be executed to complete the epic when all the frameworks are "done":
 
To be executed to complete the epic when all the frameworks are "done":
* Remove libinqt5
+
* Make sure it builds and runs against Qt 5.2 final
* Port to qt master (likely upcoming 5.1)
 
 
* Split into its own git module; pre-existing history will remain in the kdelibs repository and be accessible with git graft
 
* Split into its own git module; pre-existing history will remain in the kdelibs repository and be accessible with git graft
 
* Produce a script or cmake file to recreate a kdeexamples tarball out of a set of examples directory in the frameworks
 
* Produce a script or cmake file to recreate a kdeexamples tarball out of a set of examples directory in the frameworks
Line 156: Line 191:
 
* KGlobal::charsets() -> KCharsets::charsets()
 
* KGlobal::charsets() -> KCharsets::charsets()
 
* KGlobal::dirs() -> KStandardDirs::global() (or something?)
 
* KGlobal::dirs() -> KStandardDirs::global() (or something?)
* KGlobal::ref() -> qApp->ref()
+
* KGlobal::ref() / KGlobal::deref() -> QEventLoopLocker
* KGlobal::deref() -> qApp->deref()
 
  
 
etc.
 
etc.

Latest revision as of 14:22, 9 January 2014

kdelibs splitting epic

Important Forewords

If you are working on splitting a framework, make sure to consult 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 KDE Frameworks Policies, it will also need to follow this 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 kde4support, kdecore, kdeui, kio, kparts...
  • All unused dependencies are removed
  • Tier1 modules depend only on Qt modules
  • Library name is in CamelCase
  • Modularized CMakeLists.txt [using extra-cmake-modules (ECM)]
  • Installs a Config.cmake file for itself
  • Does not install any Find*.cmake modules itself
  • Calls feature_summary at the end of the toplevel CMakeLists.txt (see kcoreaddons for an example)
  • All Find*.cmake modules needed by the framework and used also by other frameworks have been upstreamed to extra-cmake-modules (via the kde-buildsystem mailing list) or directly to cmake (via the cmake list). To make sure of this, do not append to CMAKE_MODULE_PATH, but set it.
  • Does not set EXECUTABLE_OUTPUT_PATH anymore.
  • Follows the policy on directory organization
  • Unit tested
  • Maintains source compatibility over kdelibs
  • Does not use any Q_WS_* defines.
  • Does not include config.h.
  • Does not use QObject::tr() static calls, but only use QCoreApplication::translate(), tr() in a non-static way, or i18n() if the framework depends on ki18n.
  • Document all dependencies in CMakeList between frameworks (example in kauth)


Status Framework Tier Type Maintainer Comment
DONE itemmodels Tier 1 Functional Stephen Kelly
DONE kdbusaddons Tier 1 Functional Kevin Ottens
DONE kplotting Tier 1 Functional Benjamin Port
DONE solid Tier 1 Integration Àlex Fiestas
DONE threadweaver Tier 1 Functional Mirko Boehm
DONE kauth Tier 2 Integration Dario Freddi
DONE kcoreaddons Tier 1 Functional Romain Perier/David Faure
DONE kwindowsystem Tier 1 Integration Martin Graesslin
DONE karchive Tier 1 Functional Mario Bensi
DONE kconfig Tier 1 Functional David Faure Contains KConfigGui + KConfigCore
DONE kidletime Tier 1 Integration Dario Freddi
DONE kservice Tier 3 Solution David Faure in staging, tier 3 because of ki18n, could be tier2 otherwise
DONE itemviews Tier 1 Functional Aurélien Gâteau
DONE kguiaddons Tier 1 Functional Martin Klapetek
DONE kjobwidgets Tier 2 Functional Kevin Ottens
DONE kjs Tier 1 Functional David Faure
DONE ki18n Tier 2 Functional Chusslove Illich
DONE kemoticons Tier 3 Solution David Gil
DONE xmlgui Tier 3 Integration Àlex Fiestas
DONE sonnet Tier 1 Functional Martin Sandsmark Contains SonnetCore + SonnetUi
DONE frameworkintegration Tier 4 N/A Kevin Ottens
DONE kio Tier 3 Solution David Faure incomplete, will contain KIOCore + KIOWidgets
DONE knotifications Tier 2 Integration Aleix Pol
DONE kde4support Tier 4 N/A Kevin Ottens
DONE kde4attic Tier 4 N/A Kevin Ottens It's gone, dismantled
DONE kcodecs Tier 1 Functional Stephen Kelly
DONE kwidgetsaddons Tier 1 Functional Stephen Kelly
DONE kcompletion Tier 2 Functional Aleix Pol
DONE kconfigwidgets Tier 3 Functional Aurélien Gâteau
DONE kcrash Tier 2 Solution Martin Klapetek
DONE kdoctools Tier 2 Solution Aleix Pol
DONE kiconthemes Tier 3 Solution Àlex Fiestas kpixmapsequence moved to kwidgetaddons
DONE kinterprocesswindowing Splitted in kwidgetsaddons and kwindowsystem Integration Aurélien Gâteau
DONE ktextwidgets Tier 3 Functional Martin Klapetek
DONE kunitconversion Tier 3 Functional Aleix Pol
DONE kwallet Tier 2 Integration Valentin Rusu
DONE plasma-framework Tier 3 Solution Aaron Seigo, Marco Martin
  • libplasma2 already well under way
  • need to identify and break out candidates that belong in lower tiers (e.g. ConfigReader -> kconfigxt++)
  • QGraphicsView and QML libraries
  • Eventually the runtime bits from kde-runtime and the Plasma QML pieces
  • Source compat is priority, but more relaxed than the rest of Frameworks as QML destroys any realistic possibility of that
  • Porting notes
  • Various identified issue/improvements to be made


DONE kbookmarks Tier 3 Functional Kevin Ottens Uses xmlgui and kconfigwidgets
DONE kcmutils Tier 4 N/A David Edmundson In staging
DONE kprintutils Tier 3 ? David Edmundson and Martin Klapetek
DONE kparts Tier 3 Functional Aleix Pol
DONE dnssd Tier 2 Integration Aleix Pol Tier2 because the mDnssd backend depends on KConfig. It should probably be stripped out
DONE kdeclarative Tier 3 ? Aleix Pol
DONE kdesu Tier 3 ? Martin Klapetek
DONE kdewebkit Tier 3 Functional Aleix Pol
DONE khtml Tier 4 ? David Edmundson Right now in khtml
DONE kssl Tier ? ? David Faure Right now in kio/kssl
DONE kjsembed Tier 3 ? Aleix Pol
DONE knewstuff Tier 3 ? Jeremy Whiting Right now in knewstuff
DONE kpty Tier 3 ? David Edmundson {{{5}}}
DONE kross Tier 3 ? Vishesh Handa Right now in staging/kross - Tests failing
DONE kded Tier 3 Solution Àlex Fiestas
DONE kinit Tier 3 ? Aleix Pol In staging
DONE knotifyconfig Tier 3 ? David Edmundson In staging
DONE kmediaplayer Tier 3 ? Alex Merry
  • TESTS!
  • Replace/augment D-Bus interface using MPRIS2?
  • Above may need some new virtuals
  • Default Phonon-based part.


Backlog

For reference, find the class by class analysis produced during Platform11 on the kdelibs dependencies page

This list is non-final, hence why it is not integrated in the table above, when the scope of a lib gets defined and worked on, it is removed from this list and go in the table above.

Yet to be produced frameworks (foreseen tier and type, not set in stone):

  • ...

And probably more...


Finalization tasks

To be executed to complete the epic when all the frameworks are "done":

  • Make sure it builds and runs against Qt 5.2 final
  • Split into its own git module; pre-existing history will remain in the kdelibs repository and be accessible with git graft
  • Produce a script or cmake file to recreate a kdeexamples tarball out of a set of examples directory in the frameworks

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() / KGlobal::deref() -> QEventLoopLocker

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.


This page was last edited on 9 January 2014, at 14:22. Content is available under Creative Commons License SA 4.0 unless otherwise noted.