Difference between revisions of "Calligra/Schedules/3.0/Porting Plan"

Jump to: navigation, search
(Stuff that can be removed)
(Stuff that can be removed)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
'''See also: [[Calligra/Schedules/3.0/Porting_Notes|Detailed porting notes]]'''
 +
__TOC__
 
== Dates ==
 
== Dates ==
 
* "End of Merge window for master"^ until: Wed March 4th (proposed)
 
* "End of Merge window for master"^ until: Wed March 4th (proposed)
Line 8: Line 10:
 
now and get it in!
 
now and get it in!
  
== Patches to merge ==
+
== Stages of Port ==
Paste links to patches you want in master, so the window won't be closed too early. Remove them after submitting!
+
Given the modular structure of Calligra not all components are in the same stage and sometimes the borders of the stages are unsharp, but ideally everyone works on the same stage
 +
# Restoring build on Qt5/KF5: minimal port of buildsystem and all code, so everything builds at least again (using kdelibs4support and marking any temporary solution with the tag "QT5TODO". Deprecated warnings are turned off here, there are too many from kdelibs4support. Pick your back-to-build task on [https://todo.kde.org/?controller=board&action=show&project_id=73 todo.kde.org]. See for more [[#Initial_porting_steps | Initial porting steps]] - <span style="background:orange">UNCOMPLETE</span>
 +
# Fixing any regressions and anything marked with "QT5TODO": to reach release state as soon as possible (so kdelibs4support usage is very fine). Tests should all pass. Deprecated warnings are still turned off - <span style="background:salmon">STARTED</span>
 +
# Porting away from kdelibs4support (only if other components are still in stage 2, but best help there). Turn on deprecation warnings in the respective subdirs with '''remove_definitions(-Wno-deprecated -Wno-deprecated-declarations)''' - <span style="background:salmon">TODO</span>
  
 
== General ==
 
== General ==
* Porting branch named "frameworks" usually, some stuff expects it even.
+
* Porting branch: "frameworks"
* Min Qt5 version: 5.2 (matches current KF5 min required version)
+
* Min. Qt5 version: 5.2 (matches current KF5 min required version)
* Min KF5 version: 5.?
+
* Min. KF5 version: 5.7?
* Min CMake version: ? (proposal: min required version of used KF5)
+
* Min. CMake version: 2.8.12? (proposal: min required version of used KF5)
* Min ECM version: 1.? (proposal: min required version of used KF5)
+
* Min. ECM version: 1.7.0? (proposal: min required version of used KF5)
  
 
== Porting Rules ==
 
== Porting Rules ==
Line 22: Line 27:
 
* ensure CI always manages to build (to ease life of co-porters)
 
* ensure CI always manages to build (to ease life of co-porters)
 
* love the tests
 
* love the tests
* anything that needs temporarily to be disabled by commenting out should get a tag "QT5TODO" (anything better?), so it will not be forgotton before 3.0
+
* anything that needs temporarily to be disabled by commenting out should get a tag "QT5TODO", so it will not be forgotton before 3.0
 
 
To not have people step on each other toes and do conflicting work there will be a board on todo.kde.org where people can take a product before they start working on making it build. (TODO for Friedrich)
 
 
 
== Porting Helpers ==
 
