From: Michael Gottesman <mgottesman@apple.com>
Date: Thu, 24 Jan 2013 21:35:00 +0000 (+0000)
Subject: Added comment to ObjCARC elaborating what is meant by the term 'Provenance' in 'Prove... 
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=7c24e61a2b9c372f0077b8887e7cca8dd49c933d;p=oota-llvm.git

Added comment to ObjCARC elaborating what is meant by the term 'Provenance' in 'Provenance Analysis'.

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

diff --git a/lib/Transforms/Scalar/ObjCARC.cpp b/lib/Transforms/Scalar/ObjCARC.cpp
index 45bc7ab6311..1c7acb0bf0c 100644
--- a/lib/Transforms/Scalar/ObjCARC.cpp
+++ b/lib/Transforms/Scalar/ObjCARC.cpp
@@ -1222,6 +1222,12 @@ namespace {
   /// \brief This is similar to BasicAliasAnalysis, and it uses many of the same
   /// techniques, except it uses special ObjC-specific reasoning about pointer
   /// relationships.
+  ///
+  /// In this context ``Provenance'' is defined as the history of an object's
+  /// ownership. Thus ``Provenance Analysis'' is defined by using the notion of
+  /// an ``independent provenance source'' of a pointer to determine whether or
+  /// not two pointers have the same provenance source and thus could
+  /// potentially be related.
   class ProvenanceAnalysis {
     AliasAnalysis *AA;