Skip to content

Build the Clippy book as part of x.py doc #98848

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Merged
merged 2 commits into from
Jul 13, 2022
Merged

Build the Clippy book as part of x.py doc #98848

merged 2 commits into from
Jul 13, 2022

Conversation

flip1995
Copy link
Member

@flip1995 flip1995 commented Jul 3, 2022

r? @ehuss since you said you would be interested in helping moving this forward.

cc @jyn514 as part of the bootstrap team.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 3, 2022
jyn514
jyn514 approved these changes Jul 3, 2022
View reviewed changes
@rust-log-analyzer

This comment has been minimized.

# to view
@rustbot
Copy link
Collaborator

rustbot commented Jul 3, 2022

Some changes occurred in src/tools/clippy

cc @rust-lang/clippy

@rust-log-analyzer

This comment has been minimized.

# to view
@bors
Copy link
Collaborator

bors commented Jul 4, 2022

☔ The latest upstream changes (presumably #98864) made this pull request unmergeable. Please resolve the merge conflicts.

@rust-log-analyzer

This comment has been minimized.

# to view
@flip1995
Copy link
Member Author

flip1995 commented Jul 4, 2022

This now passes CI and is ready for review.

@jyn514
Copy link
Member

jyn514 commented Jul 4, 2022

@bors r+

@bors
Copy link
Collaborator

bors commented Jul 4, 2022

📌 Commit 54591b8deacaf5e3493f10a7a4e3f395fac2a2f5 has been approved by jyn514

@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 Jul 4, 2022
@jyn514 jyn514 added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-clippy Area: Clippy labels Jul 4, 2022
@ehuss
Copy link
Contributor

ehuss commented Jul 4, 2022

@bors r-

Can you include clippy in the index page? Possibly somewhere around here:

rust/src/doc/index.md

Line 95 in d2074cb

The changes to rename the README.md files shouldn't be necessary. mdbook does translation of README.md to index.html. You can keep the changes if you really want. One benefit with using README is so that the source can be easily browsable on GitHub's source viewer (like https://github.com/rust-lang/rust-clippy/tree/master/book/src). That's not too important I think, so it's up to you.

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jul 4, 2022
@flip1995
Copy link
Member Author

flip1995 commented Jul 5, 2022

When using README.md as the file name, linking to to directory/index file doesn't work, see: #98848 (comment)

Building stage0 tool linkchecker (x86_64-unknown-linux-gnu)
    Finished release [optimized] target(s) in 0.14s
clippy/print.html:216: broken link - `clippy/continuous_integration/README.html`
clippy/usage.html:176: broken link - `clippy/continuous_integration/README.html`

When trying to create a link to just continuous_integration/ it complains, that index.html should be used. When using continuous_integration/README.md to link it, I get the above error.

If you have an idea how to resolve this, please let me know! I'd also prefer the README.md file names, but adapted the index.md file names like they are named in the cargo book.

Can you include clippy in the index page? Possibly somewhere around here:

WIll do.

@ehuss
Copy link
Contributor

ehuss commented Jul 5, 2022

I think if you rename the index.md files back to README.md as-is in your current PR, and change SUMMARY.md to link to README.md, everything should be fine.

It is a known bug that the readme linking is kinda wonky (rust-lang/mdBook#984). The SUMMARY.md file should be README.md, but the links between chapters inside the content need to either be index.md or index.html. The linkifier doesn't know about the README translation. I wish that could get fixed.

@flip1995
Copy link
Member Author

flip1995 commented Jul 7, 2022

This should be done now.

@jyn514
Copy link
Member

jyn514 commented Jul 7, 2022

@bors r+

@bors
Copy link
Collaborator

bors commented Jul 7, 2022

📌 Commit 665d707 has been approved by jyn514

It is now in the queue for this repository.

@bors bors removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Jul 7, 2022
@bors bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Jul 7, 2022
@GuillaumeGomez GuillaumeGomez mentioned this pull request Jul 13, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 13, 2022
@bors
Auto merge of rust-lang#99203 - GuillaumeGomez:rollup-b2re0dv, r=Guil…
ca4e394 
…laumeGomez

Rollup of 10 pull requests

Successful merges:

 - rust-lang#98789 (rustdoc-json-types: Clean up derives.)
 - rust-lang#98848 (Build the Clippy book as part of x.py doc)
 - rust-lang#99020 (check non_exhaustive attr and private fields for transparent types)
 - rust-lang#99132 (Add some autolabels for A-bootstrap and T-infra)
 - rust-lang#99148 (Clarify that [iu]size bounds were only defined for the target arch)
 - rust-lang#99152 (Use CSS variables to handle theming (part 2))
 - rust-lang#99168 (Add regression test for rust-lang#74713)
 - rust-lang#99176 (:arrow_up: rust-analyzer)
 - rust-lang#99183 (Mention rust-analyzer maintainers when `proc_macro` bridge is changed)
 - rust-lang#99185 (llvm-wrapper: adapt for LLVM API change)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 0b3644e into rust-lang:master Jul 13, 2022
@rustbot rustbot added this to the 1.64.0 milestone Jul 13, 2022
@flip1995 flip1995 deleted the clippy-book branch July 13, 2022 14:28
flip1995 pushed a commit to flip1995/rust that referenced this pull request Jul 18, 2022
@GuillaumeGomez
Rollup merge of rust-lang#98848 - flip1995:clippy-book, r=jyn514
9e2f689 
Build the Clippy book as part of x.py doc

r? ``@ehuss`` since you said you would be interested in helping moving this forward.

cc ``@jyn514`` as part of the bootstrap team.
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@jyn514 jyn514 jyn514 approved these changes

Assignees

@ehuss ehuss

Labels
A-clippy Area: Clippy A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.64.0
Development

Successfully merging this pull request may close these issues.
7 participants
@flip1995 @rust-log-analyzer @rustbot @bors @jyn514 @ehuss @rust-highfive