Skip to content

Commit 02097b8

Browse files
committed
Modify pointer docs in response to PR #1159 feedback
1 parent 01e1669 commit 02097b8

File tree

2 files changed

+12
-15
lines changed

2 files changed

+12
-15
lines changed

docs/source/user-guide/deprecation.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ Although Opaque Pointers are already the default in LLVM 15, llvmlite still used
3434
Typed Pointers by default with LLVM 15 in llvmlite 0.44.
3535

3636
The binding layer will move to using Opaque Pointers. The IR layer will still
37-
support both Typed and Opaque Pointers, defaulting to Typed Pointers. This
38-
allows llvmlite to continue being used with LLVM-based projects that use an
39-
older LLVM version, such as `NVVM
37+
support both Typed and Opaque Pointers, defaulting to Typed Pointers when
38+
pointee types are provided. This allows llvmlite to continue being used with
39+
LLVM-based projects that use an older LLVM version, such as `NVVM
4040
<https://docs.nvidia.com/cuda/nvvm-ir-spec/>`_.
4141

4242
Examples(s) of the impact
4343
-------------------------
4444

45-
In a future release of llvmlite, code that uses llvmlite to work with pointers
46-
or to parse assembly that uses pointers will break if not modified to use
47-
Opaque Pointers.
45+
In a future release, code that uses llvmlite to work with Typed Pointers or
46+
generate IR with Typed Pointers will break if not modified to use Opaque
47+
Pointers.
4848

4949
In the meantime, IR generated by the IR layer and parsed by the binding layer
5050
will be auto-upgraded to use Opaque Pointers transparently; no action is
@@ -53,7 +53,7 @@ required by the user.
5353
Schedule
5454
--------
5555

56-
- In llvmlite 0.45, support for Opaque Pointers in the binding layer will be
56+
- In llvmlite 0.45, support for Typed Pointers in the binding layer will be
5757
removed. The IR layer will still use Typed Pointers by default.
5858
- In a future version of llvmlite (>= 0.46), the IR layer will use Opaque
5959
Pointers by default.

docs/source/user-guide/ir/types.rst

+5-8
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,13 @@ Pointer Types
101101
=============
102102

103103
The IR layer presently supports both *Typed Pointers* and *Opaque Pointers*.
104-
Typed Pointers are currently the default; Opaque Pointers will become the
105-
default in future, and support for Typed Pointers will be eventually be
106-
removed.
104+
Support for Typed Pointers will be eventually be removed.
107105

108106
.. note::
109107
Further details of the migration to Opaque Pointers are outlined in the
110108
section on :ref:`deprecation-of-typed-pointers`.
111109

112-
When Typed Pointers are enabled, the pointer type is represented using:
110+
Typed Pointers are created using:
113111

114112
.. class:: PointerType(pointee, addrspace=0)
115113

@@ -127,8 +125,8 @@ When Typed Pointers are enabled, the pointer type is represented using:
127125

128126
The type pointed to.
129127

130-
Opaque Pointers can be enabled in the IR layer by setting the environment
131-
variable:
128+
Printing of Typed Pointers as Opaque Pointers can be enabled by setting the
129+
environment variable:
132130

133131
.. code:: bash
134132
@@ -144,8 +142,7 @@ llvmlite, but prior to using any of its functionality. For example:
144142
145143
# ... continue using llvmlite ...
146144
147-
When Opaque Pointers are enabled (by disabling Typed Pointers), the pointer
148-
type is represented using:
145+
Opaque Pointers can be created by using:
149146

150147
.. class:: PointerType(addrspace=0)
151148
:no-index:

0 commit comments

Comments
 (0)