Update some AliasAnalysis pass docs for getAdjustedAnalysisPointer.

[oota-llvm.git] / docs / AliasAnalysis.rst

diff --git a/docs/AliasAnalysis.rst b/docs/AliasAnalysis.rst
index 3bfb0953aff2c8df55193907f9ff0a65098764ee..1cbaee703f30be47ff47ea1e3d9914d646addbce 100644 (file)
--- a/docs/AliasAnalysis.rst
+++ b/docs/AliasAnalysis.rst
@@ -246,6 +246,20 @@ analysis run method (``run`` for a ``Pass``, ``runOnFunction`` for a
     return false;
   }
 
+Required methods to override
+----------------------------
+
+You must override the ``getAdjustedAnalysisPointer`` method on all subclasses
+of ``AliasAnalysis``. An example implementation of this method would look like:
+
+.. code-block:: c++
+
+  void *getAdjustedAnalysisPointer(const void* ID) override {
+    if (ID == &AliasAnalysis::ID)
+      return (AliasAnalysis*)this;
+    return this;
+  }
+
 Interfaces which may be specified
 ---------------------------------