[llvm] r365451 - [docs][llvm-dwarfdump] Make some option descriptions clearer and more precise

[James Henderson via llvm-commits]

Author: jhenderson
Date: Tue Jul  9 03:03:12 2019
New Revision: 365451

URL: http://llvm.org/viewvc/llvm-project?rev=365451&view=rev
Log:
[docs][llvm-dwarfdump] Make some option descriptions clearer and more precise

Some of the wording in the doc (taken largely from the help text), was a
little imprecise in some cases, so this patch makes it a little more
precise.

Reviewed by: JDevlieghere, probinson

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

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

Modified: llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst?rev=365451&r1=365450&r2=365451&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst (original)
+++ llvm/trunk/docs/CommandGuide/llvm-dwarfdump.rst Tue Jul  9 03:03:12 2019
@@ -68,15 +68,12 @@ OPTIONS
 
 .. option:: -i, --ignore-case
 
-            Ignore case distinctions when searching.
+            Ignore case distinctions when using :option:`--name`.
 
-.. option:: -n <pattern>, --name=<pattern>
+.. option:: -n <name>, --name=<name>
 
             Find and print all debug info entries whose name
-            (`DW_AT_name` attribute) matches the exact text in
-            <pattern>. Use the :option:`--regex` option to have
-            <pattern> become a regular expression for more flexible
-            pattern matching.
+            (`DW_AT_name` attribute) is <name>.
 
 .. option:: --lookup=<address>
 
@@ -96,8 +93,8 @@ OPTIONS
 
 .. option:: --parent-recurse-depth=<N>
 
-            Only recurse to a maximum depth of <N> when displaying parents of
-            debug info entries.
+            When displaying debug info entry parents, only show them to a
+            maximum depth of <N>.
 
 .. option:: --quiet
 
@@ -105,8 +102,8 @@ OPTIONS
 
 .. option:: -r <N>, --recurse-depth=<N>
 
-            Only recurse to a maximum depth of <N> when dumping debug info
-            entries.
+            When displaying debug info entries, only show children to a maximum
+            depth of <N>.
 
 .. option:: --statistics
 
@@ -119,8 +116,9 @@ OPTIONS
 
 .. option:: -x, --regex
 
-            Treat any <pattern> strings as regular expressions when searching
-            instead of just as an exact string match.
+            Treat any <name> strings as regular expressions when searching
+            with :option:`--name`. If :option:`--ignore-case` is also specified,
+            the regular expression becomes case-insensitive.
 
 .. option:: -u, --uuid