Skip to content

Commit a167fcd

Browse files
MrSidimssys-ce-bb
authored andcommitted
Update README reflecting process of preview extensions removal (#3094)
Co-authored-by: Ashbaugh, Ben <[email protected]> Co-authored-by: Sven van Haastregt <[email protected]> Signed-off-by: Sidorov, Dmitry <[email protected]> Original commit: KhronosGroup/SPIRV-LLVM-Translator@739b46c4d90015a
1 parent d81a050 commit a167fcd

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

llvm-spirv/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,3 +265,18 @@ creating a pull request or raising an issue on GitHub.
265265
As mentioned earlier there are branches `llvm_release_*` that get backported
266266
changes. Those changes if exists are released automatically by github CI on
267267
monthly basis in a format `<llvm_major>.<llvm_minor>.<latest patch +1>`.
268+
269+
## Deprecation of "preview extensions"
270+
271+
In a case if a "preview extension" has to be deprecated, as the first step one
272+
should disable support for forward translation of the extension in the main branch
273+
(this will prevent new SPIR-V modules from being generated using the extension).
274+
Meanwhile support reverse translation for the extension should be continued
275+
(this retains compatibility with existing SPIR-V modules).
276+
* Addition of deprecation warning for the extension is not required.
277+
* We encourage backporting the changes to other branches to speed up removal, but this is not required.
278+
279+
After at least one release cycle one may remove support for reverse translation in the main branch as well,
280+
at which point support for the "preview extension" is considered removed.
281+
282+
These are guidelines, not requirements, and we will consider exceptions on a case-by-case basis.

0 commit comments

Comments
 (0)