[llvm-dwarfdump] Help option output should be consistent with the command guide

[gbreynoo]

Summary

The dwarfdump command guide shows the short options used as aliases but these are not found in the help text unless --show-hidden is used. Investigating other tools some follow this pattern, others like llvm-objdump show aliases with --help. This change fixes the help output to be consistent with the command guide.

As part of this change I updated cmdline.test, including some options that were missing testing.

[MaskRay]

Looks great!

llvm/test/tools/llvm-dwarfdump/cmdline.test

11–29

A bit weird that the aliasee spelling is -all while the option below is --all.

Suggest you change Alias for - strings while you are updating them.

[jhenderson]

llvm/tools/llvm-dwarfdump/llvm-dwarfdump.cpp

133–134

Nit: make sure to run clang-format.

[gbreynoo]

Updated alias descriptions to use "--" and ran changes through clang format.

[Higuoxing]

LGTM

llvm/test/tools/llvm-dwarfdump/cmdline.test

 RUN: llvm-dwarfdump -h 2>&1 | FileCheck --check-prefix=HELP %s --implicit-check-not=out-file
 RUN: llvm-dwarfdump --help 2>&1 | FileCheck --check-prefix=HELP %s --implicit-check-not=out-file
 HELP: USAGE: llvm-dwarfdump{{[^ ]*}} [options] <input object files or .dSYM bundles>
 HELP: Color Options
 HELP: --color
 HELP: Generic Options
 HELP: --help
 HELP: --help-list
 HELP: --version
 HELP: Section-specific Dump Options
-HELP: --debug-info[=<offset>]    - Dump the .debug_info section
+HELP: -a                         - Alias for --all
+HELP: --all                      - Dump all debug info sections
+HELP: --apple-names              - Dump the .apple_names section
+HELP: --apple-namespaces         - Dump the .apple_namespaces section
+HELP: --apple-objc               - Dump the .apple_objc section
+HELP: --apple-types              - Dump the .apple_types section
+HELP: --debug-abbrev             - Dump the .debug_abbrev section
+HELP: --debug-addr               - Dump the .debug_addr section
+HELP: --debug-aranges            - Dump the .debug_aranges section
+HELP: --debug-cu-index           - Dump the .debug_cu_index section
+HELP: --debug-frame[=<offset>]     - Dump the .debug_frame section
+HELP: --debug-gnu-pubnames       - Dump the .debug_gnu_pubnames section
+HELP: --debug-gnu-pubtypes       - Dump the .debug_gnu_pubtypes section
+HELP: --debug-info[=<offset>]      - Dump the .debug_info section
+HELP: --debug-line[=<offset>]      - Dump the .debug_line section
+HELP: --debug-line-str           - Dump the .debug_line_str section
+HELP: --debug-loc[=<offset>]       - Dump the .debug_loc section
+HELP: --debug-loclists[=<offset>]  - Dump the .debug_loclists section
+HELP: --debug-macro              - Dump the .debug_macro section
 HELP: --debug-names              - Dump the .debug_names section
-HELP: --eh-frame                 - Alias for -debug-frame
+HELP: --debug-pubnames           - Dump the .debug_pubnames section
+HELP: --debug-pubtypes           - Dump the .debug_pubtypes section
+HELP: --debug-ranges             - Dump the .debug_ranges section
+HELP: --debug-rnglists           - Dump the .debug_rnglists section
+HELP: --debug-str                - Dump the .debug_str section
+HELP: --debug-str-offsets        - Dump the .debug_str_offsets section
+HELP: --debug-tu-index           - Dump the .debug_tu_index section
+HELP: --debug-types[=<offset>]     - Dump the .debug_types section
+HELP: --eh-frame                 - Alias for --debug-frame
+HELP: --gdb-index                - Dump the .gdb_index section
 HELP: Specific Options
+HELP: -F
+HELP: --arch=<string>
+HELP: -c
 HELP: --diff
-HELP: --find
+HELP: -f
+HELP: --find=<name>
+HELP: -i
 HELP: --ignore-case
-HELP: --lookup
-HELP: --name
+HELP: --lookup=<address>
+HELP: -n
+HELP: --name=<pattern>
 HELP: -o=<filename>
+HELP: -p
 HELP: --parent-recurse-depth=<N>
+HELP: --quiet
+HELP: -r
 HELP: --recurse-depth=<N>
 HELP: --regex
 HELP: --show-children
 HELP: --show-form
 HELP: --show-parents
+HELP: --show-section-sizes
 HELP: --statistics
 HELP: --summarize-types
