Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2025-01-14 03:45:33 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

[docs][llvm-dwarfdump] Make the --show-parents and --show-children help text and docs more consistent and correct

Browse Source 
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
This commit is contained in:
James Henderson 2019-06-14 13:00:09 +00:00
parent a1c33ed558
commit 891cdaab7a
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
llvm/docs/CommandGuide/llvm-dwarfdump.rst
View File

@ -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>

4
llvm/tools/llvm-dwarfdump/llvm-dwarfdump.cpp
View File

@ -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));