Message-ID: <20240709160615.998336-14-ojeda@kernel.org>
Date: Tue,  9 Jul 2024 18:06:08 +0200
From: Miguel Ojeda <ojeda@...nel.org>
To: Miguel Ojeda <ojeda@...nel.org>,
	Wedson Almeida Filho <wedsonaf@...il.com>,
	Alex Gaynor <alex.gaynor@...il.com>
Cc: Boqun Feng <boqun.feng@...il.com>,
	Gary Guo <gary@...yguo.net>,
	Björn Roy Baron <bjorn3_gh@...tonmail.com>,
	Benno Lossin <benno.lossin@...ton.me>,
	Andreas Hindborg <a.hindborg@...sung.com>,
	Alice Ryhl <aliceryhl@...gle.com>,
	rust-for-linux@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	patches@...ts.linux.dev,
	Jan Alexander Steffens <heftig@...hlinux.org>,
	Johannes Löthberg <johannes@...iasis.com>,
	Fabian Grünbichler <debian@...ian.gruenbichler.email>,
	Josh Stone <jistone@...hat.com>,
	Randy Barlow <randy@...ctronsweatshop.com>,
	Anna Figueiredo Gomes <navi@...l.dev>,
	Matoro Mahri <matoro_gentoo@...oro.tk>,
	Ryan Scheel <ryan.havvy@...il.com>,
	figsoda <figsoda@...me>,
	Jörg Thalheim <joerg@...lheim.io>,
	Theodore Ni <43ngvg@...qt.com>,
	Winter <nixos@...ter.cafe>,
	William Brown <wbrown@...e.de>,
	Xiaoguang Wang <xiaoguang.wang@...e.com>,
	Andrea Righi <andrea.righi@...onical.com>,
	Zixing Liu <zixing.liu@...onical.com>,
	Nathan Chancellor <nathan@...nel.org>,
	Jonathan Corbet <corbet@....net>,
	workflows@...r.kernel.org,
	linux-doc@...r.kernel.org
Subject: [PATCH v2 13/13] docs: rust: quick-start: add section on Linux distributions

Now that we are starting to support several Rust compiler and `bindgen`
versions, there is a good chance some Linux distributions work out of
the box.

Thus, provide some instructions on how to set the toolchain up for a
few major Linux distributions. This simplifies the setup users need to
build the kernel.

In addition, add an introduction to the document so that it is easier
to understand its structure and move the LLVM+Rust kernel.org toolchains
paragraph there (removing "depending on the Linux version"). We may want
to reorganize the document or split it in the future, but I wanted to
focus this commit on the new information added about each particular
distribution.

Finally, remove the `rustup`'s components mention in `changes.rst` since
users do not need it if they install the toolchain via the distributions
(and anyway it was too detailed for that main document).

