Add compiler docs testing to CI. #46278

MaloJaffre · 2017-11-26T16:50:42Z

Fixes #47025.
I don't know if x86_64-gnu is the right builder for this, but there seems to be time left on Travis.

Remaining problems blocking this PR:

See individual commits for more details.

rust-highfive · 2017-11-26T16:50:54Z

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

MaloJaffre · 2017-11-26T18:29:13Z

Currently failing (probably #46271): https://travis-ci.org/rust-lang/rust/jobs/307535449#L6794-L6818.
At least that shows that the compiler docs are properly tested with this PR.

Michael-F-Bryan · 2017-11-27T00:16:13Z

@MaloJaffre, is this part of an overall fix for #29893?

MaloJaffre · 2017-11-28T18:03:42Z

@Michael-F-Bryan No, because I haven't read this issue before opening this PR, but it is a step forward, because, in the meantime, we can catch regressions of compiler docs building.

kennytm · 2017-12-01T20:36:28Z

The fix for issue #46271 is PR #46405. Marking as S-blocked until that PR is merged.

MaloJaffre · 2017-12-03T15:46:09Z

Restarting CI to see if it passes, now that #46405 has been merged.

MaloJaffre · 2017-12-03T17:49:36Z

Now it's a lot of broken links in syntax, syntax_pos and rustc that failed the build!

EDIT: it seems that these are intended to be links to std docs, but they reference their own crates instead.

carols10cents · 2017-12-12T14:48:26Z

Friendly ping to keep this on your radar, @MaloJaffre! How's it going?

MaloJaffre · 2017-12-12T18:25:46Z

@carols10cents I'm currently trying to understand why the links are broken, but it's not very successful...

steveklabnik · 2017-12-12T19:47:05Z

It depends per link; some of these point to a README.md, for example, which isn't actually rendered. Those links should be removed. Some of them might be broken due to re-exporting things, that is, if a link is put into something that's re-exported, it often breaks the link in one place since you can't write two different links for the same thing. You have to take it on a case-by-case basis.

Unblocks rust-lang/rust#46278.

MaloJaffre · 2017-12-13T20:13:47Z

~~After further investigation, this PR is blocked by:~~ (EDIT: see PR description)
~~- rust-random/rand#207 and release of rand 0.3.19~~
~~- issue #32129 (syntax::symbol::InternedString derefs to &str)~~

Meanwhile, I will fix the other broken links that are really in compiler docs.

steveklabnik · 2017-12-13T20:20:27Z

The solution to the second one, for now, is just to remove the link.

MaloJaffre · 2017-12-15T17:05:44Z

@steveklabnik Did you mean to add doc(hidden) to the Deref impl for InternedString and others? I'm not sure it's a good idea to remove the links in &str docs which are broken when items implement Deref<Target=str>.

kennytm · 2017-12-31T14:55:58Z

src/librustc/dep_graph/graph.rs

@@ -158,7 +158,7 @@ impl DepGraph {
    /// what state they have access to. In particular, we want to
    /// prevent implicit 'leaks' of tracked state into the task (which
    /// could then be read without generating correct edges in the
-    /// dep-graph -- see the [README] for more details on the
+    /// dep-graph -- see the module-level README for more details on the


Perhaps link the README to https://github.com/rust-lang/rust/blob/master/src/librustc/dep_graph/README.md instead of removing the link?

(Alternatively, make use of #![doc(include="README.md")] in mod.rs to display the README directly in the rustdoc. This could be another PR once we get the compiler docs into the CI.)

kennytm · 2017-12-31T14:57:31Z

src/librustc/infer/anon_types/mod.rs

-    ///    fn baz<'a, 'b>() -> impl Trait<'a, 'b> { ... }
+    /// ```
+    /// fn baz<'a, 'b>() -> impl Trait<'a, 'b> { ... }
+    /// ```


This block should be ```text?

kennytm · 2017-12-31T14:59:41Z

src/librustc/middle/region.rs

 /// ```
 /// let a = f().g( 'b: { let x = d(); let y = d(); x.h(y)  }   ) ;
 /// ```
 ///
+/// ```text


Better merge this block with the one above and make it ```text.

kennytm · 2017-12-31T15:00:31Z

src/librustc/hir/mod.rs

@@ -588,7 +588,7 @@ pub type CrateConfig = HirVec<P<MetaItem>>;
 /// The top-level data structure that stores the entire contents of
 /// the crate currently being compiled.
 ///
-/// For more details, see [the module-level README](README.md).
+/// For more details, see the module-level README.


https://github.com/rust-lang/rust/blob/master/src/librustc/hir/README.md

kennytm · 2017-12-31T15:02:28Z

src/librustc/mir/mod.rs

@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.

-//! MIR datatypes and passes. See [the README](README.md) for details.
+//! MIR datatypes and passes. See the module-level README for details.


https://github.com/rust-lang/rust/blob/master/src/librustc/mir/README.md

kennytm · 2017-12-31T15:03:31Z

src/librustc/ty/context.rs

-/// various **compiler queries** that have been performed. See [the
-/// README](README.md) for more deatils.
+/// various **compiler queries** that have been performed. See the
+/// the module-level README for more details.


https://github.com/rust-lang/rust/blob/master/src/librustc/ty/README.md

kennytm · 2017-12-31T15:05:22Z

src/librustc_mir/monomorphize/collector.rs

@@ -149,7 +149,7 @@
 //! The binary of a crate will not only contain machine code for the items
 //! defined in the source code of that crate. It will also contain monomorphic
 //! instantiations of any extern generic functions and of functions marked with
-//! #[inline].
+//! \#[inline].


Perhaps `…` it instead of \ it.

kennytm · 2017-12-31T15:05:30Z

src/librustc_mir/monomorphize/partitioning.rs

@@ -94,7 +94,7 @@
 //!   inlined, so it can distribute function instantiations accordingly. Since
 //!   there is no way of knowing for sure which functions LLVM will decide to
 //!   inline in the end, we apply a heuristic here: Only functions marked with
-//!   #[inline] are considered for inlining by the partitioner. The current
+//!   \#[inline] are considered for inlining by the partitioner. The current


kennytm · 2017-12-31T15:06:09Z

src/libsyntax/feature_gate.rs

            pub declared_stable_lang_features: Vec<(Symbol, Span)>,
-            /// #![feature] attrs for non-language (library) features
+            /// \#![feature] attrs for non-language (library) features


kennytm · 2017-12-31T15:40:22Z

src/librustc/ty/sty.rs

-    /// will be unified.
-    ///
-    /// [upvar inference]: src/librustc_typeck/check/upvar.rs
+    /// inferred. Once upvar inference (in src/librustc_typeck/check/upvar.rs)


Please backquote the path.

MaloJaffre · 2017-12-31T16:34:31Z

@kennytm Thanks for your review!
I've fixed everything according to your remarks, ~~except for the list formatting (I wasn't sure exactly how to format this part)~~.

EDIT: After checking formatting of other lists in API docs, I applied your suggested formatting.

bors · 2018-01-01T04:12:09Z

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

It tested rust-lang#44953. `log` macros in newer versions are no longer recursive, so these duplicated error messages (about unstable feature uses) previously occurring at each level of recursion are no longer possible, even with the fix by rust-lang#45540. Furthermore this test breaks when multiple versions of `log` are in the sysroot (`log 0.3.9` depends on`log 0.4.1`)

Update `rand` crate to `0.3.19`. Update `log` crate to `0.3.9` and `0.4.1`. Update `parking_lot_core` crate to `0.2.9`. Upgrade all flate2 dependencies to `1.0.1`. - Update `rust-installer` submodule.

@ollie27

As pointed out by @ollie27.

kennytm · 2018-01-01T16:21:22Z

Thanks!

@bors r+

bors · 2018-01-01T16:21:23Z

📌 Commit 2449230 has been approved by kennytm

@ollie27

Add compiler docs testing to CI. Fixes #47025. I don't know if `x86_64-gnu` is the right builder for this, but there seems to be time left on [Travis](https://travis-ci.org/rust-lang/rust/jobs/307488864). Remaining problems blocking this PR: - [x] broken links caused by rustdoc issues: - [x] `pub use self::Enum::...`: #46766 and #46767 (fixed by #47050, thanks @ollie27!) - [x] `impl Deref for DerefToStdType`: #32129 (ignored in linkchecker) - [x] `#[feature(decl_macro)]` and `use std::vec`: #47038 (ignored in linkchecker) - [x] `rustc_data_structures::sync::{Lrc, RwLock}` aliases `std` types: #32130 (ignored in linkchecker) - [x] markdown differences, in rust repository and in external crates, now failing the build with #46880 merged (all fixed) - [x] multiple crate updates needed: `rand`, `log`, `parking_lot_core`, `flate2` - [x] submodule updates needed to deduplicate dependencies: `rust-installer`, ~`cargo`~ (done by #47052) - [x] #44953 test broken by `log` update (removed, this can be controversial) - [x] Waiting `x86_64-gnu` build results ([done](https://travis-ci.org/rust-lang/rust/builds/323451069)) See individual commits for more details.

bors · 2018-01-01T16:22:37Z

⌛ Testing commit 2449230 with merge 5deba22...

bors · 2018-01-01T19:04:27Z

☀️ Test successful - status-appveyor, status-travis
Approved by: kennytm
Pushing 5deba22 to master...

rust-highfive assigned alexcrichton Nov 26, 2017

kennytm added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. labels Nov 26, 2017

MaloJaffre force-pushed the ci-compiler-docs branch from 03f5834 to 283b11a Compare November 26, 2017 16:53

kennytm added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 1, 2017

MaloJaffre closed this Dec 3, 2017

MaloJaffre reopened this Dec 3, 2017

MaloJaffre force-pushed the ci-compiler-docs branch from 283b11a to f12927f Compare December 3, 2017 15:56

kennytm added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Dec 3, 2017

MaloJaffre added a commit to MaloJaffre/rand that referenced this pull request Dec 13, 2017

Fix broken links in Rand docs (0.3 branch)

2f3fca1

Unblocks rust-lang/rust#46278.

This was referenced Dec 13, 2017

Fix broken links in Rand docs (0.3 branch) rust-random/rand#207

Merged

Broken links in String documentation from Deref impl #32129

Closed

MaloJaffre force-pushed the ci-compiler-docs branch from c6e6925 to 2912fb4 Compare December 31, 2017 13:08

MaloJaffre changed the title ~~[WIP] Add compiler docs testing to CI.~~ Add compiler docs testing to CI. Dec 31, 2017

kennytm added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Dec 31, 2017

kennytm reviewed Dec 31, 2017

View reviewed changes

MaloJaffre force-pushed the ci-compiler-docs branch from 2912fb4 to da82759 Compare December 31, 2017 16:28

MaloJaffre force-pushed the ci-compiler-docs branch from da82759 to a34ac50 Compare December 31, 2017 16:39

MaloJaffre added 6 commits January 1, 2018 14:44

Update crates and submodules to pull doc fixes

8ed13d6

Update `rand` crate to `0.3.19`. Update `log` crate to `0.3.9` and `0.4.1`. Update `parking_lot_core` crate to `0.2.9`. Upgrade all flate2 dependencies to `1.0.1`. - Update `rust-installer` submodule.

Fix broken links in internal docs

7249539

Ignore remaining broken links caused by rustdoc bugs

8395798

As pointed out by @ollie27.

Fix docs for future pulldown migration

cbb32a9

Enable compiler docs testing in x86_64-gnu

2449230

MaloJaffre force-pushed the ci-compiler-docs branch from a34ac50 to 2449230 Compare January 1, 2018 13:45

bors merged commit 2449230 into rust-lang:master Jan 1, 2018

This was referenced Jan 1, 2018

Allow runtime switching between trans backends #45684

Merged

Allow non-alphabetic underscores in camel case #46907

Merged

MaloJaffre deleted the ci-compiler-docs branch January 1, 2018 19:25

michaelwoerister mentioned this pull request Jan 3, 2018

Performance regression from seemingly harmless changeset #47154

Closed

MaloJaffre mentioned this pull request Jan 3, 2018

Cannot compile compiler docs #42866

Closed

kennytm mentioned this pull request Jan 7, 2018

Spurious appveyor 32-bit test timeouts #46903

Closed

MaloJaffre mentioned this pull request Jan 10, 2018

Try to fix a perf regression by updating log #47161

Merged

QuietMisdreavus mentioned this pull request Jan 22, 2018

Implement RFC 1946 - intra-rustdoc links #47046

Merged

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add compiler docs testing to CI. #46278

Add compiler docs testing to CI. #46278

MaloJaffre commented Nov 26, 2017 •

edited

Loading

rust-highfive commented Nov 26, 2017

MaloJaffre commented Nov 26, 2017 •

edited

Loading

Michael-F-Bryan commented Nov 27, 2017

MaloJaffre commented Nov 28, 2017 •

edited

Loading

kennytm commented Dec 1, 2017

MaloJaffre commented Dec 3, 2017 •

edited

Loading

MaloJaffre commented Dec 3, 2017 •

edited

Loading

carols10cents commented Dec 12, 2017

MaloJaffre commented Dec 12, 2017

steveklabnik commented Dec 12, 2017

MaloJaffre commented Dec 13, 2017 •

edited

Loading

steveklabnik commented Dec 13, 2017

MaloJaffre commented Dec 15, 2017 •

edited

Loading

kennytm Dec 31, 2017

kennytm Dec 31, 2017

kennytm Dec 31, 2017

kennytm Dec 31, 2017

kennytm Dec 31, 2017

kennytm Dec 31, 2017

kennytm Dec 31, 2017

kennytm Dec 31, 2017

kennytm Dec 31, 2017

kennytm Dec 31, 2017

MaloJaffre commented Dec 31, 2017 •

edited

Loading

bors commented Jan 1, 2018

kennytm commented Jan 1, 2018

bors commented Jan 1, 2018

bors commented Jan 1, 2018

bors commented Jan 1, 2018

Add compiler docs testing to CI. #46278

Add compiler docs testing to CI. #46278

Conversation

MaloJaffre commented Nov 26, 2017 • edited Loading

rust-highfive commented Nov 26, 2017

MaloJaffre commented Nov 26, 2017 • edited Loading

Michael-F-Bryan commented Nov 27, 2017

MaloJaffre commented Nov 28, 2017 • edited Loading

kennytm commented Dec 1, 2017

MaloJaffre commented Dec 3, 2017 • edited Loading

MaloJaffre commented Dec 3, 2017 • edited Loading

carols10cents commented Dec 12, 2017

MaloJaffre commented Dec 12, 2017

steveklabnik commented Dec 12, 2017

MaloJaffre commented Dec 13, 2017 • edited Loading

steveklabnik commented Dec 13, 2017

MaloJaffre commented Dec 15, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MaloJaffre commented Dec 31, 2017 • edited Loading

bors commented Jan 1, 2018

kennytm commented Jan 1, 2018

bors commented Jan 1, 2018

bors commented Jan 1, 2018

bors commented Jan 1, 2018

MaloJaffre commented Nov 26, 2017 •

edited

Loading

MaloJaffre commented Nov 26, 2017 •

edited

Loading

MaloJaffre commented Nov 28, 2017 •

edited

Loading

MaloJaffre commented Dec 3, 2017 •

edited

Loading

MaloJaffre commented Dec 3, 2017 •

edited

Loading

MaloJaffre commented Dec 13, 2017 •

edited

Loading

MaloJaffre commented Dec 15, 2017 •

edited

Loading

MaloJaffre commented Dec 31, 2017 •

edited

Loading