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

[James Henderson via Phabricator via llvm-commits]

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

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.


Repository:
  rL LLVM

https://reviews.llvm.org/D64332

Files:
  docs/CommandGuide/llvm-dwarfdump.rst


Index: docs/CommandGuide/llvm-dwarfdump.rst
===================================================================
--- docs/CommandGuide/llvm-dwarfdump.rst
+++ docs/CommandGuide/llvm-dwarfdump.rst
@@ -68,15 +68,12 @@
 
 .. 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 @@
 
 .. 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 @@
 
 .. 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 them to a maximum
+            depth of <N>.
 
 .. option:: --statistics
 
@@ -119,8 +116,9 @@
 
 .. 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
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D64332.208396.patch
Type: text/x-patch
Size: 1869 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190708/9b83945b/attachment.bin>