aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorChris Lattner <sabre@nondot.org>2006-07-28 22:09:37 +0000
committerChris Lattner <sabre@nondot.org>2006-07-28 22:09:37 +0000
commit86ca12988a737ca0564a9c879c8c07f70fb20103 (patch)
tree7ec2d769c4b02c64afc055ee76547a3d0ec8cc44 /include
parent4645cdca8af4d60623205a642b3e727e91f5570a (diff)
downloadexternal_llvm-86ca12988a737ca0564a9c879c8c07f70fb20103.zip
external_llvm-86ca12988a737ca0564a9c879c8c07f70fb20103.tar.gz
external_llvm-86ca12988a737ca0564a9c879c8c07f70fb20103.tar.bz2
Update comments.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29398 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include')
-rw-r--r--include/llvm/Bytecode/Writer.h16
1 files changed, 3 insertions, 13 deletions
diff --git a/include/llvm/Bytecode/Writer.h b/include/llvm/Bytecode/Writer.h
index 0517d8c..8b89226 100644
--- a/include/llvm/Bytecode/Writer.h
+++ b/include/llvm/Bytecode/Writer.h
@@ -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