Update comments.
authorChris Lattner <sabre@nondot.org>
Fri, 28 Jul 2006 22:09:37 +0000 (22:09 +0000)
committerChris Lattner <sabre@nondot.org>
Fri, 28 Jul 2006 22:09:37 +0000 (22:09 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29398 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/Bytecode/Writer.h

index 0517d8c84be59c0c0dca411e8841f99f098b68d5..8b89226fa5d3df88bf9a0bfce9182809ea4f1846 100644 (file)
@@ -7,17 +7,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This functionality is implemented by the lib/BytecodeWriter library.
-// This library is used to write VM bytecode files to an iostream.  First, you
-// have to make a BytecodeStream object, which you can then put a class into
-// by using operator <<.
-//
-// This library uses the Analysis library to figure out offsets for
-// variables in the method tables...
-//
-// Note that performance of this library is not as crucial as performance of the
-// bytecode reader (which is to be used in JIT type applications), so we have
-// designed the bytecode format to support quick reading.
+// This functionality is implemented by the lib/Bytecode/Writer library.
+// This library is used to write bytecode files to an iostream.
 //
 //===----------------------------------------------------------------------===//
 
@@ -30,8 +21,7 @@ namespace llvm {
   class Module;
   /// WriteBytecodeToFile - Write the specified module to the specified output
   /// stream.  If compress is set to true, try to use compression when writing
-  /// out the file.  This throws an std::string if there is an error writing
-  /// the file.
+  /// out the file.  This can never fail if M is a well-formed module.
   void WriteBytecodeToFile(const Module *M, std::ostream &Out,
                            bool compress = true);
 } // End llvm namespace