diff --git a/doc/sphinx/extended/intro.rst b/doc/sphinx/extended/intro.rst index 47885d4b3c..395c5442c5 100644 --- a/doc/sphinx/extended/intro.rst +++ b/doc/sphinx/extended/intro.rst @@ -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 ` and the :ref:`DWARF `/:ref:`PDB ` support. @@ -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: diff --git a/doc/sphinx/sphinx_lief_doc/config/lief_config.py b/doc/sphinx/sphinx_lief_doc/config/lief_config.py index 432f711e20..6ac5c2280b 100644 --- a/doc/sphinx/sphinx_lief_doc/config/lief_config.py +++ b/doc/sphinx/sphinx_lief_doc/config/lief_config.py @@ -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 @@ -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 = "extended@lief.re" + 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"