summaryrefslogtreecommitdiffstats
path: root/llvm/docs/CommandGuide
diff options
context:
space:
mode:
authorJames Henderson <jh7370@my.bristol.ac.uk>2019-06-14 13:00:09 +0000
committerJames Henderson <jh7370@my.bristol.ac.uk>2019-06-14 13:00:09 +0000
commit891cdaab7a2957238758ebf531f784a508ab9093 (patch)
treeb0d8fe34f5568d4b3322843e3da7c36fd0cc9be3 /llvm/docs/CommandGuide
parenta1c33ed55852978925a1008c0220ac1cc40ef3c8 (diff)
downloadbcm5719-llvm-891cdaab7a2957238758ebf531f784a508ab9093.tar.gz
bcm5719-llvm-891cdaab7a2957238758ebf531f784a508ab9093.zip
[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 llvm-svn: 363380
Diffstat (limited to 'llvm/docs/CommandGuide')
-rw-r--r--llvm/docs/CommandGuide/llvm-dwarfdump.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/llvm/docs/CommandGuide/llvm-dwarfdump.rst b/llvm/docs/CommandGuide/llvm-dwarfdump.rst
index 8e237fc95d3..b8ebc8aad89 100644
--- a/llvm/docs/CommandGuide/llvm-dwarfdump.rst
+++ b/llvm/docs/CommandGuide/llvm-dwarfdump.rst
@@ -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>
OpenPOWER on IntegriCloud