Skip to content

Commit

Permalink
Add LLVM version
Browse files Browse the repository at this point in the history
  • Loading branch information
romainthomas committed Dec 7, 2024
1 parent 40245ae commit 9c0c01a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/sphinx/extended/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ Then, you can enjoy all extended features in Rust:
LIEF Extended & LLVM
********************


LIEF extended relies on LLVM for some of its functionalities like the
:ref:`disassembler <extended-disassembler>` and the
:ref:`DWARF <extended-dwarf>`/:ref:`PDB <extended-pdb>` support.
Expand All @@ -167,6 +168,10 @@ The LLVM version used by LIEF is fully based on the upstream version and integra
into LIEF extended such that users don't have to deal with the compilation of LLVM
or its integration.

.. note::

LIEF is currently using LLVM |lief-llvm-version|.

Whenever it's possible and suitable, bug fixes and enhancements have been
PR-submitted to the LLVM project:

Expand Down
3 changes: 3 additions & 0 deletions doc/sphinx/sphinx_lief_doc/config/lief_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ def apply(self, **kwargs: Any) -> None:
text = self.config.lief_rust_doc
elif refname == 'lief-extended-email':
text = self.config.lief_extended_email
elif refname == 'lief-llvm-version':
text = self.config.lief_llvm_version

if text is None:
continue
Expand Down Expand Up @@ -70,6 +72,7 @@ def setup(app: Sphinx):
app.config.lief_gh_sponsor_url = "https://github.com/sponsors/lief-project"
app.config.lief_extended_url = "https://extended.lief.re/"
app.config.lief_extended_email = "[email protected]"
app.config.lief_llvm_version = "19.1.2"

app.config.lief_rust_doc_base_url = "https://lief.re/doc/stable/rust"
app.config.lief_rust_doc = f"{app.config.lief_rust_doc_base_url}/lief"
Expand Down

0 comments on commit 9c0c01a

Please sign in to comment.