@@ -92,13 +92,22 @@ There is a set of tests to help identifying ABI changes:
92
92
classes for layout changes, while ` symbol_size ` only checks ` sizeof ` for API
93
93
classes. Changing the class layout is a breaking change.
94
94
95
- ## Breaking ABI
95
+ ## Changing ABI
96
+
97
+ ** Note (October, 2020)** : DPC++ runtime and compiler ABI is currently in frozen
98
+ state. This means that no ABI-breaking changes will be accepted by default.
99
+ Project maintainers may still approve breaking changes in some cases. Please,
100
+ try to avoid any breaking changes until freeze is lifted. If you need to change
101
+ existing functionality, consider adding new APIs instead of replacing them.
102
+ Also, please, avoid any changes, mentioned in the [ Intro] ( #intro ) section as
103
+ breaking. Refer to the above guide to distinguish breaking and non-breaking
104
+ changes. If not sure, do not hesitate to ask code owners for help.
96
105
97
106
Whenever you need to change the existing ABI, please, follow these steps:
98
107
99
108
1 . Adjust you PR description to reflect (non-)breaking ABI changes. Make sure
100
109
it is clear, why breaking ABI is necessary.
101
110
2 . Fix failing ABI tests in your Pull Request. Use aforementioned techniques to
102
111
update test files.
103
- 3 . If Pull Request introduces a breaking change, update the library version
104
- according to the policies.
112
+ 3 . ~~ If Pull Request introduces a breaking change, update the library version~~
113
+ ~~ according to the policies.~~ ** (See note above) **
0 commit comments