[PATCH] D102292: [docs] Add page on opaque pointer types

[David Blaikie via Phabricator via llvm-commits]

dblaikie added a comment.

Looks like a good start - might benefit from a smidge more structure (see comment)



================
Comment at: llvm/docs/OpaquePointers.rst:30-33
+The frontend should already know what type each operation operates on based on
+the input source code. However, frontends like Clang may end up relying on LLVM
+pointer pointee types to keep track of pointer types. The frontend needs to make
+sure keep track of pointee types on its own.
----------------
This is the first paragraph that seems to assume the existence/description/knowledge of the future state (opaque pointers) but nothing before this paragraph seems to have described that future, so the motivation for the suggestion to frontends to keep track of pointee types on their own is missing due to that.

Might be worth separate headings for "Motivation", "Solution", and "fallout"/necessary changes (as either prerequisite cleanup in LLVM itself, or as "this is the sort of thing you need to do now that you're trying to integrate your LLVM-using code with a new version of LLVM that lacks pointee types")


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D102292/new/

https://reviews.llvm.org/D102292