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

llvm-bolt --help is missing info about -report-bad-layout option #114230

Open
tvondra opened this issue Oct 30, 2024 · 2 comments
Open

llvm-bolt --help is missing info about -report-bad-layout option #114230

tvondra opened this issue Oct 30, 2024 · 2 comments
Labels

Comments

@tvondra
Copy link

tvondra commented Oct 30, 2024

It seems llvm-bolt --help says nothing about -report-bad-layout. I only noticed because the BOLT paper mentions the option without the required uint argument, so the command was failing for me. In the end I found bolt/docs/CommandLineArgumentReference.md but --help doesn't mention the option at all.

@github-actions github-actions bot added the BOLT label Oct 30, 2024
@marcauberer
Copy link
Member

The respective command line option is explicitly marked as hidden. See here:

cl::init(0), cl::Hidden, cl::cat(BoltOptCategory));

@maksfb is this intended?

@maksfb
Copy link
Contributor

maksfb commented Oct 30, 2024

@maksfb is this intended?

Yes. We don't have a strong definition of the "bad" layout and this option was indeed added for the paper to easily diagnose places where the compiler can generate suboptimal layout even in the presence of a high-quality profile. It was never intended for the end user. But now you seem to find a use for it, although I'm not convinced that's really what you
(or any user) need in the end.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants