iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: rust: update instructions for obtaining 'core' source

Browse Source 
The source for Rust's 'core' library is needed to build the kernel with
Rust support. This sometimes needs to be obtained by hand when using a
standalone version of 'rustc' not managed by 'rustup'. Currently, the
documentation suggests cloning the 'rust' repository to obtain these
sources, but this is quite slow (on the order of a multiple minutes).

Change this documentation to suggest using the source tarball instead.
The tarball includes only needed files (<5M) and is significantly faster
to download; this is more in line with what 'rustup' does.

Also simplify wording of the relevant section.

Link: https://github.com/Rust-for-Linux/linux/pull/1024
Signed-off-by: Trevor Gross <tmgross@umich.edu>
Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Link: https://lore.kernel.org/r/20230803060437.12157-2-tmgross@umich.edu
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
This commit is contained in:
Trevor Gross 2023-08-03 02:04:36 -04:00 committed by Miguel Ojeda
parent b603c6cc40
commit 8cb40124cf
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/rust/quick-start.rst
View File

@ -56,16 +56,17 @@ If ``rustup`` is being used, run::
The components are installed per toolchain, thus upgrading the Rust compiler The components are installed per toolchain, thus upgrading the Rust compiler
version later on requires re-adding the component. version later on requires re-adding the component.
Otherwise, if a standalone installer is used, the Rust repository may be cloned Otherwise, if a standalone installer is used, the Rust source tree may be
into the installation folder of the toolchain:: downloaded into the toolchain's installation folder::
git clone --recurse-submodules \ curl -L "https://static.rust-lang.org/dist/rust-src-$(scripts/min-tool-version.sh rustc).tar.gz" |
--branch $(scripts/min-tool-version.sh rustc) \ tar -xzf - -C "$(rustc --print sysroot)/lib" \
https://github.com/rust-lang/rust \ "rust-src-$(scripts/min-tool-version.sh rustc)/rust-src/lib/" \
$(rustc --print sysroot)/lib/rustlib/src/rust --strip-components=3
In this case, upgrading the Rust compiler version later on requires manually In this case, upgrading the Rust compiler version later on requires manually
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).
libclang libclang