[llvm] 70c9212 - [ORC] Fix some comments in the LLJITWithObjectLinkingLayerPlugin example.

[Lang Hames via llvm-commits]

Author: Lang Hames
Date: 2021-03-12T19:13:42-08:00
New Revision: 70c921267e90d9c6d6b3980aca6e6fad0c0344f6

URL: https://github.com/llvm/llvm-project/commit/70c921267e90d9c6d6b3980aca6e6fad0c0344f6
DIFF: https://github.com/llvm/llvm-project/commit/70c921267e90d9c6d6b3980aca6e6fad0c0344f6.diff

LOG: [ORC] Fix some comments in the LLJITWithObjectLinkingLayerPlugin example.

Added: 
    

Modified: 
    llvm/examples/OrcV2Examples/LLJITWithObjectLinkingLayerPlugin/LLJITWithObjectLinkingLayerPlugin.cpp

Removed: 
    


################################################################################
diff  --git a/llvm/examples/OrcV2Examples/LLJITWithObjectLinkingLayerPlugin/LLJITWithObjectLinkingLayerPlugin.cpp b/llvm/examples/OrcV2Examples/LLJITWithObjectLinkingLayerPlugin/LLJITWithObjectLinkingLayerPlugin.cpp
index 34776cb42113..7bfc93c02989 100644
--- a/llvm/examples/OrcV2Examples/LLJITWithObjectLinkingLayerPlugin/LLJITWithObjectLinkingLayerPlugin.cpp
+++ b/llvm/examples/OrcV2Examples/LLJITWithObjectLinkingLayerPlugin/LLJITWithObjectLinkingLayerPlugin.cpp
@@ -60,19 +60,14 @@ class MyPlugin : public ObjectLinkingLayer::Plugin {
            << LG.getTargetTriple().str() << "):\n";
 
     // Print sections, symbol names and addresses, and any edges for the
-    // associated blocks.
-    Config.PostPrunePasses.push_back(printGraph);
-
-    // Print graph contents before and after fixups:
+    // associated blocks at the 'PostPrune' phase of JITLink (after
+    // dead-stripping, but before addresses are allocated in the target
+    // address space. See llvm/docs/JITLink.rst).
     //
-    // Config.PostPrunePasses.push_back([this](jitlink::LinkGraph &G) -> Error {
-    //   printLinkGraphContent(G, "Before fixup:");
-    //   return Error::success();
-    // });
-    // Config.PostFixupPasses.push_back([this](jitlink::LinkGraph &G) -> Error {
-    //   printLinkGraphContent(G, "After fixup:");
-    //   return Error::success();
-    // });
+    // Experiment with adding the 'printGraph' pass at other points in the
+    // pipeline. E.g. PrePrunePasses, PostAllocationPasses, and
+    // PostFixupPasses.
+    Config.PostPrunePasses.push_back(printGraph);
   }
 
   void notifyLoaded(MaterializationResponsibility &MR) override {