Update the descriptions of NoModRef and ModRef to be consistent
authorDan Gohman <gohman@apple.com>
Mon, 30 Aug 2010 23:47:24 +0000 (23:47 +0000)
committerDan Gohman <gohman@apple.com>
Mon, 30 Aug 2010 23:47:24 +0000 (23:47 +0000)
with the descriptions of Mod and Ref.

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

docs/AliasAnalysis.html
include/llvm/Analysis/AliasAnalysis.h

index c6330a946956edd771204f0dade2b71a268889c9..a1726aa0c7780dff8d08c8ef2f5c046b9bf8ffb8 100644 (file)
@@ -238,10 +238,10 @@ a location, ModRef is returned.</p>
 
 <p>The <tt>AliasAnalysis</tt> class also provides a <tt>getModRefInfo</tt>
 method for testing dependencies between function calls.  This method takes two
-call sites (CS1 &amp; CS2), returns NoModRef if the two calls refer to disjoint
-memory locations, Ref if CS1 reads memory written by CS2, Mod if CS1 writes to
-memory read or written by CS2, or ModRef if CS1 might read or write memory
-accessed by CS2.  Note that this relation is not commutative.</p>
+call sites (CS1 &amp; CS2), returns NoModRef if neither call writes to memory
+read or written by the other, Ref if CS1 reads memory written by CS2, Mod if CS1
+writes to memory read or written by CS2, or ModRef if CS1 might read or write
+memory written to by CS2.  Note that this relation is not commutative.</p>
 
 </div>
 
index 7b003d8a6914dbb2394c0c4a06e76d4140b777d6..ad68d48e531badf399c53abaa9e04e34020d2c73 100644 (file)
@@ -231,11 +231,9 @@ public:
                                      const Value *P, unsigned Size);
 
   /// getModRefInfo - Return information about whether two call sites may refer
-  /// to the same set of memory locations.  This function returns NoModRef if
-  /// the two calls refer to disjoint memory locations, Ref if CS1 reads memory
-  /// written by CS2, Mod if CS1 writes to memory read or written by CS2, or
-  /// ModRef if CS1 might read or write memory accessed by CS2.
-  ///
+  /// to the same set of memory locations.  See 
+  ///   http://llvm.org/docs/AliasAnalysis.html#ModRefInfo
+  /// for details.
   virtual ModRefResult getModRefInfo(ImmutableCallSite CS1,
                                      ImmutableCallSite CS2);