Qt-Version-Compatibility: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
(Remove non-functioning "toc" command)
No edit summary
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Cleanup | reason=Auto-imported from ExpressionEngine.}}
[[Category:Developing_Qt::Guidelines]]
[[Category:Developing_Qt::Guidelines]]
'''''Work In Progress'''''
= Qt Version Compatibility =


Qt uses a major.minor.patch numbering scheme for Qt releases. For example, Qt 5.0.1 represents the 1st patch release of Qt 5.0. Each release has restrictions on what kind of changes are acceptable, in order to provide a predictable and stable API. This enables users who are only interested in certain types of improvements to be sure that they won't be adversely affected by upgrading to a newer version.
Qt uses a major.minor.patch numbering scheme for Qt releases. For example, Qt 5.0.1 represents the 1st patch release of Qt 5.0. Each release has restrictions on what kind of changes are acceptable, in order to provide a predictable and stable API. This enables users who are only interested in certain types of improvements to be sure that they won't be adversely affected by upgrading to a newer version.
Line 21: Line 14:


<blockquote>A library is '''binary compatible''', if a program linked dynamically to a former version of the library continues running with newer versions of the library without the need to recompile.
<blockquote>A library is '''binary compatible''', if a program linked dynamically to a former version of the library continues running with newer versions of the library without the need to recompile.
- [https://techbase.kde.org/Policies/Binary_Compatibility_Issues_With_C techbase.kde.org]++
- [https://community.kde.org/Policies/Binary_Compatibility_Issues_With_C%2B%2B community.kde.org]
</blockquote>
</blockquote>
Below are examples of binary compatible and binary incompatible changes.
=== Compatible Changes ===
=== Incompatible Changes ===


== Source Compatibility Guidelines ==
== Source Compatibility Guidelines ==


<blockquote>If a program needs to be recompiled to run with a new version of library but doesn't require any further modifications, the library is '''source compatible'''.
<blockquote>If a program needs to be recompiled to run with a new version of library but doesn't require any further modifications, the library is '''source compatible'''.
- [https://techbase.kde.org/Policies/Binary_Compatibility_Issues_With_C techbase.kde.org]++
- [https://community.kde.org/Policies/Binary_Compatibility_Issues_With_C%2B%2B community.kde.org]
</blockquote>
</blockquote>
Below are examples of source compatible and source incompatible changes.
=== Compatible Changes ===
=== Incompatible Changes ===


== Compatibility in Modules ==
== Compatibility in Modules ==
Line 55: Line 30:


For more information on which branch you should submit a change to depending on its compatibility, see the [[Branch-Guidelines | branch guidelines]].
For more information on which branch you should submit a change to depending on its compatibility, see the [[Branch-Guidelines | branch guidelines]].
When preparing for a new release, we perform an [[API change review]] to check for any changes incompatible with this policy.
For examples of things you cannot do in C++ while maintaining binary compatibility, see [https://community.kde.org/Policies/Binary_Compatibility_Examples Binary Compatibility Examples].


== References ==
== References ==


http://qt.io/groups/qt-contributors-summit-2011/wiki/Qt5ProductDefinition#a79cebd30df3933c09d6584eb0e9fa54
* [https://wiki.qt.io/Qt-contributors-summit-2011-Qt5ProductDefinition#Compatibility_promise_and_Qt_release_numbering QtCS 2011 defined Qt5 compatibility promises]

Revision as of 10:11, 13 August 2018


Qt uses a major.minor.patch numbering scheme for Qt releases. For example, Qt 5.0.1 represents the 1st patch release of Qt 5.0. Each release has restrictions on what kind of changes are acceptable, in order to provide a predictable and stable API. This enables users who are only interested in certain types of improvements to be sure that they won't be adversely affected by upgrading to a newer version.

We do our best to maintain compatibility between versions. However, in order to improve Qt it is sometimes necessary to break compatibility.

Major releases may break backwards binary and source compatibility, although source compatibility may be maintained.

Minor releases are backwards binary and source compatible.

Patch releases are both backwards and forwards binary and source compatible.

Binary Compatibility Guidelines

A library is binary compatible, if a program linked dynamically to a former version of the library continues running with newer versions of the library without the need to recompile.

- community.kde.org

Source Compatibility Guidelines

If a program needs to be recompiled to run with a new version of library but doesn't require any further modifications, the library is source compatible.

- community.kde.org

Compatibility in Modules

The modules in Qt Essentials have the same forward and backward compatibility promises as Qt 4: new Qt 5 minor releases will not break binary compatibility, and patch level releases are forward and backward compatible. Qt Add-On modules specify their compatibility promise separately.

Additional Information

For more information on which branch you should submit a change to depending on its compatibility, see the branch guidelines.

When preparing for a new release, we perform an API change review to check for any changes incompatible with this policy.

For examples of things you cannot do in C++ while maintaining binary compatibility, see Binary Compatibility Examples.

References