[llvm] 3d888b0 - [Docs] Clarify CLANG_ENABLE_OPAQUE_POINTERS behavior (NFC)

[Nikita Popov via llvm-commits]

Author: Nikita Popov
Date: 2022-05-10T10:02:01+02:00
New Revision: 3d888b0491f899d5255653eb2f294c38248a4fc9

URL: https://github.com/llvm/llvm-project/commit/3d888b0491f899d5255653eb2f294c38248a4fc9
DIFF: https://github.com/llvm/llvm-project/commit/3d888b0491f899d5255653eb2f294c38248a4fc9.diff

LOG: [Docs] Clarify CLANG_ENABLE_OPAQUE_POINTERS behavior (NFC)

While it originally did, this option no longer affects the cc1
interface. For the cc1 interface, -no-opaque-pointers has to be
passed, there is no cmake option.

Added: 
    

Modified: 
    llvm/docs/OpaquePointers.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/OpaquePointers.rst b/llvm/docs/OpaquePointers.rst
index 12689d8cd6ccc..de553874a859f 100644
--- a/llvm/docs/OpaquePointers.rst
+++ b/llvm/docs/OpaquePointers.rst
@@ -195,10 +195,18 @@ Transition State
 ================
 
 As of April 2022 both LLVM and Clang have complete support for opaque pointers,
-and opaque pointers are enabled by default in Clang. It is possible to
-temporarily restore the old default using the
-``-DCLANG_ENABLE_OPAQUE_POINTERS=OFF`` cmake option. Opaque pointers can be
-disabled for a single Clang invocation using ``-Xclang -no-opaque-pointers``.
+and opaque pointers are enabled by default in Clang.
 
-The MLIR and Polly monorepo projects are not fully compatible with opaque
-pointers yet.
+For users of the clang driver interface, it is possible to temporarily restore
+the old default using the ``-DCLANG_ENABLE_OPAQUE_POINTERS=OFF`` cmake option,
+or by passing ``-Xclang -no-opaque-pointers`` to a single clang invocation.
+
+For users of the clang cc1 interface, ``-no-opaque-pointers`` can be passed.
+Note that the ``CLANG_ENABLE_OPAQUE_POINTERS`` cmake option has no effect on
+the cc1 interface.
+
+The next steps for the opaque pointer migration are:
+
+* Migrate Clang/LLVM tests to use opaque pointers.
+* Enable opaque pointers by default in LLVM.
+* Remove support for typed pointers after the LLVM 15 branch has been created.