+HELP: -u
+HELP: --uuid
+HELP: -v
+HELP: --verbose
+HELP: --verify
+HELP: -x
 HELP: @FILE
 
 RUN: llvm-dwarfdump --version 2>&1 | FileCheck --check-prefix=VERSION %s
 VERSION: {{ version }}
 
 RUN: not llvm-dwarfdump -diff -verbose 2>&1 | FileCheck --check-prefix=INCOMPATIBLE %s
 INCOMPATIBLE: error: incompatible arguments: specifying both -diff and -verbose is currently not supported
 
 RUN: not llvm-dwarfdump --debug-names=0x0 2>&1 | FileCheck --check-prefix=FLAG %s
 FLAG: for the --debug-names option: this is a flag and does not take a value

llvm/tools/llvm-dwarfdump/llvm-dwarfdump.cpp

 cl::OptionCategory SectionCategory("Section-specific Dump Options",
                                    "These control which sections are dumped. "
                                    "Where applicable these parameters take an "
                                    "optional =<offset> argument to dump only "
                                    "the entry at the specified offset.");
 
 static opt<bool> DumpAll("all", desc("Dump all debug info sections"),
                          cat(SectionCategory));
-static alias DumpAllAlias("a", desc("Alias for -all"), aliasopt(DumpAll));
+static alias DumpAllAlias("a", desc("Alias for --all"), aliasopt(DumpAll),
+                          cl::NotHidden);
 
 // Options for dumping specific sections.
 static unsigned DumpType = DIDT_Null;
 static std::array<llvm::Optional<uint64_t>, (unsigned)DIDT_ID_Count>
     DumpOffsets;
 #define HANDLE_DWARF_SECTION(ENUM_NAME, ELF_NAME, CMDLINE_NAME, OPTION)        \
   static opt<OPTION> Dump##ENUM_NAME(CMDLINE_NAME,                             \
                                      desc("Dump the " ELF_NAME " section"),    \
                                      cat(SectionCategory));
 #include "llvm/BinaryFormat/Dwarf.def"
 #undef HANDLE_DWARF_SECTION
 
