Add rustc-guide as a submodule by mark-i-m · Pull Request #56148 · rust-lang/rust

mark-i-m · 2018-11-22T01:01:13Z

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

rust-highfive · 2018-11-22T01:01:23Z

⚠️Warning⚠️

These commits modify submodules.

mark-i-m · 2018-11-22T01:02:11Z

cc #56079

rust-highfive · 2018-11-22T01:16:16Z

The job x86_64-gnu-llvm-5.0 of your PR failed on Travis (raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log.

travis_time:end:0f9ed180:start=1542848564734308315,finish=1542848565870466954,duration=1136158639
$ git checkout -qf FETCH_HEAD
travis_fold:end:git.checkout
Encrypted environment variables have been removed for security reasons.
See https://docs.travis-ci.com/user/pull-requests/#Pull-Requests-and-Security-Restrictions
$ export SCCACHE_BUCKET=rust-lang-ci-sccache2
$ export SCCACHE_REGION=us-west-1
Setting environment variables from .travis.yml
$ export IMAGE=x86_64-gnu-llvm-5.0
---
[00:00:00] rm 'src/doc/rust-by-example'
[00:00:00] Attempting with retry: sh -c rm -f download-src-doc-rust-by-example.tar.gz && curl -sSL -o download-src-doc-rust-by-example.tar.gz https://github.com/rust-lang/rust-by-example/archive/2ce92beabb912d417a7314d6da83ac9b50dc2afb.tar.gz
[00:00:00] rm 'src/llvm-emscripten'
[00:00:00] Attempting with retry: sh -c rm -f download-src-llvm-emscripten.tar.gz && curl -sSL -o download-src-llvm-emscripten.tar.gz https://github.com/rust-lang/llvm/archive/7f23313edff8beccb3fe44b815714269c5124c15.tar.gz
[00:00:00] Attempting with retry: sh -c git submodule deinit -f src/tools/rust-installer src/liblibc src/doc/nomicon src/tools/cargo src/doc/reference src/tools/rls src/libcompiler_builtins src/tools/clippy src/tools/rustfmt src/tools/miri src/dlmalloc src/stdsimd src/tools/lld src/libbacktrace src/tools/lldb src/tools/clang src/doc/rustc-guide && git submodule sync && git submodule update -j 16 --init --recursive src/tools/rust-installer src/liblibc src/doc/nomicon src/tools/cargo src/doc/reference src/tools/rls src/libcompiler_builtins src/tools/clippy src/tools/rustfmt src/tools/miri src/dlmalloc src/stdsimd src/tools/lld src/libbacktrace src/tools/lldb src/tools/clang src/doc/rustc-guide
[00:00:00] Cleared directory 'src/doc/nomicon'
[00:00:00] Cleared directory 'src/doc/reference'
[00:00:00] Cleared directory 'src/doc/rustc-guide'
[00:00:00] Cleared directory 'src/libbacktrace'
---
[00:00:00] Cleared directory 'src/tools/rustfmt'
[00:00:00] Submodule 'src/dlmalloc' (https://github.com/alexcrichton/dlmalloc-rs.git) registered for path 'src/dlmalloc'
[00:00:00] Submodule 'src/doc/nomicon' (https://github.com/rust-lang-nursery/nomicon.git) registered for path 'src/doc/nomicon'
[00:00:00] Submodule 'src/doc/reference' (https://github.com/rust-lang-nursery/reference.git) registered for path 'src/doc/reference'
[00:00:00] Submodule 'src/doc/rustc-guide' (https://github.com/rust-lang-nursery/rustc-guide.git) registered for path 'src/doc/rustc-guide'
[00:00:00] Submodule 'src/libcompiler_builtins' (https://github.com/rust-lang-nursery/compiler-builtins.git) registered for path 'src/libcompiler_builtins'
[00:00:00] Submodule 'src/liblibc' (https://github.com/rust-lang/libc.git) registered for path 'src/liblibc'
[00:00:00] Submodule 'src/stdsimd' (https://github.com/rust-lang-nursery/stdsimd.git) registered for path 'src/stdsimd'
[00:00:00] Submodule 'src/tools/cargo' (https://github.com/rust-lang/cargo.git) registered for path 'src/tools/cargo'
---
[00:00:01] Cloning into '/home/travis/build/rust-lang/rust/src/tools/rust-installer'...
[00:00:01] Cloning into '/home/travis/build/rust-lang/rust/src/libcompiler_builtins'...
[00:00:01] Cloning into '/home/travis/build/rust-lang/rust/src/libbacktrace'...
[00:00:01] Cloning into '/home/travis/build/rust-lang/rust/src/doc/reference'...
[00:00:02] Cloning into '/home/travis/build/rust-lang/rust/src/doc/rustc-guide'...
[00:00:02] Cloning into '/home/travis/build/rust-lang/rust/src/tools/miri'...
[00:00:02] Cloning into '/home/travis/build/rust-lang/rust/src/liblibc'...
[00:00:06] Cloning into '/home/travis/build/rust-lang/rust/src/stdsimd'...
[00:00:06] Cloning into '/home/travis/build/rust-lang/rust/src/tools/rustfmt'...
---
[00:00:53] Cloning into '/home/travis/build/rust-lang/rust/src/tools/lldb'...
[00:00:53] Submodule path 'src/dlmalloc': checked out 'c99638dc2ecfc750cc1656f6edb2bd062c1e0981'
[00:00:53] Submodule path 'src/doc/nomicon': checked out 'f8a4e96feb2e5a6ed1ef170ad40e3509a7755cb4'
[00:00:53] Submodule path 'src/doc/reference': checked out '60077efda319c95a89fe39609803c5433567adbf'
[00:00:53] Submodule path 'src/doc/rustc-guide': checked out 'fe35892c7878418ba08f6c2c6bd2e45d604f39ea'
[00:00:53] Submodule path 'src/libcompiler_builtins': checked out '939cbca6e9d829265d6cf006d3532142a4061cd3'
[00:00:53] Submodule 'compiler-rt' (https://github.com/rust-lang/compiler-rt) registered for path 'src/libcompiler_builtins/compiler-rt'
[00:00:53] Submodule 'libm' (https://github.com/rust-lang-nursery/libm) registered for path 'src/libcompiler_builtins/libm'
[00:00:53] Cloning into '/home/travis/build/rust-lang/rust/src/libcompiler_builtins/compiler-rt'...
---
[00:03:50] travis_fold:start:tidy
travis_time:start:tidy
tidy check
[00:03:50] tidy error: /checkout/src/doc/rustc-guide/ci/check_line_lengths.sh:33: line longer than 100 chars
[00:03:51] some tidy checks failed
[00:03:51] [00:03:51] [00:03:51] command did not execute successfully: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-tools-bin/tidy" "/checkout/src" "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0/bin/cargo" "--no-vendor" "--quiet"
[00:03:51] [00:03:51] [00:03:51] failed to run: /checkout/obj/build/bootstrap/debug/bootstrap test src/tools/tidy
[00:03:51] Build completed unsuccessfully in 0:00:55
[00:03:51] Build completed unsuccessfully in 0:00:55
[00:03:51] make: *** [tidy] Error 1
[00:03:51] Makefile:79: recipe for target 'tidy' failed
The command "stamp sh -x -c "$RUN_SCRIPT"" exited with 2.
travis_time:start:106616be
$ date && (curl -fs --head https://google.com | grep ^Date: | sed 's/Date: //g' || true)
Thu Nov 22 01:06:46 UTC 2018
---
travis_time:end:0a1b5e5b:start=1542848807291175862,finish=1542848807295186031,duration=4010169
travis_fold:end:after_failure.3
travis_fold:start:after_failure.4
travis_time:start:21d72815
$ ln -s . checkout && for CORE in obj/cores/core.*; do EXE=$(echo $CORE | sed 's|obj/cores/core\.[0-9]*\.!checkout!\(.*\)|\1|;y|!|/|'); if [ -f "$EXE" ]; then printf travis_fold":start:crashlog\n\033[31;1m%s\033[0m\n" "$CORE"; gdb --batch -q -c "$CORE" "$EXE" -iex 'set auto-load off' -iex 'dir src/' -iex 'set sysroot .' -ex bt -ex q; echo travis_fold":"end:crashlog; fi; done || true
travis_fold:end:after_failure.4
travis_fold:start:after_failure.5
travis_time:start:0aafcc64
travis_time:start:0aafcc64
$ cat ./obj/build/x86_64-unknown-linux-gnu/native/asan/build/lib/asan/clang_rt.asan-dynamic-i386.vers || true
cat: ./obj/build/x86_64-unknown-linux-gnu/native/asan/build/lib/asan/clang_rt.asan-dynamic-i386.vers: No such file or directory
travis_fold:end:after_failure.5
travis_fold:start:after_failure.6
travis_time:start:0544a40f
$ dmesg | grep -i kill

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 @TimNN. (Feature Requests)

mark-i-m · 2018-11-22T01:20:21Z

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

steveklabnik · 2018-11-22T11:01:07Z

should I change tidy to not check this module?

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.

e.g. do we ever want to move it out of the nursery?

The nursery is on its way out, so this will happen regardless.

mark-i-m · 2018-11-22T15:11:29Z

Generally, the book should be fixed, not make exceptions in tidy.

The only lines longer than 100 characters are links and the script... does today currently account for this?

That said, this one might be okay, as it's for a shell script, not for the contents itself.

Lol. Ironically, it is the script we use to check that lines are <=100 chars :P

The nursery is on its way out, so this will happen regardless.

So we should wait or no?

steveklabnik · 2018-11-22T19:21:46Z

@nrc how soon is the nursery move happening?

nrc · 2018-11-26T02:22:47Z

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

mark-i-m · 2018-11-26T03:29:43Z

Thanks! I will fix this up sometime this week :)

mark-i-m · 2018-11-26T18:05:36Z

It looks like tidy is now passing :)

nikomatsakis · 2018-11-26T19:59:52Z

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

mark-i-m · 2018-11-26T20:12:05Z

@nikomatsakis That would be great :)

mark-i-m · 2018-11-26T20:13:33Z

Would Travis need to be updated too?

nikomatsakis · 2018-11-26T20:14:58Z

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

nikomatsakis · 2018-11-26T20:16:08Z

PS @mark-i-m I invited you to be an admin, you may wish to confirm at this page

mark-i-m · 2018-11-26T20:49:45Z

there are perhaps some links that need to be updated for this?

Yep, I will open a PR for that.

Regarding travis, I don't know what update you are contemplating.

Mostly I'm wondering if we need to re-setup CI.

PS @mark-i-m I invited you to be an admin, you may wish to confirm at this page

Thank you 😄

mark-i-m · 2018-11-26T20:56:58Z

Ok, I updated the submodule path in this PR. I can open issues on the rustc-guide repo if we come across problems.

nrc · 2018-11-26T20:58:33Z

Mostly I'm wondering if we need to re-setup CI.

Yes, you will need to do this.

I have created a redirect for the Pages site.

nikomatsakis · 2018-11-26T20:59:58Z

Travis seems to be re-enabled:

https://travis-ci.org/rust-lang/rustc-guide

Not sure what that error is about though, perhaps relevant.

mark-i-m · 2018-11-26T21:05:17Z

Opened #56257

There is also a link in the reference that needs to be updated, but I have to go now...

mark-i-m · 2018-11-26T21:06:36Z

Not sure what that error is about though, perhaps relevant.

It looks like there was a non-relative link somewhere...

mark-i-m · 2018-11-26T21:10:22Z

rust-lang/rustc-dev-guide#242

mark-i-m · 2018-11-27T03:07:45Z

@nikomatsakis I think this should be ready now. The guide CI is passing again, and I opened #56257 to fix links in this repo.

nikomatsakis · 2018-11-27T16:54:41Z

@bors r+ rollup

bors · 2018-11-27T16:54:42Z

📌 Commit a1865ed has been approved by nikomatsakis

nikomatsakis · 2018-11-27T16:55:11Z

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?

alexcrichton · 2018-11-27T17:23:50Z

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?

steveklabnik · 2018-11-27T18:02:18Z

It's not really what's ultimately intended, but it's easy enough to add after.

mark-i-m · 2018-11-27T18:58:16Z

There end goal will be to do some link checking with something like toolstate... but for now, just adding it is a good step.

@nikomatsakis

…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

@nikomatsakis

…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

@ghost

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

rust-highfive assigned nikomatsakis Nov 22, 2018

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 22, 2018

mark-i-m mentioned this pull request Nov 26, 2018
make the line-length script respect 100 char limit XD rust-lang/rustc-dev-guide#240
Merged

mark-i-m force-pushed the rustc-guide-submodule branch from 60ed665 to cd909b8Compare November 26, 2018 17:15

Add rustc-guide as a submodule
a1865ed

mark-i-m force-pushed the rustc-guide-submodule branch from cd909b8 to a1865edCompare November 26, 2018 20:56

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 Nov 27, 2018

emilyalbini mentioned this pull request Nov 28, 2018
Rollup of 29 pull requests #56325
Closed

GuillaumeGomez mentioned this pull request Nov 29, 2018
Rollup of 22 pull requests #56340
Merged

bors merged commit a1865ed into rust-lang:masterNov 29, 2018

mark-i-m deleted the rustc-guide-submodule branch January 4, 2019 00:43

Uh oh!

Uh oh!

Conversation

mark-i-m commented Nov 22, 2018

Uh oh!

rust-highfive commented Nov 22, 2018

Uh oh!

mark-i-m commented Nov 22, 2018

Uh oh!

rust-highfive commented Nov 22, 2018

Uh oh!

mark-i-m commented Nov 22, 2018

Uh oh!

steveklabnik commented Nov 22, 2018

Uh oh!

mark-i-m commented Nov 22, 2018

Uh oh!

steveklabnik commented Nov 22, 2018

Uh oh!

nrc commented Nov 26, 2018

Uh oh!

mark-i-m commented Nov 26, 2018

Uh oh!

mark-i-m commented Nov 26, 2018

Uh oh!

nikomatsakis commented Nov 26, 2018

Uh oh!

mark-i-m commented Nov 26, 2018

Uh oh!

mark-i-m commented Nov 26, 2018

Uh oh!

nikomatsakis commented Nov 26, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nikomatsakis commented Nov 26, 2018

Uh oh!

mark-i-m commented Nov 26, 2018

Uh oh!

mark-i-m commented Nov 26, 2018

Uh oh!

nrc commented Nov 26, 2018

Uh oh!

nikomatsakis commented Nov 26, 2018

Uh oh!

mark-i-m commented Nov 26, 2018

Uh oh!

mark-i-m commented Nov 26, 2018

Uh oh!

mark-i-m commented Nov 26, 2018

Uh oh!

mark-i-m commented Nov 27, 2018

Uh oh!

nikomatsakis commented Nov 27, 2018

Uh oh!

bors commented Nov 27, 2018

Uh oh!

nikomatsakis commented Nov 27, 2018

Uh oh!

alexcrichton commented Nov 27, 2018

Uh oh!

steveklabnik commented Nov 27, 2018

Uh oh!

mark-i-m commented Nov 27, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

nikomatsakis commented Nov 26, 2018•
edited
Loading