[llvm] d33bac1 - [IPO] Add documentation for new function argument

[Shoaib Meenai via llvm-commits]

Author: Shoaib Meenai
Date: 2023-03-29T08:36:49-07:00
New Revision: d33bac18bb77b523f18530f6dce93039e04e5581

URL: https://github.com/llvm/llvm-project/commit/d33bac18bb77b523f18530f6dce93039e04e5581
DIFF: https://github.com/llvm/llvm-project/commit/d33bac18bb77b523f18530f6dce93039e04e5581.diff

LOG: [IPO] Add documentation for new function argument

As pointed out by @fhahn in https://reviews.llvm.org/D146876.

Reviewed By: tejohnson

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

Added: 
    

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

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/Transforms/IPO/FunctionImport.h b/llvm/include/llvm/Transforms/IPO/FunctionImport.h
index 92d171b20c60d..3e4b3eb30e77b 100644
--- a/llvm/include/llvm/Transforms/IPO/FunctionImport.h
+++ b/llvm/include/llvm/Transforms/IPO/FunctionImport.h
@@ -136,6 +136,10 @@ class FunctionImportPass : public PassInfoMixin<FunctionImportPass> {
 /// \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(