[IPO] Add documentation for new function argument
authorShoaib Meenai <smeenai@fb.com>
Wed, 29 Mar 2023 10:26:47 +0000 (03:26 -0700)
committerShoaib Meenai <smeenai@fb.com>
Wed, 29 Mar 2023 15:36:49 +0000 (08:36 -0700)
As pointed out by @fhahn in https://reviews.llvm.org/D146876.

Reviewed By: tejohnson

Differential Revision: https://reviews.llvm.org/D147133

llvm/include/llvm/Transforms/IPO/FunctionImport.h

index 92d171b..3e4b3eb 100644 (file)
@@ -136,6 +136,10 @@ public:
 /// \p ModuleToDefinedGVSummaries contains for each Module a map
 /// (GUID -> Summary) for every global defined in the module.
 ///
+/// \p isPrevailing is a callback that will be called with a global value's GUID
+/// and summary and should return whether the module corresponding to the
+/// summary contains the linker-prevailing copy of that value.
+///
 /// \p ImportLists will be populated with an entry for every Module we are
 /// importing into. This entry is itself a map that can be passed to
 /// FunctionImporter::importFunctions() above (see description there).
@@ -153,6 +157,10 @@ void ComputeCrossModuleImport(
 
 /// Compute all the imports for the given module using the Index.
 ///
+/// \p isPrevailing is a callback that will be called with a global value's GUID
+/// and summary and should return whether the module corresponding to the
+/// summary contains the linker-prevailing copy of that value.
+///
 /// \p ImportList will be populated with a map that can be passed to
 /// FunctionImporter::importFunctions() above (see description there).
 void ComputeCrossModuleImportForModule(