[lkml]   [2023]   [Jan]   [9]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
Patch in this message
Subject[PATCH 1/6] docs: rust: add paragraph about finding a suitable `libclang`
Sometimes users need to tweak the finding process of `libclang`
for `bindgen` via the `clang-sys`-provided environment variables.

Thus add a paragraph to the setting up guide, including a reference
to `clang-sys`'s relevant documentation.

Signed-off-by: Miguel Ojeda <>
Documentation/rust/quick-start.rst | 17 +++++++++++++++++
1 file changed, 17 insertions(+)

diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst
index 13b7744b1e27..cae21ea7de41 100644
--- a/Documentation/rust/quick-start.rst
+++ b/Documentation/rust/quick-start.rst
@@ -100,6 +100,23 @@ Install it via (note that this will download and build the tool from source)::

cargo install --locked --version $(scripts/ bindgen) bindgen

+``bindgen`` needs to find a suitable ``libclang`` in order to work. If it is
+not found (or a different ``libclang`` than the one found should be used),
+the process can be tweaked using the environment variables understood by
+``clang-sys`` (the Rust bindings crate that ``bindgen`` uses to access
+* ``LLVM_CONFIG_PATH`` can be pointed to an ``llvm-config`` executable.
+* Or ``LIBCLANG_PATH`` can be pointed to a ``libclang`` shared library
+ or to the directoy containing it.
+* Or ``CLANG_PATH`` can be pointed to a ``clang`` executable.
+For details, please see ``clang-sys``'s documentation at:

Requirements: Developing
 \ /
  Last update: 2023-03-26 23:33    [W:0.943 / U:0.288 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site