mirror-llvm-project/bolt/docs
Gergely Bálint a25e3674ae
[BOLT] Rename Pointer Auth DWARF rewriter passes (#164622)
Rename passes to names that better reflect their intent, 
and describe their relationship to each other.

InsertNegateRAStatePass renamed to PointerAuthCFIFixup,
MarkRAStates renamed to PointerAuthCFIAnalyzer.

Added the --print-<passname> flags for these passes.
2025-12-04 11:29:40 +01:00
..
_static
BAT.md Improve formatting in BAT.md (#170254) 2025-12-02 12:57:53 +00:00
BinaryAnalysis.md [bolt] Fix typos discovered by codespell (#124726) 2025-10-14 14:45:40 +02:00
CMakeLists.txt [Documentation] Always use SVG for dot-generated doxygen images. (#136843) 2025-04-25 14:13:17 +02:00
CommandLineArgumentReference.md [BOLT] Support runtime library hook via DT_INIT_ARRAY (#167467) 2025-12-01 10:55:00 +03:00
conf.py
doxygen-mainpage.dox
doxygen.cfg.in [bolt] Fix typos discovered by codespell (#124726) 2025-10-14 14:45:40 +02:00
generate_doc.py fix(bolt/**.py): fix comparison to None (#94012) 2024-07-19 16:59:56 -07:00
Heatmap.png
HeatmapHeader.png [BOLT][docs] Expand Heatmaps.md (#98162) 2024-07-15 08:53:27 +01:00
Heatmaps.md [BOLT] Add --ba flag to deprecate --nl (#164257) 2025-10-23 10:13:28 +01:00
index.rst [BOLT] Add --ba flag to deprecate --nl (#164257) 2025-10-23 10:13:28 +01:00
OptimizingClang.md [BOLT][NFC] Use brstack in guides and user outputs (#163950) 2025-10-20 09:30:06 +00:00
OptimizingLinux.md [BOLT][NFC] Use brstack in guides and user outputs (#163950) 2025-10-20 09:30:06 +00:00
PointerAuthDesign.md [BOLT] Rename Pointer Auth DWARF rewriter passes (#164622) 2025-12-04 11:29:40 +01:00
README.txt
RuntimeLibrary.md [bolt] Fix typos discovered by codespell (#124726) 2025-10-14 14:45:40 +02:00

BOLT Documentation
====================

The BOLT documentation is written using the Sphinx documentation generator. It
is currently tested with Sphinx 1.1.3.

To build the documents into html configure BOLT with the following cmake options:

  * -DLLVM_ENABLE_SPHINX=ON
  * -DBOLT_INCLUDE_DOCS=ON

After configuring BOLT with these options the make rule `docs-bolt-html` should
be available.