Let's document: llvm

[pixelcmtd]

• llvm (a page listing the other ones and giving an example of a pipe using many of the individual tools that you might want to use while making a new llvm pass for example)
• lld (a page giving an overview of the parts of lld)

Commands

• bugpoint
• clang-apply-replacements
• clang-change-namespace
• clang-check clang-check: add page #18515
• clang-doc
• clang-extdef-mapping
• clang-include-fixer
• clang-move
• clang-offload-bundler
• clang-offload-wrapper
• clang-query
• clang-refactor
• clang-rename
• clang-reorder-fields
• clang-scan-deps
• clang-tblgen
• clang-tidy clang-tidy: add page #7232
• clangd clangd: add page #9419
• clangd-xpc-test-client
• pp-trace
• diagtool
• dsymutil
• FileCheck
• llvm-bitcode-strip
• llvm-c-test
• llvm-cfi-verify
• llvm-cov
• llvm-cvtres
• llvm-cxxdump
• llvm-cxxfilt
• llvm-cxxmap
• llvm-diff
• llvm-dlltool
• llvm-dwarfdump
• llvm-dwp
• llvm-elfabi
• llvm-exegesis
• llvm-extract
• llvm-gsymutil
• llvm-ifs
• llvm-install-name-tool
• llvm-jitlink-executor
• llvm-jitlink
• llvm-libtool-darwin
• llvm-link
• llvm-locstats
• llvm-lto2
• llvm-lto
• llvm-mc -> llvm-mc: add page #15356
• llvm-mca
• llvm-ml
• llvm-modextract
• llvm-mt
• llvm-opt-report
• llvm-pdbutil
• llvm-profdata
• llvm-profgen
• llvm-rc
• llvm-readobj
• llvm-reduce
• llvm-rtdyld
• llvm-sim
• llvm-split
• llvm-stress
• llvm-symbolizer
• llvm-tblgen
• lldb-tblgen
• mlir-tblgen
• tblgen
• llvm-undname
• llvm-xray
• llc
• ld.lld (copy-paste or alias of page request: ld #7794)
• ld64.lld (we need a macos-specific page for ld, too)
• lld-link (alias to link)
• wasm-ld
• lit
• openclc (may be an alias for clang, or a copy-paste like clang++)
• opt
• clang++ → clang++: add page #6501
• lli → lli: add page #7256
• llvm-as → llvm-as: add page #6496
• llvm-bcanalyzer → llvm-bcanalyzer: add page #6558
• llvm-cat → llvm-cat: add page #6564
• llvm-config → llvm-config: add page #6498

Aliases

• clang-cl = cl
• llvm-addr2line = addr2line
• llvm-lib = lib
• llvm-lipo = lipo → llvm-lipo: add page #9819
• llvm-objcopy = objcopy
• llvm-otool = otool
• llvm-ranlib = ranlib
• llvm-readelf = readelf
• llvm-size = size
• llvm-strip = strip
• clang-cpp = clang++ → clang-cpp, llvm-g++: add page #6542
• llvm-ar = ar → llvm-ar, llvm-nm, llvm-strings: add page #6566
• llvm-g++ = clang++ → clang-cpp, llvm-g++: add page #6542
• llvm-gcc = clang → llvm-gcc: add page #6497
• llvm-nm = nm → llvm-ar, llvm-nm, llvm-strings: add page #6566
• llvm-objdump = objdump → llvm-objdump: add page #6563
• llvm-strings = strings → llvm-ar, llvm-nm, llvm-strings: add page #6566

This list is incomplete, for additional commands refer to your LLVM's bin (e. g. /opt/llvm/bin), source code or documentation.

[marchersimon]

Any idea where to find documentation for the commands, which don't have a link?

[pixelcmtd]

Any idea where to find documentation for the commands, which don't have a link?

$command -h obviously. For the links in articles idk. You might find something, if you search through the llvm codebase though.

[P2Tree]

I always work on the LLVM project, and some of the commands are too long to remember. I am surprised that some useful commands are still not documented, such as llvm-mc, llc, lit, and even readelf. Do we need to add documentation for these commands?

[spageektti]

I always work on the LLVM project, and some of the commands are too long to remember. I am surprised that some useful commands are still not documented, such as llvm-mc, llc, lit, and even readelf. Do we need to add documentation for these commands?

You can create tldr pages for those commands if you want.

[P2Tree]

I always work on the LLVM project, and some of the commands are too long to remember. I am surprised that some useful commands are still not documented, such as llvm-mc, llc, lit, and even readelf. Do we need to add documentation for these commands?我一直在做LLVM项目，有些命令太长记不住。令我惊讶的是，一些有用的命令仍然没有记录，例如 llvm-mc、llc、lit，甚至 readelf。我们需要为这些命令添加文档吗？

You can create tldr pages for those commands if you want.如果需要，您可以为这些命令创建 tldr 页面。

I can give it a try.
This is a great project that allows me to no longer have to search what I need through lengthy man pages.