Skip to content

[llvm-exegesis][Docs] --dump-object-to-disk option is specified by filename rather than bool #141178

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

Merged
merged 1 commit into from
May 24, 2025

Conversation

tclin914
Copy link
Contributor

No description provided.

@llvmbot
Copy link
Member

llvmbot commented May 23, 2025

@llvm/pr-subscribers-llvm-binary-utilities

Author: Jim Lin (tclin914)

Changes

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

1 Files Affected:

  • (modified) llvm/docs/CommandGuide/llvm-exegesis.rst (+1-1)
diff --git a/llvm/docs/CommandGuide/llvm-exegesis.rst b/llvm/docs/CommandGuide/llvm-exegesis.rst
index 821d5f7e8305f..25e89694b017e 100644
--- a/llvm/docs/CommandGuide/llvm-exegesis.rst
+++ b/llvm/docs/CommandGuide/llvm-exegesis.rst
@@ -438,7 +438,7 @@ OPTIONS
   were measured for, but if you want to analyze them for some other combination
   (specified via `-mtriple`/`-mcpu`), you can pass this flag.
 
-.. option:: --dump-object-to-disk=true
+.. option:: --dump-object-to-disk=<filename>
 
  If set,  llvm-exegesis will dump the generated code to a temporary file to
  enable code inspection. Disabled by default.

Copy link
Member

@mshockwave mshockwave left a comment

Choose a reason for hiding this comment

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

LGTM, good catch!

Copy link
Contributor

@boomanaiden154 boomanaiden154 left a comment

Choose a reason for hiding this comment

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

Yeah, looks like this was changed in 8e0ee5a but never got reflected in the docs. Thanks for updating this.

@tclin914 tclin914 merged commit 7e09a00 into llvm:main May 24, 2025
12 checks passed
@tclin914 tclin914 deleted the llvm-exegesis-docs branch May 24, 2025 02:33
sivan-shani pushed a commit to sivan-shani/llvm-project that referenced this pull request Jun 3, 2025
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.

4 participants