Page MenuHomePhabricator

[docs]Move llvm-readobj from "Developer Tools" to "Basic Commands"
ClosedPublic

Authored by jhenderson on Jun 7 2019, 9:14 AM.

Details

Summary

On the Command Guide page, there are multiple sections with links to the different documentation pages available for LLVM tools. The "Basic Tools" section includes tools like llvm-objdump, llvm-nm and so on. The "Developer Tools" section contains things like FileCheck and lit. This change moves llvm-readobj into the former block, from the latter.

Diff Detail

Repository
rL LLVM

Event Timeline

jhenderson created this revision.Jun 7 2019, 9:14 AM
Herald added a project: Restricted Project. · View Herald TranscriptJun 7 2019, 9:14 AM
Herald added a subscriber: arphaman. · View Herald Transcript
jhenderson edited the summary of this revision. (Show Details)Jun 7 2019, 9:22 AM

Since llvm-objdump and llvm-nm are in the "Basic Commands" list, and llvm-readobj is used in various test directories: CodeGen/DebugInfo/MC/LTO/..., I think it qualifies as a Basic Command :)

MaskRay accepted this revision.Jun 7 2019, 9:25 AM
This revision is now accepted and ready to land.Jun 7 2019, 9:25 AM

Thanks @MaskRay.

Since llvm-objdump and llvm-nm are in the "Basic Commands" list, and llvm-readobj is used in various test directories: CodeGen/DebugInfo/MC/LTO/..., I think it qualifies as a Basic Command :)

I think the distinction is "tools in LLVM used by people" versus "tools used by LLVM developers (mostly for testing/debugging)". llvm-readobj began life as the latter but is now very much the former.

This revision was automatically updated to reflect the committed changes.

Thanks @MaskRay.

Since llvm-objdump and llvm-nm are in the "Basic Commands" list, and llvm-readobj is used in various test directories: CodeGen/DebugInfo/MC/LTO/..., I think it qualifies as a Basic Command :)

I think the distinction is "tools in LLVM used by people" versus "tools used by LLVM developers (mostly for testing/debugging)".

Are you saying LLVM developers aren't people? :p

I actually wonder if we should split out all the binary utilities to a separate section. We should try to advertise the replacement-ness of all the tools we have.

Thanks @MaskRay.

Since llvm-objdump and llvm-nm are in the "Basic Commands" list, and llvm-readobj is used in various test directories: CodeGen/DebugInfo/MC/LTO/..., I think it qualifies as a Basic Command :)

I think the distinction is "tools in LLVM used by people" versus "tools used by LLVM developers (mostly for testing/debugging)".

Are you saying LLVM developers aren't people? :p

Haha, sorry, that first bit should say "by people outside of LLVM development" or something...

I actually wonder if we should split out all the binary utilities to a separate section. We should try to advertise the replacement-ness of all the tools we have.

That's probably not a bad shout, though we'd have to figure out exactly what we mean by "binary utilities" as I suspect everybody has a slightly different interpretation of this. Maybe a section labelled "GNU replacements" (note that llvm-readobj wouldn't actually qualify under this!)?

I actually wonder if we should split out all the binary utilities to a separate section. We should try to advertise the replacement-ness of all the tools we have.

That's probably not a bad shout, though we'd have to figure out exactly what we mean by "binary utilities" as I suspect everybody has a slightly different interpretation of this. Maybe a section labelled "GNU replacements"

SGTM. There's a definitive list of that here: https://www.gnu.org/software/binutils/

(note that llvm-readobj wouldn't actually qualify under this!)?

I think that's fine -- we should list llvm-readelf in the GNU replacement with a simple page that explains the difference and links to llvm-readobj (see the doc we have for llvm-addr2line for instance)

Actually, maybe I'll just rephrase this in the form of a patch...