[RFC] What options should be hidden/not-hidden for opt command

Hi, all

  Take the discussion thread [1] as an example. Although "-help-hidden"
is not intended to be use by normal folk, I think there should be
somewhere notes "-help-hidden" revealing more options which might be
needed by developers. I thought it will be a good idea to mention the
existence of "-help-hidden" on the web page, but the patch I sent brought
some discussion on llvm-commits [2][3]. Duncan suggested that there are
options should be not-hidden but hidden, and vice versa. And we should
regroup those options into hidden/not-hidden.

  Any idea? Thanks!

[1] http://lists.cs.uiuc.edu/pipermail/llvmdev/2011-October/044484.html
[2] http://comments.gmane.org/gmane.comp.compilers.llvm.cvs/101547
[3] http://lists.cs.uiuc.edu/pipermail/llvm-commits/Week-of-Mon-20111024/130575.html

Regards,
chenwj

Hi, all

Take the discussion thread [1] as an example. Although "-help-hidden"
is not intended to be use by normal folk, I think there should be
somewhere notes "-help-hidden" revealing more options which might be
needed by developers. I thought it will be a good idea to mention the
existence of "-help-hidden" on the web page, but the patch I sent brought
some discussion on llvm-commits [2][3]. Duncan suggested that there are
options should be not-hidden but hidden, and vice versa. And we should
regroup those options into hidden/not-hidden.

The logic here is that these flags should only be used by people looking at code. For example, if a pass has a hidden option that controls some knob, you should only find out about it by reading the code. We don't want people surfing through all the hidden options to "see what is available".

What specific knobs are you interested in? Maybe they shouldn't be hidden.

-Chris

The logic here is that these flags should only be used by people looking at code. For example, if a pass has a hidden option that controls some knob, you should only find out about it by reading the code. We don't want people surfing through all the hidden options to "see what is available".

  I see. Maybe we can tell people the existence of "-help-hidden" and
also remind them those options revealed by "-help-hidden" should be
carefully applied only if they have read the code.

Regards,
chenwj

Do any of the hidden options make tests fail?

Perhaps some bugs have been fixed in the time since certain options
were hidden. If they don't exhibit test failures anymore, perhaps
they should be unhidden.

Alternatively more tests should be written for the passing but hidden
features until a failing test case could be found. If someone did
write such a failing test, then the option should remain hidden.