Documentation/rust/quick-start.rst

1 .. SPDX-License-Identifier: GPL-2.0
10 suitable -- the first section below explains this approach. An advantage of this
28 -------------
36 	pacman -S rust rust-src rust-bindgen
45 	apt install rustc rust-src bindgen rustfmt rust-clippy
48 Fedora Linux
51 Fedora Linux provides recent Rust releases and thus it should generally work out
54 	dnf install rust rust-src bindgen-cli rustfmt clippy
63 	USE='rust-src rustfmt clippy' emerge dev-lang/rust dev-util/bindgen
76 	  nativeBuildInputs = with pkgs; [ rustc rust-bindgen rustfmt clippy ];
87 	zypper install rust rust1.79-src rust-bindgen clang
93 Ubuntu LTS and non-LTS (interim) releases provide recent Rust releases and thus
96 	apt install rustc-1.80 rust-1.80-src bindgen-0.65 rustfmt-1.80 rust-1.80-clippy
100 	RUST_LIB_SRC=/usr/src/rustc-$(rustc-1.80 --version | cut -d' ' -f2)/library
102 In addition, ``bindgen-0.65`` is available in newer releases (24.04 LTS and
108 ----------------------
128 ``--path=<build-dir>`` argument to the ``set`` sub-command) and run,
137 sub-directories).
141 	https://forge.rust-lang.org/infra/other-installation-methods.html#standalone
148 cross-compile ``core``.
152 	rustup component add rust-src
155 version later on requires re-adding the component.
160 	curl -L "https://static.rust-lang.org/dist/rust-src-$(rustc --version | cut -d' ' -f2).tar.gz" |
161 		tar -xzf - -C "$(rustc --print sysroot)/lib" \
162 		"rust-src-$(rustc --version | cut -d' ' -f2)/rust-src/lib/" \
163 		--strip-components=3
166 updating the source tree (this can be done by removing ``$(rustc --print
186 	https://llvm.org/docs/GettingStarted.html#getting-the-source-code-and-building-llvm
189 to fetch pre-built releases and distribution packages.
201 	cargo install --locked bindgen-cli
203 ``bindgen`` uses the ``clang-sys`` crate to find a suitable ``libclang`` (which
208 ``LIBCLANG_PATH`` environment variable. For details, please see ``clang-sys``'s
211 	https://github.com/KyleMayes/clang-sys#linking
213 	https://github.com/KyleMayes/clang-sys#environment-variables
217 ------------------------
228 coding-guidelines.rst).
244 general-information.rst).
260 general-information.rst).
272 rust-analyzer
275 The `rust-analyzer <https://rust-analyzer.github.io/>`_ language server can
279 ``rust-analyzer`` needs a configuration file, ``rust-project.json``, which
280 can be generated by the ``rust-analyzer`` Make target::
282 	make LLVM=1 rust-analyzer
286 -------------
296 	    -> Sample kernel code
297 	        -> Rust samples
299 And enable some sample modules either as built-in or as loadable.
303 --------
315 -------
325 - Install a newer release (GDB >= 10.2, Binutils >= 2.36).
327 - Some versions of GDB (e.g. vanilla GDB 10.1) are able to use
328   the pre-demangled names embedded in the debug info (``CONFIG_DEBUG_INFO``).