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

[tvondra]

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.

[marcauberer]

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

llvm-project/bolt/lib/Passes/BinaryPasses.cpp

Line 178 in 56dcfbe

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

@maksfb is this intended?

[maksfb]

@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.