[llvm] 7d1ceb0 - [Docs] Clarify typed pointers support timeline

[Nikita Popov via llvm-commits]

Author: Nikita Popov
Date: 2022-12-23T10:07:59+01:00
New Revision: 7d1ceb02d22d3fa98c1c1d8dd44f8e12d25f4c63

URL: https://github.com/llvm/llvm-project/commit/7d1ceb02d22d3fa98c1c1d8dd44f8e12d25f4c63
DIFF: https://github.com/llvm/llvm-project/commit/7d1ceb02d22d3fa98c1c1d8dd44f8e12d25f4c63.diff

LOG: [Docs] Clarify typed pointers support timeline

As there have been a couple of questions about this recently, this
gives a hard timeline on typed pointers support.

Given that we are about a month away from LLVM 16 branching, I think
we should retain best-effort typed pointer support in LLVM 16 even
if we get all tests migrated before that point.

Conversely, regardless of what the actual test migration state will
be at that point, I believe we should un-support typed pointers as
a matter of policy immediately after branching. Once release/16.x
has been branched, typed pointers on main will no longer be
supported (and can be actively broken). We only need to keep
not-yet-migrated tests working, if there are any left at that point.

Differential Revision: https://reviews.llvm.org/D140487

Added: 
    

Modified: 
    llvm/docs/OpaquePointers.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/OpaquePointers.rst b/llvm/docs/OpaquePointers.rst
index 4ae3aa1043b38..07a080b005ad8 100644
--- a/llvm/docs/OpaquePointers.rst
+++ b/llvm/docs/OpaquePointers.rst
@@ -268,19 +268,26 @@ Version Support
 **LLVM 15:** Opaque pointers are enabled by default. Typed pointers are still
 supported.
 
-**LLVM 16:** Only opaque pointers will be supported. Typed pointers will not be supported.
+**LLVM 16:** Opaque pointers are enabled by default. Typed pointers are
+supported on a best-effort basis only and not tested.
+
+**LLVM 17:** Only opaque pointers are supported. Typed pointers are not
+supported.
 
 Transition State
 ================
 
-As of December 2022 (LLVM 16):
-
-Typed pointers are currently still supported on a best-effort basis. Patches to
-fix typed pointer support are accepted, but must not include test coverage.
+As of December 2022:
 
 Tests are in the process of being converted to opaque pointers. All new tests
-must use opaque pointers. Typed pointer support will be removed as soon as test
-migration finishes.
+must use opaque pointers.
+
+Typed pointers are supported on a best-effort basis in LLVM 16, but are *not*
+supported in LLVM 17. Fixes for typed pointer support will be accepted on the
+``main`` branch only until the creation of the ``release/16.x`` branch
+(expected on Jan 24th 2023). After that point, typed pointer support on the
+``main`` branch will only be retained to the degree that is necessary to not
+break tests that haven't been migrated yet.
 
 The following typed pointer functionality has already been removed: