[llvm-dwarfdump][docs] Add missing options to the help output and the command guide

[gbreynoo]

Summary

This change is to add some missing details to the help text and command guide:

• Added a note to the command guide that ----debug-macro also dumps .debug_macinfo.
• Added a note to the command guide that --debug-frame and --eh_frame - are aliases, and in cases where both sections are present one command outputs both.
• Changed the wording in the help output for --ignore-case and --regex to closer match the command guide.

[dblaikie]

Sounds good to me!

llvm/docs/CommandGuide/llvm-dwarfdump.rst

162

Maybe put these on separate lines to make sure the debug-frame one doesn't get lost behind the debug-macro one?

[gbreynoo]

llvm/docs/CommandGuide/llvm-dwarfdump.rst

162

Thanks dblaikie, done.

[gbreynoo]

This comment was removed by gbreynoo.

[gbreynoo]

This was committed in 05b1c7aebfff8cc08a620d01e739f343ed01db6d but I forgot to add the Differential Revision URL. As stated in the Code Reviews with Phabricator User Guide I will close this revision. Apologies for the noise.

llvm/docs/CommandGuide/llvm-dwarfdump.rst

.. option:: --verify
             Verify the structure of the DWARF information by verifying the
             compile unit chains, DIE relationships graph, address
             ranges, and more.
 
 .. option:: --version
 
             Display the version of the tool.
 
-.. option:: --debug-abbrev, --debug-addr, --debug-aranges, --debug-cu-index, --debug-frame[=<offset>], --debug-gnu-pubnames, --debug-gnu-pubtypes, --debug-info [=<offset>], --debug-line [=<offset>], --debug-line-str, --debug-loc [=<offset>], --debug-loclists [=<offset>], --debug-macro, --debug-names, --debug-pubnames, --debug-pubtypes, --debug-ranges, --debug-rnglists, --debug-str, --debug-str-offsets, --debug-tu-index, --debug-types [=<offset>], --eh-frame [=<offset>], --gdb-index, --apple-names, --apple-types, --apple-namespaces, --apple-objc
+.. option:: --debug-abbrev, --debug-addr, --debug-aranges, --debug-cu-index, --debug-frame [=<offset>], --debug-gnu-pubnames, --debug-gnu-pubtypes, --debug-info [=<offset>], --debug-line [=<offset>], --debug-line-str, --debug-loc [=<offset>], --debug-loclists [=<offset>], --debug-macro, --debug-names, --debug-pubnames, --debug-pubtypes, --debug-ranges, --debug-rnglists, --debug-str, --debug-str-offsets, --debug-tu-index, --debug-types [=<offset>], --eh-frame [=<offset>], --gdb-index, --apple-names, --apple-types, --apple-namespaces, --apple-objc
 
             Dump the specified DWARF section by name. Only the
             `.debug_info` section is shown by default. Some entries
             support adding an `=<offset>` as a way to provide an
             optional offset of the exact entry to dump within the
             respective section. When an offset is provided, only the
             entry at that offset will be dumped, else the entire
             section will be dumped.
             
+            The :option:`--debug-macro` option prints both the .debug_macro and the .debug_macinfo sections. The :option:`--debug-frame` and :option:`--eh-frame` options are aliases, in cases where both sections are present one command outputs both.
+
 .. option:: @<FILE>
 
             Read command-line options from `<FILE>`.
 
 .. _stats-format:
 
 FORMAT OF STATISTICS OUTPUT
 ---------------------------
 
-The ::option:`--statistics` option generates single-line JSON output
+The :option:`--statistics` option generates single-line JSON output
 representing quality metrics of the processed debug info. These metrics are
 useful to compare changes between two compilers, particularly for judging
 the effect that a change to the compiler has on the debug info quality.
 
 The output is formatted as key-value pairs. The first pair contains a version
 number. The following naming scheme is used for the keys:
 
       - `variables` ==> local variables and parameters

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

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),
                        cl::NotHidden);
 static opt<bool> IgnoreCase("ignore-case",
-                            desc("Ignore case distinctions when searching."),
+                            desc("Ignore case distinctions when using --name."),
                             value_desc("i"), cat(DwarfDumpCategory));
 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),
                        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 opt<bool> UseRegex(
+    "regex",
+    desc("Treat any <pattern> strings as regular "
+         "expressions when searching with --name. If --ignore-case is also "
+         "specified, the regular expression becomes case-insensitive."),
 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."),