Commit eae90172 authored by Miguel Ojeda's avatar Miguel Ojeda
Browse files

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.

Link: https://lore.kernel.org/rust-for-linux/CAKwvOdm5JT4wbdQQYuW+RT07rCi6whGBM2iUAyg8A1CmLXG6Nw@mail.gmail.com/


Reviewed-by: default avatarNick Desaulniers <ndesaulniers@google.com>
Reviewed-by: default avatarNathan Chancellor <nathan@kernel.org>
Reviewed-by: default avatarMartin Rodriguez Reboredo <yakoyoku@gmail.com>
Link: https://lore.kernel.org/r/20230616001631.463536-4-ojeda@kernel.org


Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent dee3a6b8

Documentation/rust/quick-start.rst

+17 −0
Original line number Diff line number Diff line
@@ -100,6 +100,23 @@ Install it via (note that this will download and build the tool from source):: 


	cargo install --locked --version $(scripts/min-tool-version.sh 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

``libclang``):



* ``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 directory containing it.



* Or ``CLANG_PATH`` can be pointed to a ``clang`` executable.



For details, please see ``clang-sys``'s documentation at:



	https://github.com/KyleMayes/clang-sys#environment-variables





Requirements: Developing

------------------------