[PATCH] D64332: [docs][llvm-dwarfdump] Make some option descriptions clearer and more precise

[James Henderson via Phabricator via llvm-commits]

jhenderson marked 3 inline comments as done.
jhenderson added inline comments.


================
Comment at: docs/CommandGuide/llvm-dwarfdump.rst:71
 
-            Ignore case distinctions when searching.
+            Ignore case distinctions when using :option:`--name`.
 
----------------
probinson wrote:
> This also applies to regex, according to the help text for regex?
I don't think we need to duplicate the references. The interaction is described in the --regex description below, which itself also only applies to --option name, so anything we say here is redundant.


================
Comment at: docs/CommandGuide/llvm-dwarfdump.rst:105
 
-            Only recurse to a maximum depth of <N> when dumping debug info
-            entries.
+            When displaying debug info entries, only show them to a maximum
+            depth of <N>.
----------------
probinson wrote:
> Maybe "only show children to..." ?
> 
> Just for my curiosity, does this also limit the depth displayed when you dump an entire .debug_info/types section?
I think the "only show children" bit is important, since the initial root doesn't count as 1 (i.e. -r 0 prints the root tag, and no children, -r 1 prints the first-level children etc).

The switch does apply to .debug_info/types dumping, not just when displaying specific entries.


Repository:
  rL LLVM

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64332/new/

https://reviews.llvm.org/D64332