* [https://todo.kde.org/?controller=board&action=show&project_id=73 Calligra BuildPorting Work Organisation (Pick your task here)]
 
* [https://community.kde.org/Frameworks/Porting_Notes Frameworks 5 porting notes]
 
* [http://doc.qt.io/qt-5/portingguide.html Qt5 Porting Guide]
 
* [http://api.kde.org/frameworks-api/frameworks5-apidocs/ Frameworks 5 apidox]
 
* [https://community.kde.org/Frameworks/Building Frameworks 5 build instructions]
 
* [[Calligra/Building|Building Calligra]] is still the same, just with new deps
 
* [http://quickgit.kde.org/?p=kde-dev-scripts.git kde-dev-scripts.git] on git.kde.org has useful porting scripts
 
* [http://quickgit.kde.org/?p=kdelibs.git&a=blob&h=bbc1c41b06b780301f0b890dcb79831b900dde86&f=KDE5PORTING.html&o=plain#kdecore KDE5PORTING.html]
 
* [http://api.kde.org/ecm/ ECM API dox]
 
* [https://techbase.kde.org/Development/ECM_SourceIncompatChanges ECM SourceIncompatChanges]
 
* http://www.proli.net/2014/06/21/porting-your-project-to-qt5kf5/
 
* http://vizzzion.org/blog/2013/08/kde-frameworks-5-plugin-factory-guts
 
 
 
To see changes done in the previous Qt5 port:
 
    git diff 9fb2dfcfe0ee0aeb032a149d65aae650172d4c9c  origin/calligra-qt5-rempt -- some/subdir/or/files
 
 
 
== Porting Notes ==
 
* recommendation from #kde-devel: not blindly run any porting scripts that are available, but rather decide case-by-case if to run the script or just do manual porting
 
* some of the porting scripts conflict with using kdelibs4support ("e.g. if #include <KGlobal> has been removed, we might have to restore it")
 
  
 
== Porting Targets ==
 
== Porting Targets ==
Line 62: Line 44:
 
* libs/koreport/
 
* libs/koreport/
 
* plugins/reporting/
 
* plugins/reporting/
* plugins/formulashape/
 
* flow/
 
  
 
kdchart & kdgantt are to be replaced by kdiagram (kchart,kgantt, ask frinring).
 
kdchart & kdgantt are to be replaced by kdiagram (kchart,kgantt, ask frinring).
  
db, koproperty & koreport are to be replaced by predicate, kproperty & kreport (ask jstaniek).
+
(DONE) db, koproperty & koreport are to be replaced by kdb, kproperty & kreport, respectively (managed by jstaniek, see [[Kexi/Porting to Qt&KF 5]]).
 
Removing these libs/plugins will also render some Find*,cmake macros unneeded, but best check the buildsystem before just removing them.
 
Removing these libs/plugins will also render some Find*,cmake macros unneeded, but best check the buildsystem before just removing them.
 
rewrite formulashape based on libmathview
 
rewrite flow features in karbon
 
  
 
== Stuff to be done before the port ==
 
== Stuff to be done before the port ==
Line 79: Line 56:
 
* from kde-dev-scripts, run:
 
* from kde-dev-scripts, run:
 
** clean-forward-declaration.sh (remove unused forward declarations)
 
** clean-forward-declaration.sh (remove unused forward declarations)
* from plasma-framework, run:
+
* from plasma-framework/src/tools/, run:
 
** port-qslots.sh (to port to Q_SLOTS and Q_SIGNALS)
 
** port-qslots.sh (to port to Q_SLOTS and Q_SIGNALS)
 
** port-includes.sh (to get rid of the module prefixes in includes)
 
** port-includes.sh (to get rid of the module prefixes in includes)
Line 103: Line 80:
  
 
=== Prepare architecture/technology changes ===
 
=== Prepare architecture/technology changes ===
* plugin loading. This changed a lot in KF5. We already didn't use the sycoca anymore for loading plugins, and we probably can, for now, still use the .desktop file system to find plugins. However, we should check the old Qt5 porting branch and see if we can re-use its plugin loader. That uses the new Qt5 plugin+json combination already. Check KoJsonTrader.cpp
 
 
* That branch also contains some patches for Qt regressions (like bcd822eac52e09b6bf7a4c9fe293c9b3234a6486 or a5361d299b3991f9414466ad9d0c83537e6f2778), so it might be useful to refer to it while porting the libs, Words, Sheets and Stage.
 
* That branch also contains some patches for Qt regressions (like bcd822eac52e09b6bf7a4c9fe293c9b3234a6486 or a5361d299b3991f9414466ad9d0c83537e6f2778), so it might be useful to refer to it while porting the libs, Words, Sheets and Stage.
  
Line 109: Line 85:
  
 
== Stuff not to be done for 3.0 ==
 
== Stuff not to be done for 3.0 ==
Splitting up the repository some more
+
General rules, exception as maintainers allow, but under the risk of being left out from 3.0 release
 +
 
 +
* Splitting up the repository some more
 +
* Refactoring/rewrite of basic libs
 +
* Refactoring /rewrite of apps (without having ported the app first and have it ready for release)
 +
* Rewrite of plugins (without having ported the old version first as much as needed and ready for release)
  
 
==Initial porting steps==
 
==Initial porting steps==
Line 133: Line 114:
 
     dot -Tpng product_deps.dot > product_deps.png
 
     dot -Tpng product_deps.dot > product_deps.png
  
==Links==
+
== Porting Plans of Subprojects ==
 
*[[Kexi/Porting_to_Qt%26KF_5|Porting Kexi to Qt 5 / KF 5]]
 
*[[Kexi/Porting_to_Qt%26KF_5|Porting Kexi to Qt 5 / KF 5]]

Latest revision as of 22:46, 12 January 2016

See also: Detailed porting notes

Dates

  • "End of Merge window for master"^ until: Wed March 4th (proposed)
  • "Porting start": same day of merge window close

^ To get some patches in that do not fit for the 2.9 branch and otherwise would bitrot due to the Qt5/KF5 port, there will be a merge window for master. Everyone having some WIP stuff that is good enough for merging, brush it up now and get it in!

Stages of Port

Given the modular structure of Calligra not all components are in the same stage and sometimes the borders of the stages are unsharp, but ideally everyone works on the same stage

  1. Restoring build on Qt5/KF5: minimal port of buildsystem and all code, so everything builds at least again (using kdelibs4support and marking any temporary solution with the tag "QT5TODO". Deprecated warnings are turned off here, there are too many from kdelibs4support. Pick your back-to-build task on todo.kde.org. See for more Initial porting steps - UNCOMPLETE
  2. Fixing any regressions and anything marked with "QT5TODO": to reach release state as soon as possible (so kdelibs4support usage is very fine). Tests should all pass. Deprecated warnings are still turned off - STARTED
  3. Porting away from kdelibs4support (only if other components are still in stage 2, but best help there). Turn on deprecation warnings in the respective subdirs with remove_definitions(-Wno-deprecated -Wno-deprecated-declarations) - TODO

General

  • Porting branch: "frameworks"
  • Min. Qt5 version: 5.2 (matches current KF5 min required version)
  • Min. KF5 version: 5.7?
  • Min. CMake version: 2.8.12? (proposal: min required version of used KF5)
  • Min. ECM version: 1.7.0? (proposal: min required version of used KF5)

Porting Rules

  • do not port away from kdelibs4support initally, but see to get it added to the build as quickly as possible (only then go perhaps further)
  • ensure CI always manages to build (to ease life of co-porters)
  • love the tests
  • anything that needs temporarily to be disabled by commenting out should get a tag "QT5TODO", so it will not be forgotton before 3.0

Porting Targets

Different parts of Calligra will go different miles for 3.0. Some might port away from kdelibs4support as there is not a lot to do, some might be happily using it for 3.0. Both should be very fine. Important are as few regressions as possible and something that is usable :)

Stuff that can be removed

  • 3rdparty/kdchart/
  • 3rdparty/kdchartpatches/
  • 3rdparty/kdgantt/
  • 3rdparty/kdganttpatches/
  • libs/db/
  • libs/koproperty/
  • libs/koreport/
  • plugins/reporting/

kdchart & kdgantt are to be replaced by kdiagram (kchart,kgantt, ask frinring).

(DONE) db, koproperty & koreport are to be replaced by kdb, kproperty & kreport, respectively (managed by jstaniek, see Kexi/Porting to Qt&KF 5). Removing these libs/plugins will also render some Find*,cmake macros unneeded, but best check the buildsystem before just removing them.

Stuff to be done before the port

Reformatting

Any reformatting should be ideally done also in 2.9, to easy porting any further bug fixes.

  • rename all krita files to the calligra standard. (cc -> cpp, underscore -> CamelCaps)
  • from kde-dev-scripts, run:
    • clean-forward-declaration.sh (remove unused forward declarations)
  • from plasma-framework/src/tools/, run:
    • port-qslots.sh (to port to Q_SLOTS and Q_SIGNALS)
    • port-includes.sh (to get rid of the module prefixes in includes)
    • port-cmake-style.sh (to get a bit more consistency)
  • rest of the scripts at least for pigment and krita (boud)

Under discussion still

  • from kde-dev-scripts, run:
    • astyle-kdelibs (prevents the astyle problems with foreach and so on)

Notes about how to apply it: https://docs.google.com/document/d/1jhq6oXuXKvTilJhcoS6FVKO7yYRu2yCgBS9ojhc2QRU/edit

Pro:

  • clean code

Contra:

  • "Applying full astyle is IMHO not OK, and even against efforts of everyone who keeps eye on proper coding style while doing code reviews." (jstaniek)
  • "Secondly, breaking git blame is unacceptable. Unlike file renames, there's no equivalent of --follow or ignoring whitespace while patching, it's a massive irreversible break in history." (jstaniek)
    People who try this would have to work with scripts like these git-blame-prior-commits

Not to be done

  • replace all header guards with '#pragma once'
    "because errors with header guards are actually quite frequent, and all compilers support this pragma now." (boud)

Reason against: not part of official spec, QtCreator fails on that, not very spread

Prepare architecture/technology changes

  • That branch also contains some patches for Qt regressions (like bcd822eac52e09b6bf7a4c9fe293c9b3234a6486 or a5361d299b3991f9414466ad9d0c83537e6f2778), so it might be useful to refer to it while porting the libs, Words, Sheets and Stage.

Any takers?

Stuff not to be done for 3.0

General rules, exception as maintainers allow, but under the risk of being left out from 3.0 release

  • Splitting up the repository some more
  • Refactoring/rewrite of basic libs
  • Refactoring /rewrite of apps (without having ported the app first and have it ready for release)
  • Rewrite of plugins (without having ported the old version first as much as needed and ready for release)

Initial porting steps

done by 1 person

  1. Merge "calligra/2.9" another time into "master"
  2. Branch off "frameworks" from "master"
  3. Apply https://git.reviewboard.kde.org/r/121541/
  4. Remove subdirs of stuff moved outside already
  5. Port just the buildsystem to Qt5/KF5/ECM as much as needed to get "cmake" configure pass and "make" && "make install" also pass with success, without porting any code (should be all disabled still by step 3).
  6. Create commit and push "frameworks" branch to central Calligra repo
  7. Request a build on KDE CI for the "frameworks" branch
  8. Take disabled product from end of product dep tree^ and make it build:
    1. make yours on https://todo.kde.org/?controller=board&action=show&project_id=73
    2. remove "UNPORTED" tag
    3. port it as much as needed to make it build
    4. commit to "frameworks" branch
  9. if LIB_CALLIGRA has been added to the build, tell everyone to join
    goto 8. until there is no more "UNPORTED" tag

^The dep tree of products can be either seen from content of CalligraProducts.cmake or in a picture by using the generated "product_deps.dot" in the toplevel build dir:

   dot -Tsvg product_deps.dot > product_deps.svg

or

   dot -Tpng product_deps.dot > product_deps.png

Porting Plans of Subprojects


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