Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add prerequisite page #723

Merged
merged 2 commits into from
Jun 23, 2020
Merged

Add prerequisite page #723

merged 2 commits into from
Jun 23, 2020

Conversation

skade
Copy link
Contributor

@skade skade commented May 27, 2020

Fixes #722

Currently only includes instructions for Windows, I didn't have a Linux machine available.

Taken from @yoshuawuyts instructions.

Copy link
Member

@JohnTitor JohnTitor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some thoughts:

  • I'd mention this chapter in somewhere of "How to Build and Run the Compiler"
  • I'd also have a link to rust-lang/rust README since it should be up-to-date than here

Copy link
Member

@mark-i-m mark-i-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @skade! This is definitely good content to have!

src/building/prerequisites.md Outdated Show resolved Hide resolved
src/building/prerequisites.md Show resolved Hide resolved
@mark-i-m

This comment has been minimized.

@mark-i-m
Copy link
Member

mark-i-m commented Jun 3, 2020

@skade If you want, you can copy the hardware requirements section from my PR #731

src/building/prerequisites.md Show resolved Hide resolved
src/building/prerequisites.md Outdated Show resolved Hide resolved
@mark-i-m
Copy link
Member

I think I've addressed the outstanding review comments (sorry, I hope you don't mind, @skade). I accidentally referred to this page from #731, so it would be great to merge this and fix the link....

@mark-i-m
Copy link
Member

I don't understand the current CI failure...

@jyn514
Copy link
Member

jyn514 commented Jun 18, 2020

Works for me locally. Not sure what's going on in CI.

$ mdbook build
2020-06-18 19:49:22 [INFO] (mdbook::book): Book building has started
2020-06-18 19:49:22 [INFO] (mdbook::book): Running the html backend
2020-06-18 19:49:24 [INFO] (mdbook::book): Running the linkcheck backend
2020-06-18 19:49:24 [INFO] (mdbook::renderer): Invoking the "linkcheck" renderer
$

You can reproduce by adding github to the ignore list:

$ git diff
diff --git a/book.toml b/book.toml
index c342c38..f0dc6f5 100644
--- a/book.toml
+++ b/book.toml
@@ -15,6 +15,6 @@ level = 1
 
 [output.linkcheck]
 follow-web-links = true
-exclude = [ "crates\\.io", "gcc\\.godbolt\\.org", "youtube\\.com", "youtu\\.be", "dl\\.acm\\.org", "cs\\.bgu\\.ac\\.il" ]
+exclude = [ "github.com", "crates\\.io", "gcc\\.godbolt\\.org", "youtube\\.com", "youtu\\.be", "dl\\.acm\\.org", "cs\\.bgu\\.ac\\.il" ]
 cache-timeout = 86400
 warning-policy = "error"

Copy link
Member

@mark-i-m mark-i-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think CI should finally pass 🤞

Thanks @skade!

@mark-i-m mark-i-m merged commit ca55918 into rust-lang:master Jun 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Prerequisites and their setup is not documented
5 participants