diff options
| author | James Henderson <jh7370@my.bristol.ac.uk> | 2019-07-09 10:03:12 +0000 |
|---|---|---|
| committer | James Henderson <jh7370@my.bristol.ac.uk> | 2019-07-09 10:03:12 +0000 |
| commit | 4363edb0e8472a5414b237449f1f72db1785d277 (patch) | |
| tree | bef5aaf3b497edccab39dfabbd1f8cbaf82ce2a2 /llvm/docs | |
| parent | 564daa01fcf27760501cebadaf44b484c1467c99 (diff) | |
| download | bcm5719-llvm-4363edb0e8472a5414b237449f1f72db1785d277.tar.gz bcm5719-llvm-4363edb0e8472a5414b237449f1f72db1785d277.zip | |
[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
llvm-svn: 365451
Diffstat (limited to 'llvm/docs')
| -rw-r--r-- | llvm/docs/CommandGuide/llvm-dwarfdump.rst | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/llvm/docs/CommandGuide/llvm-dwarfdump.rst b/llvm/docs/CommandGuide/llvm-dwarfdump.rst index 1a128e5cb4b..25741449430 100644 --- a/llvm/docs/CommandGuide/llvm-dwarfdump.rst +++ b/llvm/docs/CommandGuide/llvm-dwarfdump.rst @@ -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 |
