aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOwen Anderson <resistor@mac.com>2009-06-30 17:06:46 +0000
committerOwen Anderson <resistor@mac.com>2009-06-30 17:06:46 +0000
commit5217007006e91fa4bbfe88fde5149f5db293b247 (patch)
tree4bbb507a969aed3848da40740ade827c21bbc158
parentaf5f6ba32d5f03aa1e0c1aeecd81c99fea842d4c (diff)
downloadexternal_llvm-5217007006e91fa4bbfe88fde5149f5db293b247.tar.gz
external_llvm-5217007006e91fa4bbfe88fde5149f5db293b247.tar.bz2
external_llvm-5217007006e91fa4bbfe88fde5149f5db293b247.zip
Fix up header comments to make Chris happy.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74537 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--include/llvm/LLVMContext.h10
-rw-r--r--lib/VMCore/LLVMContext.cpp5
-rw-r--r--lib/VMCore/LLVMContextImpl.h7
3 files changed, 21 insertions, 1 deletions
diff --git a/include/llvm/LLVMContext.h b/include/llvm/LLVMContext.h
index 018d777c01..398fae26dd 100644
--- a/include/llvm/LLVMContext.h
+++ b/include/llvm/LLVMContext.h
@@ -6,6 +6,11 @@
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
+//
+// This file declares LLVMContext, a container of "global" state in LLVM, such
+// as the global type and constant uniquing tables.
+//
+//===----------------------------------------------------------------------===//
#ifndef LLVM_LLVMCONTEXT_H
#define LLVM_LLVMCONTEXT_H
@@ -35,6 +40,11 @@ class APInt;
class APFloat;
class Value;
+/// This is an important class for using LLVM in a threaded context. It
+/// (opaquely) owns and manages the core "global" data of LLVM's core
+/// infrastructure, including the type and constant uniquing tables.
+/// LLVMContext itself provides no locking guarantees, so you should be careful
+/// to have one context per thread.
class LLVMContext {
LLVMContextImpl* pImpl;
public:
diff --git a/lib/VMCore/LLVMContext.cpp b/lib/VMCore/LLVMContext.cpp
index f93616ba6b..c2aa4324c4 100644
--- a/lib/VMCore/LLVMContext.cpp
+++ b/lib/VMCore/LLVMContext.cpp
@@ -6,6 +6,11 @@
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
+//
+// This file implements LLVMContext, as a wrapper around the opaque
+// class LLVMContextImpl.
+//
+//===----------------------------------------------------------------------===//
#include "llvm/LLVMContext.h"
#include "llvm/Constants.h"
diff --git a/lib/VMCore/LLVMContextImpl.h b/lib/VMCore/LLVMContextImpl.h
index 8d0a70c690..4e089fb661 100644
--- a/lib/VMCore/LLVMContextImpl.h
+++ b/lib/VMCore/LLVMContextImpl.h
@@ -6,6 +6,11 @@
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
+//
+// This file declares LLVMContextImpl, the opaque implementation
+// of LLVMContext.
+//
+//===----------------------------------------------------------------------===//
#ifndef LLVM_LLVMCONTEXT_IMPL_H
#define LLVM_LLVMCONTEXT_IMPL_H
@@ -17,4 +22,4 @@ class LLVMContextImpl {
}
-#endif \ No newline at end of file
+#endif