From 8e2cafb3c0a793331143aafad3fcf9053a9bdfa4 Mon Sep 17 00:00:00 2001 From: "Larsen, Steffen" Date: Mon, 12 May 2025 09:34:08 -0700 Subject: [PATCH] [SYCL][Docs] Mention preview macro for early ABI breaks 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 --- sycl/doc/developer/ABIPolicyGuide.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/sycl/doc/developer/ABIPolicyGuide.md b/sycl/doc/developer/ABIPolicyGuide.md index 4f52b01f87819..9b75a169ae31d 100644 --- a/sycl/doc/developer/ABIPolicyGuide.md +++ b/sycl/doc/developer/ABIPolicyGuide.md @@ -100,6 +100,13 @@ instead of replacing existing APIs. Also, please, avoid any changes, mentioned i between breaking and non-breaking changes. If unsure, do not hesitate to ask code owners for help. +If ABI-breaking changes are being planned prior to the ABI-breaking window +opening, the corresponding ABI-breaking changes (including removal of unused +symbols) can be done under the `__INTEL_PREVIEW_BREAKING_CHANGES` macro. This +helps maintainers make sure that the ABI-breaking changes makes it in during the +ABI-breaking window, as they will be considered for promotion out of the +`__INTEL_PREVIEW_BREAKING_CHANGES` guards during that time. + **Note**: Features clearly marked as experimental are considered as an exception to this guideline.