llvm/bolt/docs at 81ad8fbc2bb09bae61ed59316468011e4a42cf47 - llvm

intel/llvm

mirror of https://github.com/intel/llvm.git synced 2026-01-14 11:57:39 +08:00

Files

Paschalis Mpeis ae6cb98b29 [BOLT] Add --ba flag to deprecate --nl (#164257 )

The `--nl` flag, originally for Non-LBR mode, is deprecated and will be
replaced by `--basic-events` (alias `--ba`).

`--nl` remains as a deprecated alias for backward compatibility.

2025-10-23 10:13:28 +01:00

_static

…

BAT.md

…

BinaryAnalysis.md

[bolt] Fix typos discovered by codespell (#124726 )

2025-10-14 14:45:40 +02:00

CMakeLists.txt

…

CommandLineArgumentReference.md

[bolt] Fix typos discovered by codespell (#124726 )

2025-10-14 14:45:40 +02: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

…

Heatmap.png

…

HeatmapHeader.png

…

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

PacRetDesign.md

…

README.txt

…

RuntimeLibrary.md

[bolt] Fix typos discovered by codespell (#124726 )

2025-10-14 14:45:40 +02:00

README.txt

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.