Skip to content

Commit d8fb7be

Browse files
[SYCL][Docs] Mention preview macro for early ABI breaks (#18422)
This commit makes a mention of ABI breaking changes being made under preview macro guards to help ensuring they get promoted during the ABI breaking window. Signed-off-by: Larsen, Steffen <[email protected]>
1 parent 0285dff commit d8fb7be

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

sycl/doc/developer/ABIPolicyGuide.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,13 @@ instead of replacing existing APIs. Also, please, avoid any changes, mentioned i
100100
between breaking and non-breaking changes. If unsure, do not hesitate to ask code
101101
owners for help.
102102

103+
If ABI-breaking changes are being planned prior to the ABI-breaking window
104+
opening, the corresponding ABI-breaking changes (including removal of unused
105+
symbols) can be done under the `__INTEL_PREVIEW_BREAKING_CHANGES` macro. This
106+
helps maintainers make sure that the ABI-breaking changes makes it in during the
107+
ABI-breaking window, as they will be considered for promotion out of the
108+
`__INTEL_PREVIEW_BREAKING_CHANGES` guards during that time.
109+
103110
**Note**: Features clearly marked as experimental are considered as an exception
104111
to this guideline.
105112

0 commit comments

Comments
 (0)