llvm.org GIT mirror llvm / 5900b63
[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 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@363380 91177308-0d34-0410-b5e6-96231b3b80d8 James Henderson a month ago
2 changed file(s) with 8 addition(s) and 8 deletion(s). Raw diff Collapse all Expand all
3434
3535 .. option:: -c, --show-children
3636
37 Show a debug info entry's children when using
38 the :option:`--debug-info`, :option:`--find`,
39 and :option:`--name` options.
37 Show a debug info entry's children when selectively printing with
38 the `=` argument of :option:`--debug-info`, or options such
39 as :option:`--find` or :option:`--name`.
4040
4141 .. option:: --color
4242
8787
8888 .. option:: -p, --show-parents
8989
90 Show a debug info entry's parent objects when using the
91 :option:`--debug-info`, :option:`--find`, and
92 :option:`--name` options.
90 Show a debug info entry's parents when selectively printing with
91 the `=` argument of :option:`--debug-info`, or options such
92 as :option:`--find` or :option:`--name`.
9393
9494 .. option:: --parent-recurse-depth=
9595
172172 static opt
173173 ShowChildren("show-children",
174174 desc("Show a debug info entry's children when selectively "
175 "printing with the = option."),
175 "printing entries."),
176176 cat(DwarfDumpCategory));
177177 static alias ShowChildrenAlias("c", desc("Alias for -show-children."),
178178 aliasopt(ShowChildren));
179179 static opt
180180 ShowParents("show-parents",
181181 desc("Show a debug info entry's parents when selectively "
182 "printing with the = option."),
182 "printing entries."),
183183 cat(DwarfDumpCategory));
184184 static alias ShowParentsAlias("p", desc("Alias for -show-parents."),
185185 aliasopt(ShowParents));