llvm-capstone/bolt/docs
Amir Ayupov 8f1d94aaea
[BOLT] Use continuous output addresses in delta encoding in BAT
Make output function addresses be delta-encoded wrt last offset in the
previous function. This reduces the deltas in function start addresses.

Test Plan:
Reduces BAT section size to:
- large binary: 12218860 bytes (0.32x original),
- medium binary: 1606580 bytes (0.27x original),
- small binary: 404 bytes (0.28x original),

Reviewers: rafaelauler

Reviewed By: rafaelauler

Pull Request: https://github.com/llvm/llvm-project/pull/76904
2024-01-18 13:49:44 -08:00
..
_static
BAT.md [BOLT] Use continuous output addresses in delta encoding in BAT 2024-01-18 13:49:44 -08:00
CMakeLists.txt
conf.py
doxygen-mainpage.dox
doxygen.cfg.in [BOLT] Fix typos (#68121) 2023-11-09 11:29:46 -08:00
Heatmap.png
Heatmaps.md
index.rst
OptimizingClang.md
README.txt
RuntimeLibrary.md

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.