From nobody Fri Sep 5 08:00:20 2025 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6562DEB64DA for ; Tue, 18 Jul 2023 06:01:46 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230517AbjGRGBp (ORCPT ); Tue, 18 Jul 2023 02:01:45 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48894 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230451AbjGRGBk (ORCPT ); Tue, 18 Jul 2023 02:01:40 -0400 Received: from germane-culhwch.relay-egress.a.mail.umich.edu (relay-egress-host.us-east-2.a.mail.umich.edu [18.217.159.240]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id ED1B810C2; Mon, 17 Jul 2023 23:01:38 -0700 (PDT) Received: from jacinth-ogre.authn-relay.a.mail.umich.edu (ip-10-0-74-216.us-east-2.compute.internal [10.0.74.216]) by germane-culhwch.relay-egress.a.mail.umich.edu with ESMTPS id 64B62716.39D52385.317E5C5C.1115286; Tue, 18 Jul 2023 01:45:58 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=umich.edu; s=relay-2018-08-29; t=1689659155; bh=WWZmjNjUdtOVY6mFV4Fs1VBGqTdLbx+K3/EPKF1ZPXI=; h=From:To:Cc:Subject:Date:In-Reply-To:References; b=l8An3RRY+vM7LBin6JUJOpFfyyUZq2wzeCxFsxZt01beyoTemTgWzfAeQoT2FyIHD 8TxpLo1D3k8NddnESMD9ZosMtr3MVUFhmbDzAjEvo+iOUB8KcrgNJJwhhcKTgU2yKb Be1M8HkTYSDFpEWTCgHwIOs7r3Xs0SDYsISxc11xbJ/o3X7HC0Uwk67QaKl1JzR9uI hERsz3tuNTBgJbpvy2zkJlN5XoWnB8GZDaTeGw55mnc8pLrLk7T/TL+TOPYntmZW7T JS4LqjNh0HGmoz3ouipZTqkH1BYO1PhBnn5MntA9dA6dn8mRXxsozAAZNau4sCYBtd hIiy6cvSYX/VQ== Authentication-Results: jacinth-ogre.authn-relay.a.mail.umich.edu; iprev=permerror policy.iprev=68.32.216.219 (unknown); auth=pass smtp.auth=tmgross Received: from localhost.localdomain (unknown [68.32.216.219]) by jacinth-ogre.authn-relay.a.mail.umich.edu with ESMTPSA id 64B62713.1A83BD55.686D6C9.46279; Tue, 18 Jul 2023 01:45:55 -0400 From: Trevor Gross To: ojeda@kernel.org, alex.gaynor@gmail.com, wedsonaf@gmail.com, boqun.feng@gmail.com, gary@garyguo.net, bjorn3_gh@protonmail.com, benno.lossin@proton.me, corbet@lwn.net Cc: linux-doc@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Trevor Gross Subject: [PATCH 1/2] docs: rust: update instructions for obtaining 'core' source Date: Tue, 18 Jul 2023 01:44:15 -0400 Message-Id: <20230718054416.861412-2-tmgross@umich.edu> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230718054416.861412-1-tmgross@umich.edu> References: <20230718054416.861412-1-tmgross@umich.edu> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" The source for Rust's 'core' library is needed to build the kernel with Rust support. This must be obtained manually when using a non-rustup install, such as when using 'rustc' from a package manager or from a standalone installer. Currently, the documentation suggests cloning the 'rust' repository to obtain these sources, but this is quite slow (on the order of a few minutes). This patch changes this documentation to suggest using the source tarball instead, which includes only needed information (<5M) and is significantly faster to download. This is more in line with what 'rustup' does. Signed-off-by: Trevor Gross Reviewed-by: Alice Ryhl Reviewed-by: Martin Rodriguez Reboredo --- Documentation/rust/quick-start.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-= start.rst index a8931512ed98..bb67deb19100 100644 --- a/Documentation/rust/quick-start.rst +++ b/Documentation/rust/quick-start.rst @@ -56,16 +56,17 @@ If ``rustup`` is being used, run:: The components are installed per toolchain, thus upgrading the Rust compil= er version later on requires re-adding the component. =20 -Otherwise, if a standalone installer is used, the Rust repository may be c= loned -into the installation folder of the toolchain:: +Otherwise, if a standalone installer is used, the Rust source tree may be +downloaded into the toolchain's installation folder:: =20 - git clone --recurse-submodules \ - --branch $(scripts/min-tool-version.sh rustc) \ - https://github.com/rust-lang/rust \ - $(rustc --print sysroot)/lib/rustlib/src/rust + curl -L https://static.rust-lang.org/dist/rust-src-$(scripts/min-tool-ver= sion.sh rustc).tar.gz | + tar -xzf - -C $(rustc --print sysroot)/lib \ + rust-src-$(scripts/min-tool-version.sh rustc)/rust-src/lib/ \ + --strip-components=3D3 =20 In this case, upgrading the Rust compiler version later on requires manual= ly -updating this clone. +updating the source tree (this can be done by removing ``$(rustc --print +sysroot)/lib/rustlib/src/rust`` then rerunning the above command). =20 =20 libclang --=20 2.34.1 From nobody Fri Sep 5 08:00:20 2025 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 791F1EB64DA for ; Tue, 18 Jul 2023 06:01:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231142AbjGRGBs (ORCPT ); Tue, 18 Jul 2023 02:01:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48900 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230491AbjGRGBl (ORCPT ); Tue, 18 Jul 2023 02:01:41 -0400 Received: from germane-culhwch.relay-egress.a.mail.umich.edu (relay-egress-host.us-east-2.a.mail.umich.edu [18.217.159.240]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9D776D1; Mon, 17 Jul 2023 23:01:40 -0700 (PDT) Received: from jacinth-ogre.authn-relay.a.mail.umich.edu (ip-10-0-74-216.us-east-2.compute.internal [10.0.74.216]) by germane-culhwch.relay-egress.a.mail.umich.edu with ESMTPS id 64B62717.11552E7.18B8CF7B.1115286; Tue, 18 Jul 2023 01:45:59 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=umich.edu; s=relay-2018-08-29; t=1689659157; bh=32KuaL9XprTSau8shHufKOsqD5/ATF/mtI1/00+YRqo=; h=From:To:Cc:Subject:Date:In-Reply-To:References; b=s9+fYcCr1NEJtujl318yCSU4k+WYadNcttOxXc/ppCJNAJYF0SlVX/nydtAY5/Brm soSuIGVL8UhFAQj8feVZSllfbzlf1dojWKZYoPDDIrtqLUE8RdTlp467T9Fjzb2mby 1bYRI24vge4lU14/E+UHmgN+T+w7PkMo56Dem+DwngdyGcEh1bU0D5IAeUPqGi22y4 pAwikZ3aqFOmMG88a/jeDHDwudAOjIQExvGjs61AqDOX6DFOcDlovZh2fkg1Ku3j36 ET1Z43nmt1Aos5/mdVC7eBejKFpzHxssAjLbaoqaD2ifXdMtc0dS7oPJ5aQCvbgvow amaotLeZB2B2Q== Authentication-Results: jacinth-ogre.authn-relay.a.mail.umich.edu; iprev=permerror policy.iprev=68.32.216.219 (unknown); auth=pass smtp.auth=tmgross Received: from localhost.localdomain (unknown [68.32.216.219]) by jacinth-ogre.authn-relay.a.mail.umich.edu with ESMTPSA id 64B62715.21F24970.53FCB6DA.46279; Tue, 18 Jul 2023 01:45:57 -0400 From: Trevor Gross To: ojeda@kernel.org, alex.gaynor@gmail.com, wedsonaf@gmail.com, boqun.feng@gmail.com, gary@garyguo.net, bjorn3_gh@protonmail.com, benno.lossin@proton.me, corbet@lwn.net Cc: linux-doc@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Trevor Gross Subject: [PATCH 2/2] docs: rust: clarify what 'rustup override' does Date: Tue, 18 Jul 2023 01:44:16 -0400 Message-Id: <20230718054416.861412-3-tmgross@umich.edu> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230718054416.861412-1-tmgross@umich.edu> References: <20230718054416.861412-1-tmgross@umich.edu> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" The behavior of 'rustup override' is not very well known. This patch is a small edit that adds details about what it does, so users have a better understanding of how it affects their system toolchain (i.e., it does not affect system toolchain and only sets a directory-specific override). Signed-off-by: Trevor Gross Reviewed-by: Alice Ryhl Reviewed-by: Martin Rodriguez Reboredo --- Documentation/rust/quick-start.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-= start.rst index bb67deb19100..700d37dcff5c 100644 --- a/Documentation/rust/quick-start.rst +++ b/Documentation/rust/quick-start.rst @@ -38,7 +38,9 @@ and run:: =20 rustup override set $(scripts/min-tool-version.sh rustc) =20 -Otherwise, fetch a standalone installer from: +This will configure your working directory to use the correct version of +``rustc`` without affecting your default toolchain. If you are not using +``rustup``, fetch a standalone installer from:: =20 https://forge.rust-lang.org/infra/other-installation-methods.html#standal= one =20 --=20 2.34.1