From d261381db5831c511044651e2cd07e4e471e6b84 Mon Sep 17 00:00:00 2001 From: Dan Gohman <gohman@apple.com> Date: Mon, 30 Aug 2010 23:47:24 +0000 Subject: [PATCH] Update the descriptions of NoModRef and ModRef to be consistent with the descriptions of Mod and Ref. llvm-svn: 112557 --- docs/AliasAnalysis.html | 8 ++++---- include/llvm/Analysis/AliasAnalysis.h | 8 +++----- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/AliasAnalysis.html b/docs/AliasAnalysis.html index c6330a94695..a1726aa0c77 100644 --- a/docs/AliasAnalysis.html +++ b/docs/AliasAnalysis.html @@ -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 & 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 & 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> diff --git a/include/llvm/Analysis/AliasAnalysis.h b/include/llvm/Analysis/AliasAnalysis.h index 7b003d8a691..ad68d48e531 100644 --- a/include/llvm/Analysis/AliasAnalysis.h +++ b/include/llvm/Analysis/AliasAnalysis.h @@ -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);