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

[James Henderson via llvm-commits]

Author: jhenderson
Date: Fri Jun 14 06:00:09 2019
New Revision: 363380

URL: http://llvm.org/viewvc/llvm-project?rev=363380&view=rev
Log:
[docs][llvm-dwarfdump] Make the --show-parents and --show-children help text and docs more consistent and correct

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").

Reviewed by: JDevlieghere, aprantl

Differential Revision: https://reviews.llvm.org/D63275

Modified:
    llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst
    llvm/trunk/tools/llvm-dwarfdump/llvm-dwarfdump.cpp

Modified: llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst?rev=363380&r1=363379&r2=363380&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst Fri Jun 14 06:00:09 2019
@@ -35,9 +35,9 @@ OPTIONS
 
 .. 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 @@ OPTIONS
 
 .. 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>
 

Modified: llvm/trunk/tools/llvm-dwarfdump/llvm-dwarfdump.cpp
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/tools/llvm-dwarfdump/llvm-dwarfdump.cpp?rev=363380&r1=363379&r2=363380&view=diff
==============================================================================
--- llvm/trunk/tools/llvm-dwarfdump/llvm-dwarfdump.cpp (original)
+++ llvm/trunk/tools/llvm-dwarfdump/llvm-dwarfdump.cpp Fri Jun 14 06:00:09 2019
@@ -173,14 +173,14 @@ static alias RegexAlias("x", desc("Alias
 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));