[llvm] 10ac235 - [Docs] Add version support information for opaque pointers (NFC)

[Nikita Popov via llvm-commits]

Author: Nikita Popov
Date: 2022-06-08T11:54:34+02:00
New Revision: 10ac235b07515c943354c20fa9efe37c6311f77a

URL: https://github.com/llvm/llvm-project/commit/10ac235b07515c943354c20fa9efe37c6311f77a
DIFF: https://github.com/llvm/llvm-project/commit/10ac235b07515c943354c20fa9efe37c6311f77a.diff

LOG: [Docs] Add version support information for opaque pointers (NFC)

I've seen a few people try to enable opaque pointers with LLVM 14
already. While LLVM 14 has pretty good baseline support, there are
enough missing pieces that you're definitely going to hit assertion
failures if you try this.

Add some wording to make it clear what the support (or planned
support) for opaque/typed pointers is across LLVM 14, 15, and 16.

Added: 
    

Modified: 
    llvm/docs/OpaquePointers.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/OpaquePointers.rst b/llvm/docs/OpaquePointers.rst
index 7d44551f4781..133fc895f187 100644
--- a/llvm/docs/OpaquePointers.rst
+++ b/llvm/docs/OpaquePointers.rst
@@ -222,3 +222,12 @@ The next steps for the opaque pointer migration are:
 
 * Migrate Clang/LLVM tests to use opaque pointers.
 * Remove support for typed pointers after the LLVM 15 branch has been created.
+
+Version Support
+===============
+
+**LLVM 14:** Supports all necessary APIs for migrating to opaque pointers and deprecates/removes incompatible APIs. However, using opaque pointers in the optimization pipeline is **not** fully supported. This release can be used to make out-of-tree code compatible with opaque pointers, but opaque pointers should **not** be enabled in production.
+
+**LLVM 15:** Opaque pointers are enabled by default. Typed pointers are still available, but only supported on a best-effort basis and may be untested.
+
+**LLVM 16:** Only opaque pointers will be supported. Typed pointers will not be supported.