From 5900b63bf68f413964bd0eea56bb83f329709ada Mon Sep 17 00:00:00 2001 From: James Henderson Date: Fri, 14 Jun 2019 13:00:09 +0000 Subject: [PATCH] [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 "=" was used, whereas the doc said it had an effect when "--find" or "--name" were used. This change changes the doc to mention "=" 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 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@363380 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CommandGuide/llvm-dwarfdump.rst | 12 ++++++------ tools/llvm-dwarfdump/llvm-dwarfdump.cpp | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/CommandGuide/llvm-dwarfdump.rst b/docs/CommandGuide/llvm-dwarfdump.rst index 8e237fc95d3..b8ebc8aad89 100644 --- a/docs/CommandGuide/llvm-dwarfdump.rst +++ b/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 `=` 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 `=` argument of :option:`--debug-info`, or options such + as :option:`--find` or :option:`--name`. .. option:: --parent-recurse-depth= diff --git a/tools/llvm-dwarfdump/llvm-dwarfdump.cpp b/tools/llvm-dwarfdump/llvm-dwarfdump.cpp index 371e9406e1d..1efc96df665 100644 --- a/tools/llvm-dwarfdump/llvm-dwarfdump.cpp +++ b/tools/llvm-dwarfdump/llvm-dwarfdump.cpp @@ -173,14 +173,14 @@ static alias RegexAlias("x", desc("Alias for -regex"), aliasopt(UseRegex)); static opt ShowChildren("show-children", desc("Show a debug info entry's children when selectively " - "printing with the = option."), + "printing entries."), cat(DwarfDumpCategory)); static alias ShowChildrenAlias("c", desc("Alias for -show-children."), aliasopt(ShowChildren)); static opt ShowParents("show-parents", desc("Show a debug info entry's parents when selectively " - "printing with the = option."), + "printing entries."), cat(DwarfDumpCategory)); static alias ShowParentsAlias("p", desc("Alias for -show-parents."), aliasopt(ShowParents)); -- 2.40.0