[llvm-commits] [llvm] r173374 - /llvm/trunk/lib/Transforms/Scalar/ObjCARC.cpp

[Michael Gottesman]

Author: mgottesman
Date: Thu Jan 24 15:35:00 2013
New Revision: 173374

URL: http://llvm.org/viewvc/llvm-project?rev=173374&view=rev
Log:
Added comment to ObjCARC elaborating what is meant by the term 'Provenance' in 'Provenance Analysis'.

Modified:
    llvm/trunk/lib/Transforms/Scalar/ObjCARC.cpp

Modified: llvm/trunk/lib/Transforms/Scalar/ObjCARC.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Transforms/Scalar/ObjCARC.cpp?rev=173374&r1=173373&r2=173374&view=diff
==============================================================================
--- llvm/trunk/lib/Transforms/Scalar/ObjCARC.cpp (original)
+++ llvm/trunk/lib/Transforms/Scalar/ObjCARC.cpp Thu Jan 24 15:35:00 2013
@@ -1222,6 +1222,12 @@
   /// \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;