Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Rust documentation with workflow speed improvements #1024

Closed
wants to merge 2 commits into from
Closed

Update Rust documentation with workflow speed improvements #1024

wants to merge 2 commits into from

Commits on Jul 18, 2023

  1. 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 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 <tmgross@umich.edu>
    @tgross35
    tgross35 committed Jul 18, 2023
    Configuration menu
    Copy the full SHA
    1a61d68 View commit details
    Browse the repository at this point in the history

  2. docs: rust: clarify what 'rustup override' does 

    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 <tmgross@umich.edu>
    @tgross35
    tgross35 committed Jul 18, 2023
    Configuration menu
    Copy the full SHA
    002cac1 View commit details
    Browse the repository at this point in the history