aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan Gohman <gohman@apple.com>2010-08-03 01:07:32 +0000
committerDan Gohman <gohman@apple.com>2010-08-03 01:07:32 +0000
commite53e3772f3c8b4cba69b7d77c8b2148a080fe9ae (patch)
treede1d25b55ab528f050db0d2e5e1a4a48572347dc
parentef1cfac9e50def9097cd3e3ab3c5cad7f4c758cc (diff)
downloadexternal_llvm-e53e3772f3c8b4cba69b7d77c8b2148a080fe9ae.zip
external_llvm-e53e3772f3c8b4cba69b7d77c8b2148a080fe9ae.tar.gz
external_llvm-e53e3772f3c8b4cba69b7d77c8b2148a080fe9ae.tar.bz2
Update some comments.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@110092 91177308-0d34-0410-b5e6-96231b3b80d8
-rw-r--r--include/llvm/Analysis/AliasAnalysis.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/include/llvm/Analysis/AliasAnalysis.h b/include/llvm/Analysis/AliasAnalysis.h
index ef3a38a..fbfdda5 100644
--- a/include/llvm/Analysis/AliasAnalysis.h
+++ b/include/llvm/Analysis/AliasAnalysis.h
@@ -18,12 +18,9 @@
//
// This API represents memory as a (Pointer, Size) pair. The Pointer component
// specifies the base memory address of the region, the Size specifies how large
-// of an area is being queried. If Size is 0, two pointers only alias if they
-// are exactly equal. If size is greater than zero, but small, the two pointers
-// alias if the areas pointed to overlap. If the size is very large (ie, ~0U),
-// then the two pointers alias if they may be pointing to components of the same
-// memory object. Pointers that point to two completely different objects in
-// memory never alias, regardless of the value of the Size component.
+// of an area is being queried, or UnknownSize if the size is not known.
+// Pointers that point to two completely different objects in memory never
+// alias, regardless of the value of the Size component.
//
//===----------------------------------------------------------------------===//
@@ -89,6 +86,9 @@ public:
/// if (AA.alias(P1, P2)) { ... }
/// to check to see if two pointers might alias.
///
+ /// See docs/AliasAnalysis.html for more information on the specific meanings
+ /// of these values.
+ ///
enum AliasResult { NoAlias = 0, MayAlias = 1, MustAlias = 2 };
/// alias - The main low level interface to the alias analysis implementation.