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.

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

bootstrap: document tidy #108984

Merged
merged 1 commit into from
Mar 12, 2023
Merged

bootstrap: document tidy #108984

merged 1 commit into from
Mar 12, 2023

Conversation

Teapot4195
Copy link
Contributor

Enable documentation of tidy, as suggested in #106803. Jyn mentioned they should probably be added to doc.rust-lang.org, how should that be done?

@rustbot
Copy link
Collaborator

rustbot commented Mar 10, 2023

r? @ozkanonur

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Mar 10, 2023
@jyn514
Copy link
Member

jyn514 commented Mar 10, 2023

Jyn mentioned they should probably be added to doc.rust-lang.org, how should that be done?

rust/src/bootstrap/dist.rs

Lines 143 to 152 in d583342

/// Builds the `rustc-docs` installer component.
fn run(self, builder: &Builder<'_>) -> Option<GeneratedTarball> {
let host = self.host;
builder.default_doc(&[]);
let mut tarball = Tarball::new(builder, "rustc-docs", &host.triple);
tarball.set_product_name("Rustc Documentation");
tarball.add_bulk_dir(&builder.compiler_doc_out(host), "share/doc/rust/html/rustc");
Some(tarball.generate())
}
is the step that generates those docs - if you run x dist rustc-docs and these show up in the tarball, they should show up on the website as well.

@albertlarsan68
Copy link
Member

Is it also where the homepage is stored?

@jyn514
Copy link
Member

jyn514 commented Mar 10, 2023

https://doc.rust-lang.org/nightly/nightly-rustc/ is generated at

.arg("--index-page")

https://doc.rust-lang.org/nightly/ does not have a list of crates. https://doc.rust-lang.org/ is a redirect to https://www.rust-lang.org/learn.

Copy link
Member

@onur-ozkan onur-ozkan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

We should document these just like others, but it's out of scope for this PR.

2023-03-11_10-31

@onur-ozkan
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Mar 11, 2023

📌 Commit 29b0bef has been approved by ozkanonur

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 11, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 11, 2023
…anonur

bootstrap: document tidy

Enable documentation of tidy, as suggested in rust-lang#106803. Jyn mentioned they should probably be added to `doc.rust-lang.org`, how should that be done?
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 12, 2023
…anonur

bootstrap: document tidy

Enable documentation of tidy, as suggested in rust-lang#106803. Jyn mentioned they should probably be added to `doc.rust-lang.org`, how should that be done?
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 12, 2023
…iaskrgr

Rollup of 9 pull requests

Successful merges:

 - rust-lang#108726 (tidy: enforce comment blocks to have an even number of backticks)
 - rust-lang#108797 (Allow binary files to go through the `FileLoader`)
 - rust-lang#108841 (Add suggestion to diagnostic when user has array but trait wants slice. (rebased))
 - rust-lang#108984 (bootstrap: document tidy)
 - rust-lang#109013 (Give proper error message when tcx wasn't passed to decoder)
 - rust-lang#109017 (remove duplicated calls to sort_string)
 - rust-lang#109018 (Expand on the allocator comment in `rustc-main`)
 - rust-lang#109028 (Add eslint checks for rustdoc-js tester)
 - rust-lang#109034 (Commit some tests for the new solver + lazy norm)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 0b0f334 into rust-lang:master Mar 12, 2023
@rustbot rustbot added this to the 1.70.0 milestone Mar 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants