Page MenuHomePhabricator

[docs][llvm-readelf] Expand llvm-readelf documentation
ClosedPublic

Authored by jhenderson on Jun 26 2019, 8:31 AM.

Details

Summary

Previously, the llvm-readelf documentation was essentially just a list of differences to llvm-readobj. Since llvm-readelf is the more likely goto tool for many people migrating to the LLVM toolchain, it seems like it would be helpful to document all the switches in the llvm-readelf document too. This change expands the options listed accordingly. Additionally, they are unlikely to care what the differences are to llvm-readobj, since they won't be familiar with the latter as there is no GNU equivalent, so this change moves the "differences" section to llvm-readobj's documentation.

Diff Detail

Repository
rL LLVM

Event Timeline

jhenderson created this revision.Jun 26 2019, 8:31 AM
Herald added a project: Restricted Project. · View Herald TranscriptJun 26 2019, 8:31 AM

Overall no objections. Only thing I can think of that could be surprising is the presence of mach-o and coff options in llvm-readelf. A case could be made for leaving these out as people migrating won't need to use them, but I don't have a strong opinion.

Overall no objections. Only thing I can think of that could be surprising is the presence of mach-o and coff options in llvm-readelf. A case could be made for leaving these out as people migrating won't need to use them, but I don't have a strong opinion.

I'd be okay with this, but in that case, I'd recommend hiding the options in the help text too, so that's possibly tangential to this change? I'll post something on the mailing list to see if anybody else has any thoughts.

I'll post something on the mailing list to see if anybody else has any thoughts.

Done: http://lists.llvm.org/pipermail/llvm-dev/2019-June/133384.html

I'll post something on the mailing list to see if anybody else has any thoughts.

Done: http://lists.llvm.org/pipermail/llvm-dev/2019-June/133384.html

Thanks. If you don't get any feedback, feel free to choose your own way.

jhenderson updated this revision to Diff 207297.Jul 1 2019, 7:20 AM
jhenderson added a reviewer: rnk.

Rebase + remove Mach-O and COFF options from the llvm-readelf documentation. I'll upload another review at a later point to remove the same options from llvm-readelf's help text.

peter.smith accepted this revision.Jul 1 2019, 8:04 AM

Thanks for the update. I'm happy with the changes.

This revision is now accepted and ready to land.Jul 1 2019, 8:04 AM

Thanks for the update. I'm happy with the changes.

Thanks. I'm committing this now, but I'm happy for more feedback if people want to give any.

This revision was automatically updated to reflect the committed changes.