Merging breaking changes of internal API: Difference between revisions
Jump to navigation
Jump to search
m (Proof-reading and wiki mark-up improvements.) |
(Tweek a wording, and prepare to add a section on deprecations.) |
||
| Line 10: | Line 10: | ||
;Preferred Workflow:If you can, try to split your change into two: One that adds the new API, and one that removes the old API. Then: | ;Preferred Workflow:If you can, try to split your change into two: One that adds the new API, and one that removes the old API. Then: | ||
:#Merge the change which adds the new API | :#Merge the change which adds the new API | ||
:#Once | :#Once each dependent module has been updated to use a SHA that has your change in, create a commit to port its usage of the old API to the new API. | ||
:#When all modules have been ported to the new API, integrate the change that removes the old API. | :#When all modules have been ported to the new API, integrate the change that removes the old API. | ||
| Line 18: | Line 18: | ||
:#Integrate the breaking change. | :#Integrate the breaking change. | ||
:#After the change has been integrated, add the submodule update 'bot as a reviewer to the changes in the other modules. Your changes will stage automatically with the next Submodule Update round. | :#After the change has been integrated, add the submodule update 'bot as a reviewer to the changes in the other modules. Your changes will stage automatically with the next Submodule Update round. | ||
== Deprecations == | |||
Revision as of 08:03, 13 July 2022
While public API cannot be removed except in a new major Qt release, the same does not hold for private API. However, simply removing private API in one module can break other Qt modules which depend on it. While the submodule update 'bot workflow allows those modules to keep reusing a version of Qt that is still compatible with them, at some point they have to move to the latest version of their dependencies. Thus, any time one removes or modifies existing API, one should follow the procedure below to provide a smooth development experience for everyone working on Qt.
- Check if your change breaks other modules
- If you suspect that your change might break other modules, it is generally a good idea to at least compile the essential modules before merging your change. In the following steps, we assume that you actually found some breakage. Otherwise, you can just merge your change.
- Preferred Workflow
- If you can, try to split your change into two: One that adds the new API, and one that removes the old API. Then:
- Merge the change which adds the new API
- Once each dependent module has been updated to use a SHA that has your change in, create a commit to port its usage of the old API to the new API.
- When all modules have been ported to the new API, integrate the change that removes the old API.
- Alternative Workflow
- Sometimes, it may however not be possible or, or may be very inconvenient, to split your change into two atomic changes as described above. A common occurrence of this is when a bug fix necessitates a behavior change of existing API, or a change to signature in a virtual API. In those cases, you can follow the following steps:
- Create commits to fix all modules and upload them to gerrit.
- Ensure that they get reviewed and accepted, but do not stage them yet.
- Integrate the breaking change.
- After the change has been integrated, add the submodule update 'bot as a reviewer to the changes in the other modules. Your changes will stage automatically with the next Submodule Update round.