Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2024-11-26 23:21:11 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[CommandLine] Do not print empty categories with '--help-hidden' (#77043)

Browse Source 
If a category has no options associated with it, the `--help-hidden`
command still shows that category with the annotation "This option
category has no options", and this is how it was implemented from the
beginning when the categories were introduced, see commit 0537a98878. A
feature to hide unrelated options was added later, in
https://reviews.llvm.org/D7100. Now, if a tool needs to hide unrelated
options that are associated with categories, leaving some of them empty,
those categories will still be visible on the `--help-hidden` output,
even if they have no use for the tool; see the changes in
`llvm/test/tools/llvm-debuginfo-analyzer/cmdline.test` for an example.

The patch ensures that only categories with options are shown on both
main and hidden help output.
This commit is contained in:
Igor Kudrin 2024-01-09 05:03:16 +07:00 committed by GitHub
parent f84bfa2f92
commit b2ea9ec7fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
llvm/docs/CommandLine.rst
View File

@ -1521,8 +1521,7 @@ passed to the constructor as ``const char*``.
Note that declaring an option category and associating it with an option before
parsing options (e.g. statically) will change the output of ``-help`` from
uncategorized to categorized. If an option category is declared but not
associated with an option then it will be hidden from the output of ``-help``
but will be shown in the output of ``-help-hidden``.
associated with an option then it will be hidden from the output of ``-help``.
.. _different parser:
.. _discussed previously:

9
llvm/lib/Support/CommandLine.cpp
View File

@ -2474,8 +2474,7 @@ protected:
for (OptionCategory *Category : SortedCategories) {
// Hide empty categories for --help, but show for --help-hidden.
const auto &CategoryOptions = CategorizedOptions[Category];
bool IsEmptyCategory = CategoryOptions.empty();
if (!ShowHidden && IsEmptyCategory)
if (CategoryOptions.empty())
continue;
// Print category information.
@ -2488,12 +2487,6 @@ protected:
else
outs() << "\n";
// When using --help-hidden explicitly state if the category has no
// options associated with it.
if (IsEmptyCategory) {
outs() << " This option category has no options.\n";
continue;
}
// Loop over the options in the category and print.
for (const Option *Opt : CategoryOptions)
Opt->printOptionInfo(MaxArgLen);

4
llvm/test/tools/llvm-debuginfo-analyzer/cmdline.test
View File

@ -70,8 +70,6 @@ HELP-ALL: =system - Display PDB's MS system elements.
HELP-ALL: =typename - Include Parameters in templates.
HELP-ALL: =underlying - Underlying type for type definitions.
HELP-ALL: =zero - Zero line numbers.
HELP-ALL: Color Options:
HELP-ALL: This option category has no options.
HELP-ALL: Compare Options:
HELP-ALL: These control the view comparison.
HELP-ALL: --compare=<value> - Elements to compare.
@ -81,8 +79,6 @@ HELP-ALL: =scopes - Scopes.
HELP-ALL: =symbols - Symbols.
HELP-ALL: =types - Types.
HELP-ALL: --compare-context - Add the view as compare context.
HELP-ALL: General options:
HELP-ALL: This option category has no options.
HELP-ALL: Generic Options:
HELP-ALL: -h - Alias for --help
HELP-ALL: --help - Display available options (--help-hidden for more)

25
llvm/unittests/Support/CommandLineTest.cpp
View File

@ -2301,4 +2301,29 @@ TEST(CommandLineTest, SubCommandGroups) {
EXPECT_FALSE(SC3.OptionsMap.contains("opt12"));
}
TEST(CommandLineTest, HelpWithEmptyCategory) {
cl::ResetCommandLineParser();
cl::OptionCategory Category1("First Category");
cl::OptionCategory Category2("Second Category");
StackOption<int> Opt1("opt1", cl::cat(Category1));
StackOption<int> Opt2("opt2", cl::cat(Category2));
cl::HideUnrelatedOptions(Category2);
const char *args[] = {"prog"};
EXPECT_TRUE(cl::ParseCommandLineOptions(std::size(args), args, StringRef(),
&llvm::nulls()));
auto Output = interceptStdout(
[]() { cl::PrintHelpMessage(/*Hidden=*/false, /*Categorized=*/true); });
EXPECT_EQ(std::string::npos, Output.find("First Category"))
<< "An empty category should not be printed";
Output = interceptStdout(
[]() { cl::PrintHelpMessage(/*Hidden=*/true, /*Categorized=*/true); });
EXPECT_EQ(std::string::npos, Output.find("First Category"))
<< "An empty category should not be printed";
cl::ResetCommandLineParser();
}
} // anonymous namespace