-static alias DumpDebugFrameAlias("eh-frame", desc("Alias for -debug-frame"),
+static alias DumpDebugFrameAlias("eh-frame", desc("Alias for --debug-frame"),
                                  NotHidden, cat(SectionCategory),
                                  aliasopt(DumpDebugFrame));
 static list<std::string>
     ArchFilters("arch",
                 desc("Dump debug information for the specified CPU "
                      "architecture only. Architectures may be specified by "
                      "name or by number. This option can be specified "
                      "multiple times, once for each desired architecture."),
                 cat(DwarfDumpCategory));
 static opt<bool>
     Diff("diff",
          desc("Emit diff-friendly output by omitting offsets and addresses."),
          cat(DwarfDumpCategory));
 static list<std::string>
     Find("find",
          desc("Search for the exact match for <name> in the accelerator tables "
               "and print the matching debug information entries. When no "
               "accelerator tables are available, the slower but more complete "
               "-name option can be used instead."),
          value_desc("name"), cat(DwarfDumpCategory));
-static alias FindAlias("f", desc("Alias for -find."), aliasopt(Find));
+static alias FindAlias("f", desc("Alias for --find."), aliasopt(Find),
+                       cl::NotHidden);
 static opt<bool> IgnoreCase("ignore-case",
                             desc("Ignore case distinctions when searching."),
                             value_desc("i"), cat(DwarfDumpCategory));
-static alias IgnoreCaseAlias("i", desc("Alias for -ignore-case."),
-                             aliasopt(IgnoreCase));
+static alias IgnoreCaseAlias("i", desc("Alias for --ignore-case."),
+                             aliasopt(IgnoreCase), cl::NotHidden);
 static list<std::string> Name(
     "name",
     desc("Find and print all debug info entries whose name (DW_AT_name "
          "attribute) matches the exact text in <pattern>.  When used with the "
          "the -regex option <pattern> is interpreted as a regular expression."),
     value_desc("pattern"), cat(DwarfDumpCategory));
-static alias NameAlias("n", desc("Alias for -name"), aliasopt(Name));
+static alias NameAlias("n", desc("Alias for --name"), aliasopt(Name),
+                       cl::NotHidden);
 static opt<uint64_t>
     Lookup("lookup",
            desc("Lookup <address> in the debug information and print out any "
                 "available file, function, block and line table details."),
            value_desc("address"), cat(DwarfDumpCategory));
 static opt<std::string>
     OutputFilename("o", cl::init("-"),
                    cl::desc("Redirect output to the specified file."),
                    cl::value_desc("filename"), cat(DwarfDumpCategory));
 static alias OutputFilenameAlias("out-file", desc("Alias for -o."),
                                  aliasopt(OutputFilename));
 static opt<bool>
     UseRegex("regex",
              desc("Treat any <pattern> strings as regular expressions when "
                   "searching instead of just as an exact string match."),
              cat(DwarfDumpCategory));
-static alias RegexAlias("x", desc("Alias for -regex"), aliasopt(UseRegex));
+static alias RegexAlias("x", desc("Alias for --regex"), aliasopt(UseRegex),
+                        cl::NotHidden);
 static opt<bool>
     ShowChildren("show-children",
                  desc("Show a debug info entry's children when selectively "
                       "printing entries."),
                  cat(DwarfDumpCategory));
-static alias ShowChildrenAlias("c", desc("Alias for -show-children."),
-                               aliasopt(ShowChildren));
+static alias ShowChildrenAlias("c", desc("Alias for --show-children."),
+                               aliasopt(ShowChildren), cl::NotHidden);
 static opt<bool>
     ShowParents("show-parents",
                 desc("Show a debug info entry's parents when selectively "
                      "printing entries."),
                 cat(DwarfDumpCategory));
-static alias ShowParentsAlias("p", desc("Alias for -show-parents."),
-                              aliasopt(ShowParents));
+static alias ShowParentsAlias("p", desc("Alias for --show-parents."),
+                              aliasopt(ShowParents), cl::NotHidden);
 static opt<bool>
     ShowForm("show-form",
              desc("Show DWARF form types after the DWARF attribute types."),
              cat(DwarfDumpCategory));
-static alias ShowFormAlias("F", desc("Alias for -show-form."),
-                           aliasopt(ShowForm), cat(DwarfDumpCategory));
+static alias ShowFormAlias("F", desc("Alias for --show-form."),
+                           aliasopt(ShowForm), cat(DwarfDumpCategory),
+                           cl::NotHidden);
 static opt<unsigned>
     ChildRecurseDepth("recurse-depth",
                       desc("Only recurse to a depth of N when displaying "
                            "children of debug info entries."),
                       cat(DwarfDumpCategory), init(-1U), value_desc("N"));
-static alias ChildRecurseDepthAlias("r", desc("Alias for -recurse-depth."),
-                                    aliasopt(ChildRecurseDepth));
+static alias ChildRecurseDepthAlias("r", desc("Alias for --recurse-depth."),
+                                    aliasopt(ChildRecurseDepth), cl::NotHidden);
 static opt<unsigned>
     ParentRecurseDepth("parent-recurse-depth",
                        desc("Only recurse to a depth of N when displaying "
                             "parents of debug info entries."),
                        cat(DwarfDumpCategory), init(-1U), value_desc("N"));
 static opt<bool>
     SummarizeTypes("summarize-types",
                    desc("Abbreviate the description of type unit entries."),
                    cat(DwarfDumpCategory));
 static cl::opt<bool>
     Statistics("statistics",
                cl::desc("Emit JSON-formatted debug info quality metrics."),
                cat(DwarfDumpCategory));
 static cl::opt<bool>
     ShowSectionSizes("show-section-sizes",
                      cl::desc("Show the sizes of all debug sections, "
                               "expressed in bytes."),
                      cat(DwarfDumpCategory));
 static opt<bool> Verify("verify", desc("Verify the DWARF debug info."),
                         cat(DwarfDumpCategory));
 static opt<bool> Quiet("quiet", desc("Use with -verify to not emit to STDOUT."),
                        cat(DwarfDumpCategory));
 static opt<bool> DumpUUID("uuid", desc("Show the UUID for each architecture."),
                           cat(DwarfDumpCategory));
-static alias DumpUUIDAlias("u", desc("Alias for -uuid."), aliasopt(DumpUUID));
+static alias DumpUUIDAlias("u", desc("Alias for --uuid."), aliasopt(DumpUUID),
+                           cl::NotHidden);
 static opt<bool> Verbose("verbose",
                          desc("Print more low-level encoding details."),
                          cat(DwarfDumpCategory));
-static alias VerboseAlias("v", desc("Alias for -verbose."), aliasopt(Verbose),
-                          cat(DwarfDumpCategory));
+static alias VerboseAlias("v", desc("Alias for --verbose."), aliasopt(Verbose),
+                          cat(DwarfDumpCategory), cl::NotHidden);
 static cl::extrahelp
     HelpResponse("\nPass @FILE as argument to read options from FILE.\n");
 } // namespace
 /// @}
 //===----------------------------------------------------------------------===//
 
 static void error(StringRef Prefix, std::error_code EC) {
   if (!EC)