docs: rust: update instructions for obtaining 'core' source
authorTrevor Gross <tmgross@umich.edu>
Thu, 3 Aug 2023 06:04:36 +0000 (02:04 -0400)
committerMiguel Ojeda <ojeda@kernel.org>
Sun, 20 Aug 2023 21:16:39 +0000 (23:16 +0200)
commit8cb40124cf923d4627d2e29b84dbff72e41fa0ef
tree88b8b229024c763230e27c4cec06f5ee9ae79d2f
parentb603c6cc405a1c25e84d9621ec05115ed63ff8b8
docs: rust: update instructions for obtaining 'core' 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>
Documentation/rust/quick-start.rst