Skip to content

Commit

Permalink
[docs][llvm-dwarfdump] Make the --show-parents and --show-children he…
Browse files Browse the repository at this point in the history
…lp 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
  • Loading branch information
jh7370 committed Jun 14, 2019
1 parent a1c33ed commit 891cdaa
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions llvm/docs/CommandGuide/llvm-dwarfdump.rst
Expand Up @@ -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

Expand Down Expand Up @@ -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>

Expand Down
4 changes: 2 additions & 2 deletions llvm/tools/llvm-dwarfdump/llvm-dwarfdump.cpp
Expand Up @@ -173,14 +173,14 @@ static alias RegexAlias("x", desc("Alias for -regex"), aliasopt(UseRegex));
static opt<bool>
ShowChildren("show-children",
desc("Show a debug info entry's children when selectively "
"printing with the =<offset> option."),
"printing entries."),
cat(DwarfDumpCategory));
static alias ShowChildrenAlias("c", desc("Alias for -show-children."),
aliasopt(ShowChildren));
static opt<bool>
ShowParents("show-parents",
desc("Show a debug info entry's parents when selectively "
"printing with the =<offset> option."),
"printing entries."),
cat(DwarfDumpCategory));
static alias ShowParentsAlias("p", desc("Alias for -show-parents."),
aliasopt(ShowParents));
Expand Down

0 comments on commit 891cdaa

Please sign in to comment.