opencode.siil.arti.ee/llvm-tms34010

0 Fork 0

Files

T

Scott Linder 03511907c7 [docs] Enforce unambiguous toctree in llvm/docs (#203967 )

It seems like using a non-`hidden` `toctree` for page navigation is a
bit of a trap, in that every doc must have a single unique path through
the global toctree to the root doc, and it is very easy to end up with
multiple.

This patch tries to address the warnings (actually infos, hence why it
does not fail the build) in llvm/docs/.

I tried to preserve the documents as-is, by hiding `toctree`s and
instead using lists of `{doc}` forms where the `toctree` was visible
before.

The only visual change in the resulting HTML is that the link is now
underlined where it wasn't before.

I also nested the `Tutorials` section in GISel Porting document, and
didn't link to it directly as the title is a bit ambiguous without the
context of the document it appears in.

I also saw warnings about a jump in heading level in
`llvm-debuginfo-analyzer/README.md` and assumed it was just a mistake,
so I collapsed the level-3 headings down to level-2.

Finally, I wrote a sphinx extension to make ambiguous toctree entries
into errors, so the docs do not regress. I hope to fix other sphinx
project in llvm-project and enable the checks for them too, assuming
this patch is accepted.

Change-Id: Icb11de69be1ea5489fba501aee4d767f5129e7e1

2026-06-25 11:21:46 -04:00

2.5 KiB

Raw Permalink Blame History

LLVM Command Guide

:hidden:

FileCheck
clang-tblgen
dsymutil
lit
llc
lldb-tblgen
lli
llubi
llvm-addr2line
llvm-ar
llvm-as
llvm-bcanalyzer
llvm-cgdata
llvm-config
llvm-cov
llvm-cxxfilt
llvm-cxxmap
llvm-debuginfo-analyzer
llvm-diff
llvm-dis
llvm-dwarfdump
llvm-dwarfutil
llvm-exegesis
llvm-extract
llvm-extract-bundle-entry
llvm-ifs
llvm-install-name-tool
llvm-ir2vec
llvm-lib
llvm-libtool-darwin
llvm-link
llvm-lipo
llvm-locstats
llvm-mc
llvm-mca
llvm-nm
llvm-objcopy
llvm-objdump
llvm-offload-binary
llvm-opt-report
llvm-otool
llvm-pdbutil
llvm-profdata
llvm-profgen
llvm-ranlib
llvm-readelf
llvm-readobj
llvm-reduce
llvm-remarkutil
llvm-size
llvm-stress
llvm-strings
llvm-strip
llvm-symbolizer
llvm-tblgen
llvm-test-mustache-spec
llvm-tli-checker
mlir-tblgen
opt
tblgen

The following documents are command descriptions for all of the LLVM tools. These pages describe how to use the LLVM commands and what their options are. Note that these pages do not describe all of the options available for all tools. To get a complete listing, pass the --help (general options) or --help-hidden (general and debugging options) arguments to the tool you are interested in.

Basic Commands

{doc}dsymutil
{doc}llc
{doc}lli
{doc}llubi
{doc}llvm-as
{doc}llvm-cgdata
{doc}llvm-config
{doc}llvm-cov
{doc}llvm-cxxmap
{doc}llvm-debuginfo-analyzer
{doc}llvm-diff
{doc}llvm-dis
{doc}llvm-dwarfdump
{doc}llvm-dwarfutil
{doc}llvm-extract-bundle-entry
{doc}llvm-ir2vec
{doc}llvm-lib
{doc}llvm-libtool-darwin
{doc}llvm-link
{doc}llvm-lipo
{doc}llvm-mc
{doc}llvm-mca
{doc}llvm-opt-report
{doc}llvm-otool
{doc}llvm-profdata
{doc}llvm-readobj
{doc}llvm-reduce
{doc}llvm-stress
{doc}llvm-symbolizer
{doc}opt

GNU binutils replacements

{doc}llvm-addr2line
{doc}llvm-ar
{doc}llvm-cxxfilt
{doc}llvm-install-name-tool
{doc}llvm-nm
{doc}llvm-objcopy
{doc}llvm-objdump
{doc}llvm-ranlib
{doc}llvm-readelf
{doc}llvm-size
{doc}llvm-strings
{doc}llvm-strip

Debugging Tools

{doc}llvm-extract
{doc}llvm-bcanalyzer
{doc}llvm-reduce

Developer Tools

{doc}FileCheck
{doc}tblgen
{doc}clang-tblgen
{doc}lldb-tblgen
{doc}llvm-tblgen
{doc}mlir-tblgen
{doc}lit
{doc}llvm-exegesis
{doc}llvm-ifs
{doc}llvm-locstats
{doc}llvm-test-mustache-spec
{doc}llvm-pdbutil
{doc}llvm-profgen
{doc}llvm-tli-checker
{doc}llvm-offload-binary

Remarks Tools

{doc}llvm-remarkutil

2.5 KiB Raw Permalink Blame History