Page MenuHomePhabricator

[docs][llvm-dwarfdump] Make some option descriptions clearer and more precise
ClosedPublic

Authored by jhenderson on Jul 8 2019, 7:16 AM.

Details

Summary

Some of the wording in the doc (taken largely from the help text), was a little imprecise in some cases, so this patch makes it a little more precise.

Diff Detail

Repository
rL LLVM

Event Timeline

jhenderson created this revision.Jul 8 2019, 7:16 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 8 2019, 7:16 AM
JDevlieghere accepted this revision.Jul 8 2019, 8:05 AM

Thanks James! LGTM

This revision is now accepted and ready to land.Jul 8 2019, 8:05 AM
probinson added inline comments.Jul 8 2019, 8:42 AM
docs/CommandGuide/llvm-dwarfdump.rst
71 ↗(On Diff #208396)

This also applies to regex, according to the help text for regex?

105 ↗(On Diff #208396)

Maybe "only show children to..." ?

Just for my curiosity, does this also limit the depth displayed when you dump an entire .debug_info/types section?

jhenderson marked 3 inline comments as done.Jul 8 2019, 9:18 AM
jhenderson added inline comments.
docs/CommandGuide/llvm-dwarfdump.rst
71 ↗(On Diff #208396)

I don't think we need to duplicate the references. The interaction is described in the --regex description below, which itself also only applies to --option name, so anything we say here is redundant.

105 ↗(On Diff #208396)

I think the "only show children" bit is important, since the initial root doesn't count as 1 (i.e. -r 0 prints the root tag, and no children, -r 1 prints the first-level children etc).

The switch does apply to .debug_info/types dumping, not just when displaying specific entries.

jhenderson updated this revision to Diff 208442.Jul 8 2019, 9:25 AM
jhenderson marked an inline comment as done.

Improve --recurse-depth text.

This revision was automatically updated to reflect the committed changes.