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

Start shipping the Cargo book #45692

Merged
merged 2 commits into from
Nov 16, 2017
Merged

Conversation

steveklabnik
Copy link
Member

Fixes #44910
Fixes #39588

See both of those bugs for more details.

@steveklabnik steveklabnik added the relnotes Marks issues that should be documented in the release notes of the next release. label Nov 1, 2017
@rust-highfive
Copy link
Collaborator

r? @alexcrichton

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

@kennytm kennytm added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 1, 2017
Copy link
Member

@alexcrichton alexcrichton left a comment

Choose a reason for hiding this comment

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

Looks great! Just one minor nit but otherwise r=me

run.builder.ensure(CargoBook {
target: run.target,
name: INTERNER.intern_str("cargo"),
src: INTERNER.intern_path(PathBuf::from("src/tools/cargo/src/doc/book")),
Copy link
Member

Choose a reason for hiding this comment

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

I think this and the name field above are best left as local variables in run perhaps because I don't think they're inputs so much as calculated.

Copy link
Member Author

Choose a reason for hiding this comment

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

ah makes sense, I did a bit TOO much cargo culting.

I'll update this after we decide what the name should be, and then :shipit:

@@ -28,6 +28,7 @@ Rust provides a number of book-length sets of documentation, collectively
nicknamed 'The Rust Bookshelf.'

* [The Rust Programming Language][book] teaches you how to program in Rust.
* [The Cargo Book][cargo-book] is a guide to Cargo, Rust's build tool and dependency manager.
Copy link
Contributor

Choose a reason for hiding this comment

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

We're calling it "The Cargo Manual" in the cargo repo. Should we update that to say "The Cargo Book"?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm okay with either, but the rest are almost all called "Book". I'll defer to @rust-lang/cargo here

Copy link
Member

Choose a reason for hiding this comment

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

I'm fine with "The Cargo Book", it jives better with me with "bookshelf"

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool! Let's go with what you have here and I'll submit a PR for cargo to update the title there.

Copy link
Contributor

Choose a reason for hiding this comment

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

PR to update cargo: rust-lang/cargo#4695

@kennytm 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-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 2, 2017
@steveklabnik
Copy link
Member Author

@bors: r=alexcrichton

@bors
Copy link
Contributor

bors commented Nov 2, 2017

📌 Commit ac90301 has been approved by alexcrichton

@kennytm kennytm 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 2, 2017
@bors
Copy link
Contributor

bors commented Nov 3, 2017

⌛ Testing commit ac90301c48fb4e1d1b05ac5b4be62be768b52ae5 with merge af64ce8e3be13f3bc1bed4021c25f1a4df74fc7d...

@bors
Copy link
Contributor

bors commented Nov 3, 2017

💔 Test failed - status-travis

@kennytm
Copy link
Member

kennytm commented Nov 3, 2017

x86_64-gnu-distcheck failed, broken links.

[01:39:55] cargo/print.html:97: broken link - cargo/getting-started.html
[01:39:55] cargo/print.html:790: broken link - cargo/config.html
[01:39:55] cargo/print.html:2671: broken link fragment `#the-dependencies-section` pointing to `cargo/reference/manifest.html`
[01:39:55] cargo/faq.html:144: broken link fragment `#the-dependencies-section` pointing to `cargo/reference/manifest.html`
[01:39:55] cargo/reference/specifying-dependencies.html:372: broken link - cargo/config.html
[01:39:55] cargo/index.html:96: broken link - cargo/getting-started.html

@kennytm 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-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Nov 3, 2017
@shepmaster
Copy link
Member

Triage ping @steveklabnik — we haven't heard from you in a week and this PR has some test failures that need to be addressed!

@steveklabnik
Copy link
Member Author

Whoops, thanks. Will look into this soon.

bors added a commit to rust-lang/cargo that referenced this pull request Nov 11, 2017
Fix broken links in cargo book

Needed to address failures in rust-lang/rust#45692
@behnam
Copy link
Contributor

behnam commented Nov 11, 2017

I checked these files (cargo/print.html and cargo/faq.html, at least) on the cargo repo, under target/doc/book/ and all the links look fine when built. Not sure what's different in the rust build that could cause this. (Haven't tried building this PR on machine yet, because of some build issues.)

@behnam
Copy link
Contributor

behnam commented Nov 11, 2017

Oh, I just saw that you fixed some of the links, @steveklabnik! Thanks!

@steveklabnik
Copy link
Member Author

@alexcrichton are we free to just update the cargo repo whenever? We'd need to do that to land this PR, I thought it was generally updated once a cycle. I could be wrong.

@Mark-Simulacrum
Copy link
Member

We're free to update the Cargo submodule whenever, yes. We try to do it at least once a cycle, but generally it happens about 3-5 times based on bugfixes landing.

@bors
Copy link
Contributor

bors commented Nov 11, 2017

⌛ Testing commit 8f0f3b131105b0723d4428b36118f4f9d32f91bf with merge 4ef9cb0494c4267c6f202d2b1a3832c00bdff5b5...

@bors
Copy link
Contributor

bors commented Nov 12, 2017

💔 Test failed - status-travis

@kennytm
Copy link
Member

kennytm commented Nov 12, 2017

FreeBSD, could not compile cargo because libc is updated. (Note that this will also affect at least NetBSD)

[01:20:28] �[m�[m�[32m�[1m   Compiling�[m cargo v0.24.0 (file:///checkout/src/tools/cargo)
[01:20:30] �[1m�[31merror[E0308]�(B�[m�[1m: mismatched types�(B�[m
[01:20:30]    �(B�[m�[1m�[34m--> �(B�[m/checkout/src/tools/cargo/src/cargo/core/shell.rs:299:49�(B�[m
[01:20:30]     �(B�[m�[1m�[34m|�(B�[m
[01:20:30] �[1m�[34m299�(B�[m �(B�[m�[1m�[34m| �(B�[m            if libc::ioctl(libc::STDERR_FILENO, libc::TIOCGWINSZ, &mut winsize) < 0 {�(B�[m
[01:20:30]     �(B�[m�[1m�[34m| �(B�[m                                                �(B�[m�[1m�[31m^^^^^^^^^^^^^^^^�(B�[m �(B�[m�[1m�[31mexpected u64, found u32�(B�[m
[01:20:30] 
[01:20:34] �[1m�[31merror�(B�[m�[1m: aborting due to previous error�(B�[m
[01:20:34] 
[01:20:34] �[m�[m�[31m�[1merror:�[m Could not compile `cargo`.
[01:20:34] 
[01:20:34] To learn more, run the command again with --verbose.
[01:20:34] 

@kennytm kennytm mentioned this pull request Nov 12, 2017
@steveklabnik
Copy link
Member Author

I... have no idea what to do here, then.

@kennytm
Copy link
Member

kennytm commented Nov 12, 2017

@steveklabnik Cargo needs to modify src/cargo/core/shell.rs to make it portable across unixes. Maybe just adding an as cast (or .into() if possible) is enough. After that, we update the sub module here again.

@alexcrichton
Copy link
Member

I've opened rust-lang/cargo#4713 to hopefully fix this.

@kennytm
Copy link
Member

kennytm commented Nov 12, 2017

rust-lang/cargo#4713 has been merged, the cargo submodule can be updated again. @steveklabnik

@bors
Copy link
Contributor

bors commented Nov 13, 2017

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

@steveklabnik
Copy link
Member Author

Should be resolved!

@Mark-Simulacrum
Copy link
Member

I feel like this shouldn't need to update Cargo -- perhaps that's accidental / needs a rebase? I think current Cargo master is in src/tools/cargo (or at least recent enough for this repo).

@steveklabnik
Copy link
Member Author

I had updated it because I needed to update before; I guess given the conflict, it's probably not needed. I've been travelling and so I haven't been paying as close attention to the queue as usual.

I've removed that bit and rebased, let's see what Travis says.

@kennytm kennytm added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 14, 2017
@steveklabnik
Copy link
Member Author

@bors: r=alexcrichton

looks like this is passing!

@bors
Copy link
Contributor

bors commented Nov 15, 2017

📌 Commit 3b32a3a has been approved by alexcrichton

@kennytm kennytm 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 15, 2017
@bors
Copy link
Contributor

bors commented Nov 16, 2017

⌛ Testing commit 3b32a3a with merge 42ea30c...

bors added a commit that referenced this pull request Nov 16, 2017
 Start shipping the Cargo book

Fixes #44910
Fixes #39588

See both of those bugs for more details.
@bors
Copy link
Contributor

bors commented Nov 16, 2017

☀️ Test successful - status-appveyor, status-travis
Approved by: alexcrichton
Pushing 42ea30c to master...

@bors bors merged commit 3b32a3a into rust-lang:master Nov 16, 2017
@behnam
Copy link
Contributor

behnam commented Nov 22, 2017

For some reason the book is not correctly built on auto-deploy. I filed a new issue for it: #46195

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
relnotes Marks issues that should be documented in the release notes of the next release. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants