From: Gordon Henriksen <gordonhenriksen@mac.com>
Date: Tue, 6 May 2008 19:17:01 +0000 (+0000)
Subject: Improve documentation.
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=919852b0e6feacf266e9278ba54cbf7dd22240a4;p=oota-llvm.git

Improve documentation.

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

diff --git a/include/llvm-c/BitWriter.h b/include/llvm-c/BitWriter.h
index bc5699f1a9a..008ff9f2c10 100644
--- a/include/llvm-c/BitWriter.h
+++ b/include/llvm-c/BitWriter.h
@@ -28,7 +28,8 @@ extern "C" {
 
 /*===-- Operations on modules ---------------------------------------------===*/
 
-/* Writes a module to an open file descriptor. Returns 0 on success. */ 
+/* Writes a module to an open file descriptor. Returns 0 on success.
+   Closes the Handle. Use dup first if this is not what you want. */ 
 int LLVMWriteBitcodeToFileHandle(LLVMModuleRef M, int Handle);
 
 /* Writes a module to the specified path. Returns 0 on success. */