Skip to content

Document dist components we ship #141386

Open
0 of 1 issue completed
Open
0 of 1 issue completed
Parent:#136822
@jieyouxu

Description

@jieyouxu

E.g. #138647.

We should document:

Sub-issues

Sub-issues

0 of 1 Issues completed

Activity

added
T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
on May 22, 2025
added
needs-triageThis issue may need triage. Remove it if it has been sufficiently triaged.
on May 22, 2025
removed
needs-triageThis issue may need triage. Remove it if it has been sufficiently triaged.
on May 22, 2025
jieyouxu

jieyouxu commented on May 22, 2025

@jieyouxu
MemberAuthor

cc @Mark-Simulacrum: you might be someone who have some clues about what the purposes of the (less obvious) dist components we ship are... Are there any docs or historical discussions that you know of for them?

Mark-Simulacrum

Mark-Simulacrum commented on May 22, 2025

@Mark-Simulacrum
Member

Historical discussions are probably just in the PR(s) that landed them if anywhere. I can try to get a PR out for the steps in dist.rs in bootstrap having doc comments perhaps, as a starting point? Unless we want the docs to live elsewhere -- depends I guess how much this is externally guaranteed vs. useful for ourselves.

jieyouxu

jieyouxu commented on May 22, 2025

@jieyouxu
MemberAuthor

Yeah, part of this is I don't actually know what we do guarantee, be it external or internal (often by implicit assumptions). For instance, I think miri depends on rustc-dev, so even if it's technically "internal" it's still logistically depended upon.

cc @RalfJung is that description accurate for miri?

RalfJung

RalfJung commented on May 22, 2025

@RalfJung
Member

I don't know what you mean by "internal" vs "external", but all tools that use the rustc driver depend on rustc-dev -- we have some of those in-tree (Miri, clippy), and there's plenty more out-of-tree (e.g. all the verification tools, minirust, and I guess klint as well).

jieyouxu

jieyouxu commented on May 22, 2025

@jieyouxu
MemberAuthor

I don't know what you mean by "internal" vs "external", but all tools that use the rustc driver depend on rustc-dev -- we have some of those in-tree (Miri, clippy), and there's plenty more out-of-tree (e.g. all the verification tools, minirust, and I guess klint as well).

I don't think the distinction matters that much tbh, since if the rustc-dev component breaks our toolchain breaks (let alone other out-of-tree tools that depend on it) so...

ehuss

ehuss commented on May 22, 2025

@ehuss
Contributor

The components are lightly documented at https://rust-lang.github.io/rustup/concepts/components.html.

Things like llvm-tools was accidentally "stabilized" due to a bug, and how people were using it. There are more questions and context in #85658, but so far the compiler team has not been able to answer the questions about it.

added
T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.
T-releaseRelevant to the release subteam, which will review and decide on the PR/issue.
on May 22, 2025
added
C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFC
on May 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-dist-componentsArea: dist components, e.g. `rustc-dev`, `rustc-src`, etc.A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCT-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.T-releaseRelevant to the release subteam, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Development

    No branches or pull requests

      Participants

      @ehuss@RalfJung@Mark-Simulacrum@jieyouxu@rustbot

      Issue actions

        Document dist components we ship · Issue #141386 · rust-lang/rust