This is an archive of the discontinued LLVM Phabricator instance.

Differential D67548

[docs][llvm-readelf][llvm-readobj] Improve --stack-sizes documentation
ClosedPublic

Authored by jhenderson on Sep 13 2019, 6:17 AM.

Details

Reviewers
MaskRay
wolfgangp
jakehehrlich
rupprecht
Commits
rGa2497b43e399: [docs][llvm-readelf][llvm-readobj] Improve --stack-sizes documentation
rL371862: [docs][llvm-readelf][llvm-readobj] Improve --stack-sizes documentation
Summary

llvm-readobj's document was missing --stack-sizes entirely from its document, so this patch adds it. It also adds a note to the llvm-readelf description that the switch is only implemented for GNU style output currently. For reference, --stack-sizes was added in rL367942.

Diff Detail

Event Timeline

jhenderson created this revision.Sep 13 2019, 6:17 AM
Herald added a project: Restricted Project. · View Herald TranscriptSep 13 2019, 6:17 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
jhenderson retitled this revision from [docs][llvm-readelf to [docs][llvm-readelf][llvm-readobj] Imrpove --stack-sizes documentation.Sep 13 2019, 6:20 AM
jhenderson edited the summary of this revision. (Show Details)
jhenderson added reviewers: MaskRay, wolfgangp, jakehehrlich, rupprecht.
jhenderson added subscribers: gbreynoo, chrisjackson, andrewng and 2 others.
MaskRay accepted this revision.Sep 13 2019, 6:51 AM

LG. D65313 added the support for GNU style output.

This revision is now accepted and ready to land.Sep 13 2019, 6:51 AM
jhenderson retitled this revision from [docs][llvm-readelf][llvm-readobj] Imrpove --stack-sizes documentation to [docs][llvm-readelf][llvm-readobj] Improve --stack-sizes documentation.Sep 13 2019, 7:57 AM
Closed by commit rL371862: [docs][llvm-readelf][llvm-readobj] Improve --stack-sizes documentation (authored by jhenderson). · Explain WhySep 13 2019, 8:02 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
3 lines
6 lines

Diff 220084

llvm/docs/CommandGuide/llvm-readelf.rst

Show First 20 Lines • Show All 157 Lines • ▼ Show 20 Lines
.. option:: --stackmap .. option:: --stackmap
Display contents of the stackmap section. Display contents of the stackmap section.
.. option:: --stack-sizes .. option:: --stack-sizes
Display the contents of the stack sizes section(s), i.e. pairs of function Display the contents of the stack sizes section(s), i.e. pairs of function
names and the size of their stack frames. names and the size of their stack frames. Currently only implemented for GNU
style output.
.. option:: --string-dump=<section[,section,...]>, -p .. option:: --string-dump=<section[,section,...]>, -p
Display the specified section(s) as a list of strings. ``section`` may be a Display the specified section(s) as a list of strings. ``section`` may be a
section index or section name. section index or section name.
.. option:: --symbols, --syms, -s .. option:: --symbols, --syms, -s
Show All 28 Lines

llvm/docs/CommandGuide/llvm-readobj.rst

Show First 20 Lines • Show All 208 Lines • ▼ Show 20 Lines
.. option:: --raw-relr .. option:: --raw-relr
Do not decode relocations in RELR relocation sections when displaying them. Do not decode relocations in RELR relocation sections when displaying them.
.. option:: --section-mapping .. option:: --section-mapping
Display the section to segment mapping. Display the section to segment mapping.
.. option:: --stack-sizes
Display the contents of the stack sizes section(s), i.e. pairs of function
names and the size of their stack frames. Currently only implemented for GNU
style output.
.. option:: --version-info, -V .. option:: --version-info, -V
Display version sections. Display version sections.
MACH-O SPECIFIC OPTIONS MACH-O SPECIFIC OPTIONS
----------------------- -----------------------
The following options are implemented only for the Mach-O file format. The following options are implemented only for the Mach-O file format.
▲ Show 20 Lines • Show All 84 Lines • Show Last 20 Lines