Skip to content

[llvm][NFC] Document cl::opt MisExpectTolerance and fix typo #90670

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

Conversation

ilovepi
Copy link
Contributor

@ilovepi ilovepi commented Apr 30, 2024

No description provided.

Created using spr 1.3.4
@llvmbot
Copy link
Member

llvmbot commented Apr 30, 2024

@llvm/pr-subscribers-llvm-transforms

Author: Paul Kirth (ilovepi)

Changes

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

1 Files Affected:

  • (modified) llvm/lib/Transforms/Utils/MisExpect.cpp (+2-1)
diff --git a/llvm/lib/Transforms/Utils/MisExpect.cpp b/llvm/lib/Transforms/Utils/MisExpect.cpp
index 9cb7c54e0c8c97..59e13795f0f247 100644
--- a/llvm/lib/Transforms/Utils/MisExpect.cpp
+++ b/llvm/lib/Transforms/Utils/MisExpect.cpp
@@ -59,9 +59,10 @@ static cl::opt<bool> PGOWarnMisExpect(
     cl::desc("Use this option to turn on/off "
              "warnings about incorrect usage of llvm.expect intrinsics."));
 
+// Command line option for setting the diagnostic tolerance threshold
 static cl::opt<uint32_t> MisExpectTolerance(
     "misexpect-tolerance", cl::init(0),
-    cl::desc("Prevents emiting diagnostics when profile counts are "
+    cl::desc("Prevents emitting diagnostics when profile counts are "
              "within N% of the threshold.."));
 
 } // namespace llvm

Copy link
Contributor

@fhahn fhahn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

For the title, it might be clearer to explicitly mention the variable this is documenting, commit title size permitting

@ilovepi
Copy link
Contributor Author

ilovepi commented May 2, 2024

LGTM, thanks!

For the title, it might be clearer to explicitly mention the variable this is documenting, commit title size permitting

Ah, good suggestion. I'll take care of that tomorrow, when I'm in front of my computer again.

Created using spr 1.3.4
@ilovepi ilovepi changed the title [llvm][NFC] Document cl::opt variable and fix typo [llvm][NFC] Document cl::opt MisExpectTolerance and fix typo May 2, 2024
Created using spr 1.3.4
@ilovepi ilovepi merged commit d31e2cd into users/ilovepi/spr/main.llvmnfc-document-clopt-variable-and-fix-typo-3 May 13, 2024
4 of 5 checks passed
@ilovepi ilovepi deleted the users/ilovepi/spr/llvmnfc-document-clopt-variable-and-fix-typo-2 branch May 13, 2024 16:16
@ilovepi ilovepi restored the users/ilovepi/spr/llvmnfc-document-clopt-variable-and-fix-typo-2 branch May 13, 2024 16:17
@ilovepi ilovepi deleted the users/ilovepi/spr/llvmnfc-document-clopt-variable-and-fix-typo-2 branch May 13, 2024 16:17
ilovepi added a commit that referenced this pull request May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants