Add rustc-guide as a submodule #56148
Conversation
|
rust-highfive
added
the
S-waiting-on-review
|
cc #56079 |
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
|
CI is complaining that some lines are longer than 100 chars.... should I change tidy to not check this module? After all, we already run our own CI... |
Generally, the book should be fixed, not make exceptions in tidy. That said, this one might be okay, as it's for a shell script, not for the contents itself.
The nursery is on its way out, so this will happen regardless. |
The only lines longer than 100 characters are links and the script... does today currently account for this?
Lol. Ironically, it is the script we use to check that lines are <=100 chars :P
So we should wait or no? |
|
@nrc how soon is the nursery move happening? |
The move has started - I did a few repos as a kind of trial run. I intend to a batch at a time as we go along. Feel free to move any you want sooner rather than later. |
|
Thanks! I will fix this up sometime this week :) |
mark-i-m
force-pushed
the
rustc-guide-submodule
branch
from
60ed665
to
cd909b8
Compare
|
It looks like tidy is now passing :) |
|
@mark-i-m I'm game to land this, but it's also fine to move the rustc-guide to rust-lang sooner rather than later I imagine. Github actually does a good job keeping links. Do you want me to do that move? |
|
@nikomatsakis That would be great :) |
|
Would Travis need to be updated too? |
|
@mark-i-m done (e.g., rendered content is now at https://rust-lang.github.io/rustc-guide/) -- there are perhaps some links that need to be updated for this? Regarding travis, I don't know what update you are contemplating. |
Yep, I will open a PR for that.
Mostly I'm wondering if we need to re-setup CI.
Thank you 😄 |
mark-i-m
force-pushed
the
rustc-guide-submodule
branch
from
cd909b8
to
a1865ed
Compare
|
Ok, I updated the submodule path in this PR. I can open issues on the rustc-guide repo if we come across problems. |
Yes, you will need to do this. I have created a redirect for the Pages site. |
|
Travis seems to be re-enabled: https://travis-ci.org/rust-lang/rustc-guide Not sure what that error is about though, perhaps relevant. |
|
Opened #56257 There is also a link in the reference that needs to be updated, but I have to go now... |
It looks like there was a non-relative link somewhere... |
|
@nikomatsakis I think this should be ready now. The guide CI is passing again, and I opened #56257 to fix links in this repo. |
|
@bors r+ rollup |
|
📌 Commit a1865ed has been approved by |
bors
added
S-waiting-on-bors
|
one question for the @rust-lang/infra team -- I know that in the buildup to a release, we prevent breaking tools. Presumably that policy is per-submodule, and would not apply here? |
|
We can configure it how we like I think, it's possible to block releases on this submodule building and/or not do that at all. It looks like though the submodule isn't integrated into rustbuild, so I think this PR is simply adding it and nothing will happen with it, but is that intended? |
|
It's not really what's ultimately intended, but it's easy enough to add after. |
|
There end goal will be to do some link checking with something like toolstate... but for now, just adding it is a good step. |
…ikomatsakis Add rustc-guide as a submodule Adding this as a submodule will allow two things: - Linking to the guide from doc.rlo - Doing a link check as part of the rust CI build Key question: Do we want to wait for the book to be filled out more? e.g. do we ever want to move it out of the nursery? r? @nikomatsakis cc @steveklabnik
…ikomatsakis Add rustc-guide as a submodule Adding this as a submodule will allow two things: - Linking to the guide from doc.rlo - Doing a link check as part of the rust CI build Key question: Do we want to wait for the book to be filled out more? e.g. do we ever want to move it out of the nursery? r? @nikomatsakis cc @steveklabnik
Rollup of 22 pull requests Successful merges: - #55391 (bootstrap: clean up a few clippy findings) - #56021 (avoid features_untracked) - #56023 (atomic::Ordering: Get rid of misleading parts of intro) - #56080 (Reduce the amount of bold text at doc.rlo) - #56114 (Enclose type in backticks for "non-exhaustive patterns" error) - #56124 (Fix small doc mistake on std::io::read::read_to_end) - #56127 (Update an outdated comment in mir building) - #56148 (Add rustc-guide as a submodule) - #56149 (Make std::os::unix/linux::fs::MetadataExt::a/m/ctime* documentation clearer) - #56220 (Suggest appropriate place for lifetime when declared after type arguments) - #56223 (Make JSON output from -Zprofile-json valid) - #56236 (Remove unsafe `unsafe` inner function.) - #56255 (Update outdated code comments in StringReader) - #56257 (rustc-guide has moved to rust-lang/) - #56273 (Add missing doc link) - #56289 (Fix small typo in comment of thread::stack_size) - #56294 (Fix a typo in the documentation of std::ffi) - #56312 (Deduplicate literal -> constant lowering) - #56319 (fix futures creating aliasing mutable and shared ref) - #56321 (rustdoc: add bottom margin spacing to nested lists) - #56322 (resolve: Fix false-positives from lint `absolute_paths_not_starting_with_crate`) - #56330 (Clean up span in non-trailing `..` suggestion) Failed merges: r? @ghost
Adding this as a submodule will allow two things:
Key question: Do we want to wait for the book to be filled out more? e.g. do we ever want to move it out of the nursery?
r? @nikomatsakis
cc @steveklabnik