Cc: Jan Alexander Steffens <heftig@...hlinux.org>
Cc: Johannes Löthberg <johannes@...iasis.com>
Cc: Fabian Grünbichler <debian@...ian.gruenbichler.email>
Cc: Josh Stone <jistone@...hat.com>
Cc: Randy Barlow <randy@...ctronsweatshop.com>
Cc: Anna (navi) Figueiredo Gomes <navi@...l.dev>
Cc: Matoro Mahri <matoro_gentoo@...oro.tk>
Cc: Ryan Scheel <ryan.havvy@...il.com>
Cc: figsoda <figsoda@...me>
Cc: Jörg Thalheim <joerg@...lheim.io>
Cc: Theodore Ni <43ngvg@...qt.com>
Cc: Winter <nixos@...ter.cafe>
Cc: William Brown <wbrown@...e.de>
Cc: Xiaoguang Wang <xiaoguang.wang@...e.com>
Cc: Andrea Righi <andrea.righi@...onical.com>
Cc: Zixing Liu <zixing.liu@...onical.com>
Cc: Nathan Chancellor <nathan@...nel.org>
Tested-by: Benno Lossin <benno.lossin@...ton.me>
Tested-by: Andreas Hindborg <a.hindborg@...sung.com>
Signed-off-by: Miguel Ojeda <ojeda@...nel.org>
---
v2:
  - Add openSUSE Slowroll.
  - Update openSUSE docs: both Slowroll and Tumbleweed now provide
    `rustfmt`, Clippy and the Rust standard library sources, so the
    comment about those can be dropped. (William)
  - I ended up leaving the Debian/Ubuntu docs as-is for the time being.
    Happy to get a patch for that later. We should definitely add them
    if they start working for the current kernel (currently: Ubuntu's
    latest versioned package is 1.76, and Debian's `web` one is 1.70).
    (Andrea, Fabian)
  - Move the LLVM+Rust kernel.org toolchains paragraph to the
    introduction that this commit adds, now that we have access to that
    paragraph since the series is rebased on top of `rust-next`.
  - Use plural for "release".

 Documentation/process/changes.rst  |  5 --
 Documentation/rust/quick-start.rst | 93 ++++++++++++++++++++++++++----
 2 files changed, 81 insertions(+), 17 deletions(-)

diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
index 0d0b7120792b..0ce96ae2588c 100644
--- a/Documentation/process/changes.rst
+++ b/Documentation/process/changes.rst
@@ -90,11 +90,6 @@ Rust (optional)

 A recent version of the Rust compiler is required.

-Each Rust toolchain comes with several "components", some of which are required
-(like ``rustc``) and some that are optional. The ``rust-src`` component (which
-is optional) needs to be installed to build the kernel. Other components are
-useful for developing.
-
 Please see Documentation/rust/quick-start.rst for instructions on how to
 satisfy the build requirements of Rust support. In particular, the ``Makefile``
 target ``rustavailable`` is useful to check why the Rust toolchain may not
diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst
index 66cefbab8f9a..d06a36106cd4 100644
--- a/Documentation/rust/quick-start.rst
+++ b/Documentation/rust/quick-start.rst
@@ -5,24 +5,93 @@ Quick Start

 This document describes how to get started with kernel development in Rust.

+There are a few ways to install a Rust toolchain needed for kernel development.
+A simple way is to use the packages from your Linux distribution if they are
+suitable -- the first section below explains this approach. An advantage of this
+approach is that, typically, the distribution will match the LLVM used by Rust
+and Clang.
+
+Another way is using the prebuilt stable versions of LLVM+Rust provided on
+`kernel.org <https://kernel.org/pub/tools/llvm/rust/>`_. These are the same slim
+and fast LLVM toolchains from :ref:`Getting LLVM <getting_llvm>` with versions
+of Rust added to them that Rust for Linux supports. Two sets are provided: the
+"latest LLVM" and "matching LLVM" (please see the link for more information).
+
+Alternatively, the next two "Requirements" sections explain each component and
+how to install them through ``rustup``, the standalone installers from Rust
+and/or building them.
+
+The rest of the document explains other aspects on how to get started.
+
+
+Distributions
+-------------
+
+Arch Linux
+**********
+
+Arch Linux provides recent Rust releases and thus it should generally work out
+of the box, e.g.::
+
+	pacman -S rust rust-src rust-bindgen
+
+
+Debian
+******
+
+Debian Unstable (Sid), outside of the freeze period, provides recent Rust
+releases and thus it should generally work out of the box, e.g.::
+
+	apt install rustc rust-src bindgen rustfmt rust-clippy
+
+
+Fedora Linux
+************
+
+Fedora Linux provides recent Rust releases and thus it should generally work out
+of the box, e.g.::
+
+	dnf install rust rust-src bindgen-cli rustfmt clippy
+
+
+Gentoo Linux
+************
+
+Gentoo Linux (and especially the testing branch) provides recent Rust releases
+and thus it should generally work out of the box, e.g.::
+
+	USE='rust-src rustfmt clippy' emerge dev-lang/rust dev-util/bindgen
+
+``LIBCLANG_PATH`` may need to be set.
+
+
+Nix
+***
+
+Nix (unstable channel) provides recent Rust releases and thus it should
+generally work out of the box, e.g.::
+
+	{ pkgs ? import <nixpkgs> {} }:
+	pkgs.mkShell {
+	  nativeBuildInputs = with pkgs; [ rustc rust-bindgen rustfmt clippy ];
+	  RUST_LIB_SRC = "${pkgs.rust.packages.stable.rustPlatform.rustLibSrc}";
+	}
+
+
+openSUSE
+********
+
+openSUSE Slowroll and openSUSE Tumbleweed provide recent Rust releases and thus
+they should generally work out of the box, e.g.::
+
+	zypper install rust rust1.79-src rust-bindgen clang
+

 Requirements: Building
 ----------------------

 This section explains how to fetch the tools needed for building.

-Some of these requirements might be available from Linux distributions
-under names like ``rustc``, ``rust-src``, ``rust-bindgen``, etc. However,
-at the time of writing, they are likely not to be recent enough unless
-the distribution tracks the latest releases.
-
-Prebuilt stable versions of LLVM+Rust are provided on `kernel.org
-<https://kernel.org/pub/tools/llvm/rust/>`_. These are the same slim and fast
-LLVM toolchains from :ref:`Getting LLVM <getting_llvm>` with versions of Rust
-added to them that Rust for Linux supports, depending on the Linux version. Two
-sets are provided: the "latest LLVM" and "matching LLVM" (please see the link
-for more information).
-
 To easily check whether the requirements are met, the following target
 can be used::

--
2.45.2

Powered by blists - more mailing lists