Skip to content

bootstrap: document tidy#108984

Merged
bors merged 1 commit intorust-lang:masterfrom
Teapot4195:issue-106803-fix
Mar 12, 2023
Merged

bootstrap: document tidy#108984
bors merged 1 commit intorust-lang:masterfrom
Teapot4195:issue-106803-fix

Conversation

@Teapot4195
Copy link
Contributor

@Teapot4195 Teapot4195 commented Mar 10, 2023

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

albertlarsan68 commented Mar 10, 2023

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

rust/src/bootstrap/doc.rs

Line 352 in 4a2de63

.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.

onur-ozkan
onur-ozkan approved these changes Mar 11, 2023
View reviewed changes
Copy link
Contributor

@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
Contributor

onur-ozkan commented Mar 11, 2023

@bors r+ rollup

@bors
Copy link
Collaborator

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
@matthiaskrgr
Rollup merge of rust-lang#108984 - Teapot4195:issue-106803-fix, r=ozk…
b2384b7 
…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 matthiaskrgr mentioned this pull request Mar 11, 2023
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 12, 2023
@matthiaskrgr
Rollup merge of rust-lang#108984 - Teapot4195:issue-106803-fix, r=ozk…
05ef0bd 
…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?
This was referenced Mar 12, 2023
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 12, 2023
@bors
Auto merge of rust-lang#109043 - matthiaskrgr:rollup-genkz0e, r=matth…
24c0b81 
…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

Reviewers

1 more reviewer

@onur-ozkan onur-ozkan onur-ozkan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@onur-ozkan onur-ozkan

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

Milestone

1.70.0

Development

Successfully merging this pull request may close these issues.

6 participants

@Teapot4195 @rustbot @jyn514 @albertlarsan68 @onur-ozkan @bors