Skip to content

build_helper isn't documented in the rustc internal docs #130355

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
Closed
lolbinarycat opened this issue Sep 14, 2024 · 1 comment · Fixed by #130420
Closed

build_helper isn't documented in the rustc internal docs #130355

lolbinarycat opened this issue Sep 14, 2024 · 1 comment · Fixed by #130420
Assignees
@jieyouxu
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Comments

@lolbinarycat
Copy link
Contributor

Location

https://doc.rust-lang.org/nightly/nightly-rustc

Summary

the build_helper crate is not documented. this makes working on things like bootstrap more difficult. it is not used by the compiler directly, but neither is run_make_support, which is documented.
@lolbinarycat lolbinarycat added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Sep 14, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Sep 14, 2024
@jieyouxu jieyouxu added the T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) label Sep 15, 2024
@jieyouxu
Copy link
Member

This needs a doc step in bootstrap, previously Chris (I think?) added doc step for run_make_support which is why that exists.

@jieyouxu jieyouxu added C-enhancement Category: An issue proposing an enhancement or a PR with one. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Sep 15, 2024
@jieyouxu jieyouxu self-assigned this Sep 16, 2024
@jieyouxu jieyouxu mentioned this issue Sep 16, 2024
Merged
@bors bors closed this as completed in f64d1c1 Sep 16, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Sep 16, 2024
@rust-timer
Unrolled build for rust-lang#130420
cefb217 
Rollup merge of rust-lang#130420 - jieyouxu:build_helpers_docs, r=onur-ozkan

Register tool docs for `src/tools/build_helper`

Fixes rust-lang#130355.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jieyouxu jieyouxu

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Register tool docs for src/tools/build_helper jieyouxu/rust
3 participants
@lolbinarycat @jieyouxu @rustbot