[PATCH] D63275: [docs][llvm-dwarfdump] Make the --show-parents and --show-children help text and docs more consistent and correct

[James Henderson via Phabricator via llvm-commits]

jhenderson created this revision.
jhenderson added reviewers: JDevlieghere, probinson, aprantl, dblaikie.
Herald added a project: LLVM.

The docs and help text for --show-parents and --show-children were a bit inconsistent. The help text claimed they had an effect when "=<offset>" was used, whereas the doc said it had an effect when "--find" or "--name" were used. This change changes the doc to mention "=<offset>" and removes this reference from the help text, to avoid having a very long description in the help text (it still says "when selectively printing entries").


Repository:
  rL LLVM

https://reviews.llvm.org/D63275

Files:
  docs/CommandGuide/llvm-dwarfdump.rst
  tools/llvm-dwarfdump/llvm-dwarfdump.cpp


Index: tools/llvm-dwarfdump/llvm-dwarfdump.cpp
===================================================================
--- tools/llvm-dwarfdump/llvm-dwarfdump.cpp
+++ tools/llvm-dwarfdump/llvm-dwarfdump.cpp
@@ -173,14 +173,14 @@
 static opt<bool>
     ShowChildren("show-children",
                  desc("Show a debug info entry's children when selectively "
-                      "printing with the =<offset> option."),
+                      "printing entries."),
                  cat(DwarfDumpCategory));
 static alias ShowChildrenAlias("c", desc("Alias for -show-children."),
                                aliasopt(ShowChildren));
 static opt<bool>
     ShowParents("show-parents",
                 desc("Show a debug info entry's parents when selectively "
-                     "printing with the =<offset> option."),
+                     "printing entries."),
                 cat(DwarfDumpCategory));
 static alias ShowParentsAlias("p", desc("Alias for -show-parents."),
                               aliasopt(ShowParents));
Index: docs/CommandGuide/llvm-dwarfdump.rst
===================================================================
--- docs/CommandGuide/llvm-dwarfdump.rst
+++ docs/CommandGuide/llvm-dwarfdump.rst
@@ -35,9 +35,9 @@
 
 .. option:: -c, --show-children
 
-            Show a debug info entry's children when using
-            the :option:`--debug-info`, :option:`--find`,
-            and :option:`--name` options.
+            Show a debug info entry's children when selectively printing with
+            the `=<offset>` argument of :option:`--debug-info`, or options such
+            as :option:`--find` or :option:`--name`.
 
 .. option:: --color
 
@@ -88,9 +88,9 @@
 
 .. option:: -p, --show-parents
 
-            Show a debug info entry's parent objects when using the
-            :option:`--debug-info`, :option:`--find`, and
-            :option:`--name` options.
+            Show a debug info entry's parents when selectively printing with
+            the `=<offset>` argument of :option:`--debug-info`, or options such
+            as :option:`--find` or :option:`--name`.
 
 .. option:: --parent-recurse-depth=<N>
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D63275.204543.patch
Type: text/x-patch
Size: 2163 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190613/9fdf3bc8/attachment.bin>