This is an archive of the discontinued LLVM Phabricator instance.

[llvm-readelf][docs] Add missing options and details to the help output and the command guide
ClosedPublic

Authored by gbreynoo on Oct 6 2021, 9:29 AM.

Details

Summary

This change is to keep the help text and command guide of llvm-readelf in tandem.

  • In the help text mention that --section-data, --section-relocations, --section-symbols and --stack-sizes have no effect on GNU style output; give the accepted values for --elf-output-style and update the description of --gnu-hash-table to use the command guide description.
  • In the command guide add the missing options -a, --dependant-libraries,--no-demangle, --wide and -W. Also update the description of --symbols so it matches the help text.

Diff Detail

Event Timeline

gbreynoo created this revision.Oct 6 2021, 9:29 AM
gbreynoo requested review of this revision.Oct 6 2021, 9:29 AM
Herald added a project: Restricted Project. · View Herald TranscriptOct 6 2021, 9:29 AM

LG

llvm/docs/CommandGuide/llvm-readelf.rst
202

You may additionally say that our style is similar to GNU readelf's -W.

llvm/tools/llvm-readobj/Opts.td
50

are are -> are

In some utilities we use colon to indicate choices, e.g. Specify ELF dump style: LLVM or GNU

jhenderson accepted this revision.Oct 7 2021, 1:13 AM
jhenderson added inline comments.
llvm/tools/llvm-readobj/Opts.td
53

Other help text doesn't include trailing full stop.

This revision is now accepted and ready to land.Oct 7 2021, 1:13 AM
This revision was landed with ongoing or failed builds.Oct 7 2021, 9:11 AM
This revision was automatically updated to reflect the committed changes.
gbreynoo marked 2 inline comments as done.
gbreynoo marked an inline comment as done.Oct 7 2021, 9:12 AM