KDE Applications Versioning

From KDE Wiki Sandbox
Revision as of 21:07, 13 July 2015 by Tsdgeos (talk | contribs) (often -> sometimes)
Under Construction
This is a new page, currently under construction!


For applications that have no own release schedule beside the release with the KDE Applications releases, it is sometimes forgotten to increase the application version.

This can lead to confusing version numbers in the about dialog and lower the quality of the bugs reported, as it is not clear which version is really affected.

To make this easier, the release scripts will auto-update the following CMake variables in the toplevel CMakeLists.txt of all applications bundled in the KDE Applications:

# KDE Application Version, managed by release script
set (KDE_APPLICATIONS_VERSION_MAJOR "15")
set (KDE_APPLICATIONS_VERSION_MINOR "04")
set (KDE_APPLICATIONS_VERSION_MICRO "0")

You can then use them to define the version for your own application based on this.

For example Kate will do in its CMakeLists.txt:

set (KDE_APPLICATIONS_VERSION "${KDE_APPLICATIONS_VERSION_MAJOR}.${KDE_APPLICATIONS_VERSION_MINOR}.${KDE_APPLICATIONS_VERSION_MICRO}")

and then use this in the config.h.cmake:

#define KATE_VERSION "${KDE_APPLICATIONS_VERSION}"

This is then passed to the KAboutData:

   /**
    * construct about data for Kate
    */
   KAboutData aboutData(QStringLiteral("kate"), i18n("Kate"), QStringLiteral(KATE_VERSION),
                        i18n("Kate - Advanced Text Editor"), KAboutLicense::LGPL_V2,
                        i18n("(c) 2000-2014 The Kate Authors"), QString(), QStringLiteral("http://kate-editor.org"));

Beside using the full version, you could only use the patch release version ${KDE_APPLICATIONS_VERSION_MICRO} to suffix your own version if you don't want to do that manually for each patch release.