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

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@17879 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/include/llvm/Linker.h b/include/llvm/Linker.h
index a7a07812c389778591bc49e1e978e58d8570608e..4bb69ae419e061c9ab80a999b512e3857f17531e 100644 (file)
--- a/include/llvm/Linker.h
+++ b/include/llvm/Linker.h
@@ -22,15 +22,17 @@ namespace llvm {
 
 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
 );