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

[jhenderson]

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.

[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 :)

[jhenderson]

Thanks @MaskRay.

In D63011#1534265, @MaskRay wrote:

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.

[rupprecht]

In D63011#1534282, @jhenderson wrote:

Thanks @MaskRay.

In D63011#1534265, @MaskRay wrote:

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.

[jhenderson]

In D63011#1534304, @rupprecht wrote:

In D63011#1534282, @jhenderson wrote:

Thanks @MaskRay.

In D63011#1534265, @MaskRay wrote:

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...

In D63011#1534304, @rupprecht wrote:

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!)?

[rupprecht]

In D63011#1534305, @jhenderson wrote:

In D63011#1534304, @rupprecht wrote:

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...

llvm/trunk/docs/CommandGuide/index.rst

.. toctree::
    llvm-cov
    llvm-profdata
    llvm-stress
    llvm-symbolizer
    llvm-addr2line
    llvm-dwarfdump
    dsymutil
    llvm-mca
+   llvm-readobj
 
 Debugging Tools
 ~~~~~~~~~~~~~~~
 
 .. toctree::
    :maxdepth: 1
 
    bugpoint
    llvm-extract
    llvm-bcanalyzer
 
 Developer Tools
 ~~~~~~~~~~~~~~~
 
 .. toctree::
    :maxdepth: 1
 
    FileCheck
    tblgen
    lit
    llvm-build
    llvm-exegesis
    llvm-pdbutil
-   llvm-readobj