Initial addition of the Embedded Rust Book #56291
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
(rust_highfive has picked a reviewer for you, use r? to override) |
|
rust-highfive
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
|
One of our CI scripts was exactly one |
|
This looks great!
Yes, you'll need to modify rustbuild as well. It should be as easy as adding a line in here https://github.com/rust-lang/rust/blob/master/src/bootstrap/doc.rs#L70-L76 |
This comment has been minimized.
This comment has been minimized.
|
The job Click to expand the log.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 |
|
I
I hope to address this in the next day or so in my working branch. |
|
I thought that mdbook always put the first page of the book as index.html; maybe I'm wrong... |
|
Hmm, you seem to be right @steveklabnik: I guess this means I have some investigating to do, support would be appreciated, otherwise I'll look once I have a chance. |
|
I cannot get this to build due to a really strange error that file does not exist, so I'm not sure why it's looking for it. |
|
☔ The latest upstream changes (presumably #56340) made this pull request unmergeable. Please resolve the merge conflicts. |
7 tasks
Merged
steveklabnik
suggested changes
Nov 30, 2018
There was a problem hiding this comment.
Sooooooooooooo @jamesmunns , I forgot a crucial step:
diff --git a/src/bootstrap/builder.rs b/src/bootstrap/builder.rs
index 079fdee7e8..97d3ecba04 100644
--- a/src/bootstrap/builder.rs
+++ b/src/bootstrap/builder.rs
@@ -442,7 +442,8 @@ impl<'a> Builder<'a> {
doc::RustdocBook,
doc::RustByExample,
doc::RustcBook,
- doc::CargoBook
+ doc::CargoBook,
+ doc::EmbeddedBook
),
Kind::Dist => describe!(
dist::Docs,the changes you have define the build, but don't actually do the building.
after that, we get this report:
embedded-book\intro\install\linux.html:237: broken link - embedded-book\verify.md
embedded-book\intro\install\macos.html:147: broken link - embedded-book\verify.md
embedded-book\intro\install\verify.html:170: broken link - hardware.md
embedded-book\intro\install\verify.html:177: broken link - hardware.md
embedded-book\intro\install\verify.html:180: broken link - embedded-book\linux.md
embedded-book\intro\install\windows.html:161: broken link - embedded-book\verify.md
embedded-book\intro\install.html:160: broken link - embedded-book\install\linux.md
embedded-book\intro\install.html:161: broken link - embedded-book\install\windows.md
embedded-book\intro\install.html:162: broken link - embedded-book\install\macos.md
embedded-book\print.html:374: broken link - embedded-book\install\linux.md
embedded-book\print.html:375: broken link - embedded-book\install\windows.md
embedded-book\print.html:376: broken link - embedded-book\install\macos.md
embedded-book\print.html:479: broken link - embedded-book\verify.md
embedded-book\print.html:491: broken link - embedded-book\verify.md
embedded-book\print.html:517: broken link - embedded-book\verify.md
embedded-book\print.html:552: broken link - hardware.md
embedded-book\print.html:559: broken link - hardware.md
embedded-book\print.html:562: broken link - embedded-book\linux.md
embedded-book\print.html:628: broken link - embedded-book\hardware.md
embedded-book\print.html:1107: broken link - embedded-book\qemu.md
embedded-book\print.html:1151: broken link - intro\install\verify.md
embedded-book\print.html:1173: broken link - intro\install\verify.md
embedded-book\print.html:1329: broken link - portability\index.md
embedded-book\print.html:1352: broken link - peripherals\index.md
embedded-book\start\hardware.html:177: broken link - embedded-book\qemu.md
embedded-book\start\hardware.html:221: broken link - intro\install\verify.md
embedded-book\start\hardware.html:243: broken link - intro\install\verify.md
embedded-book\start\index.html:146: broken link - embedded-book\hardware.md
embedded-book\start\registers.html:142: broken link - portability\index.md
embedded-book\start\registers.html:165: broken link - peripherals\index.md
all of the print ones are duplicates of the regular pages, so this list is only half as long.
make sense?
|
I'll take a look tomorrow, I've got some time on the train. I'll see what I can get together :) |
Dylan-DPC-zz
added
the
S-waiting-on-author
|
ping from triage @jamesmunns you need to update this with the changes requested. |
|
Thanks @Dylan-DPC, I still intend to finish this as soon as I can. |
jamesmunns
force-pushed
the
upstream-embedded-book
branch
from
caa785d
to
a28006c
Compare
|
The job Click to expand the log.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 |
|
@steveklabnik I think I know what the issue is, the main rust repo uses an older version of In this change, I update the dependency to Let's see how the CI goes. |
|
Updating to 0.2 is going to take a massive effort across all books. I plan on trying to tackle it soon, but it’s tough.
… On Dec 10, 2018, at 3:49 PM, James Munns ***@***.***> wrote:
@steveklabnik I think I know what the issue is, the main rust repo uses an older version of mdbook than the embedded wg (0.1.7 vs 0.2.2). We rely on using links to relative md files within the pre-rendered markdown, and newer versions of mdbook automatically render this to .html links.
In this change, I update the dependency to 0.2.2. After updating, x.py dist still seems to complete successfully.
Let's see how the CI goes.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.
|
|
The job Click to expand the log.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 |
|
Oh. That's unfortunate. Let me ask the folks at the next embedded meeting whether we are okay with breaking convention on how relative links should be formatted. @steveklabnik how would I run exactly the same test that CI is running for this check? I don't get the same errors when I just run I might be interested in chipping away at the mdbook 0.2 changes, if they are mostly mechanical. |
|
python x.py test src/tools/linkchecker
It’s mostly about the re-basing of relative URLs, as you mentioned. The book, the reference, the nomicon, RBE... they’ll all need to be updated.
… On Dec 10, 2018, at 6:59 PM, James Munns ***@***.***> wrote:
Oh. That's unfortunate. Let me ask the folks at the next embedded meeting whether we are okay with breaking convention on how relative links should be formatted.
@steveklabnik how would I run exactly the same test that CI is running for this check? I don't get the same errors when I just run x.py dist or x.py doc, I think it's missing the linkcheck step?
I might be interested in chipping away at the mdbook 0.2 changes, if they are mostly mechanical.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.
|
steveklabnik
pushed a commit
to jamesmunns/rust
that referenced
this pull request
Jan 30, 2019
bors
added a commit
that referenced
this pull request
Jan 30, 2019
Support multiple versions of MdBook for docs Only the compatibility items from the embedded book PR. PR with embedded book components: #56291 CC @steveklabnik, @ehuss, and rust-lang/edition-guide#134
|
Pinging @steveklabnik, have I got a book for you. |
|
@steveklabnik ready for the |
steveklabnik
force-pushed
the
upstream-embedded-book
branch
from
62ab121
to
14eb2ad
Compare
steveklabnik
force-pushed
the
upstream-embedded-book
branch
from
14eb2ad
to
606e5e0
Compare
steveklabnik
approved these changes
Feb 4, 2019
|
I've rebased and squashed this; let's make sure travis passes, and then this looks good to go to me. @jamesmunns maybe triple check this? |
|
@steveklabnik it looks like the submodule rolled back in versions, updated with the current master branch. Otherwise LGTM! |
|
@bors: r+ Woo! |
|
📌 Commit 4633cca has been approved by |
bors
added
S-waiting-on-bors
|
⌛ Testing commit 4633cca with merge b9ad58b693bd15c5bab63ec1d3511079c178bb9c... |
|
💔 Test failed - status-appveyor |
bors
added
S-waiting-on-review
|
@bors: retry seems spurious and not related? |
bors
added
S-waiting-on-bors
|
Yep, it's spurious, we're trying to track it. |
bors
added a commit
that referenced
this pull request
Feb 5, 2019
Initial addition of the Embedded Rust Book This PR adds the Embedded Rust Book to the bookshelf as a submodule, and adds text for the bookshelf page. I have added a new section after "Master Rust" called "Specialize Rust", with the plan that future domain WG books can also reside here. This now extends the titles down to H3, where formerly only H1 and H2 were used. The added submodule tracks the master branch of the Embedded WG repo. If there are additional steps necessary to make this work in CI (perhaps adding this to `src/ci/docker/x86_64-gnu-tools/checktools.sh:32` or so?), please let me know. CC @steveklabnik @japaric Also CC issue rust-embedded/wg#257
|
☀️ Test successful - checks-travis, status-appveyor |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the Embedded Rust Book to the bookshelf as a submodule, and adds text for the bookshelf page. I have added a new section after "Master Rust" called "Specialize Rust", with the plan that future domain WG books can also reside here. This now extends the titles down to H3, where formerly only H1 and H2 were used.
The added submodule tracks the master branch of the Embedded WG repo.
If there are additional steps necessary to make this work in CI (perhaps adding this to
src/ci/docker/x86_64-gnu-tools/checktools.sh:32or so?), please let me know.CC @steveklabnik @japaric
Also CC issue rust-embedded/wg#257