[llvm-commits] CVS: llvm/include/llvm/Linker.h

[Chris Lattner]

Changes in directory llvm/include/llvm:

Linker.h updated: 1.10 -> 1.11
---
Log message:

Document this as clobbering the second arg, make the second arg be non-const


---
Diffs of the changes:  (+7 -5)

Index: llvm/include/llvm/Linker.h
diff -u llvm/include/llvm/Linker.h:1.10 llvm/include/llvm/Linker.h:1.11
--- llvm/include/llvm/Linker.h:1.10	Sun Nov 14 15:46:08 2004
+++ llvm/include/llvm/Linker.h	Tue Nov 16 00:41:21 2004
@@ -22,15 +22,17 @@
 
 class Module;
 
-/// This is the heart of the linker. The \p Src module is linked into the 
-/// \p Dest module. If an error occurs, true is returned, otherwise false. If
-/// \p ErrorMsg is not null and an error occurs, \p *ErrorMsg will be set to a
-/// readable string that indicates the nature of the error.
+/// This is the heart of the linker. The \p Src module is linked into the \p
+/// Dest module. If an error occurs, true is returned, otherwise false. If \p
+/// ErrorMsg is not null and an error occurs, \p *ErrorMsg will be set to a
+/// readable string that indicates the nature of the error.  Note that this can
+/// destroy the Src module in arbitrary ways.
+///
 /// @returns true if there's an error
 /// @brief Link two modules together
 bool LinkModules(
   Module* Dest,          ///< Module into which \p Src is linked
-  const Module* Src,     ///< Module linked into \p Dest
+  Module* Src,     ///< Module linked into \p Dest
   std::string* ErrorMsg  ///< Optional error message string
 );