llvm-project

History

Jordan Brantner d251a328b8

[BOLT] Fix typo from alterantive to alternative (#99704 )

Fix typo from `alterantive` -> `alternative`

Signed-off-by: Jordan Brantner <brantnej@oregonstate.edu>

2024-07-22 18:35:20 -07:00

_static

[BOLT][Docs] Add Sphinx documentation

2023-01-03 17:39:09 -08:00

BAT.md

[BOLT][BAT] Add entries for deleted basic blocks

2024-05-23 19:19:07 -07:00

CMakeLists.txt

[BOLT] Revise IDE folder structure (#89742 )

2024-05-25 17:15:37 +02:00

CommandLineArgumentReference.md

[BOLT] Fix typo from alterantive to alternative (#99704 )

2024-07-22 18:35:20 -07:00

conf.py

[NFC][Py Reformat] Reformat python files in the rest of the dirs

2023-05-25 11:17:05 +02:00

doxygen-mainpage.dox

[BOLT][DOCS] Link to README instead of the github page in Doxygen

2021-12-29 17:38:06 -08:00

doxygen.cfg.in

[BOLT] Fix typos (#68121 )

2023-11-09 11:29:46 -08:00

generate_doc.py

fix(bolt/**.py): fix comparison to None (#94012 )

2024-07-19 16:59:56 -07:00

Heatmap.png

Rebase: Merge BOLT codebase in monorepo

2020-12-01 16:29:39 -08:00

HeatmapHeader.png

[BOLT][docs] Expand Heatmaps.md (#98162 )

2024-07-15 08:53:27 +01:00

Heatmaps.md

[BOLT][docs] Expand Heatmaps.md (#98162 )

2024-07-15 08:53:27 +01:00

index.rst

[BOLT][Docs] Add Sphinx documentation

2023-01-03 17:39:09 -08:00

OptimizingClang.md

[bolt][Docs] fix missing option in cmake of stage3 in OptimizingClang.md (#93684 )

2024-07-19 16:55:21 -07:00

OptimizingLinux.md

[BOLT][docs] Add merge-fdata to Linux optimization guide (#97659 )

2024-07-03 17:30:37 -07:00

README.txt

[BOLT][Docs] Add Sphinx documentation

2023-01-03 17:39:09 -08:00

RuntimeLibrary.md

Rebase: Merge BOLT codebase in monorepo

2020-12-01 16:29:39 -08: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.