[RuntimeDyld] Add comment documenting the behavior change in r241383.
authorLang Hames <lhames@gmail.com>
Sun, 5 Jul 2015 18:49:17 +0000 (18:49 +0000)
committerLang Hames <lhames@gmail.com>
Sun, 5 Jul 2015 18:49:17 +0000 (18:49 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@241408 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/ExecutionEngine/RuntimeDyld.h

index 94c4038..a808d92 100644 (file)
@@ -153,6 +153,10 @@ public:
 
     /// This method returns the address of the specified function or variable.
     /// It is used to resolve symbols during module linking.
 
     /// This method returns the address of the specified function or variable.
     /// It is used to resolve symbols during module linking.
+    ///
+    /// If the returned symbol's address is equal to ~0ULL then RuntimeDyld will
+    /// skip all relocations for that symbol, and the client will be responsible
+    /// for handling them manually.
     virtual SymbolInfo findSymbol(const std::string &Name) = 0;
 
     /// This method returns the address of the specified symbol if it exists
     virtual SymbolInfo findSymbol(const std::string &Name) = 0;
 
     /// This method returns the address of the specified symbol if it exists