Skip to content
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

Test internal docs on CI #47025

Closed
clarfonthey opened this issue Dec 26, 2017 · 1 comment · Fixed by #46278
Closed

Test internal docs on CI #47025

clarfonthey opened this issue Dec 26, 2017 · 1 comment · Fixed by #46278

Comments

@clarfonthey
Copy link
Contributor

I recently submitted #46979 because the rustdoc for rustc failed to compile, because some of the code snippets were invalid syntax.

I think that it would be reasonable to somehow test this via CI to make sure that the docs compile, even if they aren't included in the main distribution of Rust. I also think that doc tests for internal rustc stuff should be tested alongside everything else.
@clarfonthey
Copy link
Contributor Author

So I just realised that #46278 was opened for this. I'll leave this open until that's merged.

@MaloJaffre MaloJaffre mentioned this issue Dec 28, 2017
Merged
10 tasks
bors added a commit that referenced this issue Jan 1, 2018
@bors
Auto merge of #46278 - MaloJaffre:ci-compiler-docs, r=kennytm
5deba22 
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.
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add compiler docs testing to CI. MaloJaffre/rust
1 participant
@clarfonthey