Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NFC] Fix comments in PassBuilder functions #89513

Merged
merged 1 commit into from
Apr 22, 2024
Merged

Conversation

ellishg
Copy link
Contributor

@ellishg ellishg commented Apr 20, 2024

The original comments mention addPreLinkLTODefaultPipeline, but I could not find any functions with this name, even in https://reviews.llvm.org/D33540 (8b3be4e) where this comment was added. I assume they meant to refer to buildThinLTOPreLinkDefaultPipeline and buildLTOPreLinkDefaultPipeline and so this patch uses them.

The original comments mention `addPreLinkLTODefaultPipeline`, but I could not find any functions with this name, even in https://reviews.llvm.org/D33540 where this comment was added. I assume they meant to refer to `buildThinLTOPreLinkDefaultPipeline` and `buildLTOPreLinkDefaultPipeline` and so this patch uses them.
@arsenm arsenm requested review from alinas and aeubanks April 21, 2024 17:23
@arsenm arsenm added the LTO Link time optimization (regular/full LTO or ThinLTO) label Apr 21, 2024
@llvmbot
Copy link
Collaborator

llvmbot commented Apr 21, 2024

@llvm/pr-subscribers-lto

Author: Ellis Hoag (ellishg)

Changes

The original comments mention addPreLinkLTODefaultPipeline, but I could not find any functions with this name, even in https://reviews.llvm.org/D33540 (8b3be4e) where this comment was added. I assume they meant to refer to buildThinLTOPreLinkDefaultPipeline and buildLTOPreLinkDefaultPipeline and so this patch uses them.


Full diff: https://github.com/llvm/llvm-project/pull/89513.diff

1 Files Affected:

  • (modified) llvm/include/llvm/Passes/PassBuilder.h (+3-3)
diff --git a/llvm/include/llvm/Passes/PassBuilder.h b/llvm/include/llvm/Passes/PassBuilder.h
index c8f643452bb158..9b4da1c466f57d 100644
--- a/llvm/include/llvm/Passes/PassBuilder.h
+++ b/llvm/include/llvm/Passes/PassBuilder.h
@@ -264,12 +264,12 @@ class PassBuilder {
   /// the LTO run.
   ModulePassManager buildThinLTOPreLinkDefaultPipeline(OptimizationLevel Level);
 
-  /// Build an ThinLTO default optimization pipeline to a pass manager.
+  /// Build a ThinLTO default optimization pipeline to a pass manager.
   ///
   /// This provides a good default optimization pipeline for link-time
   /// optimization and code generation. It is particularly tuned to fit well
   /// when IR coming into the LTO phase was first run through \c
-  /// addPreLinkLTODefaultPipeline, and the two coordinate closely.
+  /// buildThinLTOPreLinkDefaultPipeline, and the two coordinate closely.
   ModulePassManager
   buildThinLTODefaultPipeline(OptimizationLevel Level,
                               const ModuleSummaryIndex *ImportSummary);
@@ -288,7 +288,7 @@ class PassBuilder {
   /// This provides a good default optimization pipeline for link-time
   /// optimization and code generation. It is particularly tuned to fit well
   /// when IR coming into the LTO phase was first run through \c
-  /// addPreLinkLTODefaultPipeline, and the two coordinate closely.
+  /// buildLTOPreLinkDefaultPipeline, and the two coordinate closely.
   ModulePassManager buildLTODefaultPipeline(OptimizationLevel Level,
                                             ModuleSummaryIndex *ExportSummary);
 

@ellishg ellishg merged commit 2e7bd22 into llvm:main Apr 22, 2024
6 checks passed
@ellishg ellishg deleted the pass-docs branch April 22, 2024 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
LTO Link time optimization (regular/full LTO or ThinLTO)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants