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

llvm-svn: 173374

1 files changed, 6 insertions, 0 deletions

diff --git a/llvm/lib/Transforms/Scalar/ObjCARC.cpp b/llvm/lib/Transforms/Scalar/ObjCARC.cpp
index 45bc7ab6311..1c7acb0bf0c 100644
--- a/llvm/lib/Transforms/Scalar/ObjCARC.cpp
+++ b/llvm/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;