mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add embedded book

Browse Source
This commit is contained in:
James Munns 2019-01-19 04:52:39 +01:00 committed by Steve Klabnik
parent 8ae730a442
commit 606e5e07f6
6 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitmodules vendored
View File

@ -44,3 +44,6 @@
path = src/llvm-project
url = https://github.com/rust-lang/llvm-project.git
branch = rustc/8.0-2019-01-16
[submodule "src/doc/embedded-book"]
path = src/doc/embedded-book
url = https://github.com/rust-embedded/book.git

1
src/bootstrap/builder.rs
View File

@ -430,6 +430,7 @@ macro_rules! describe {
doc::RustByExample,
doc::RustcBook,
doc::CargoBook,
doc::EmbeddedBook,
doc::EditionGuide,
),
Kind::Dist => describe!(

5
src/bootstrap/doc.rs
View File

@ -61,6 +61,7 @@ fn run(self, builder: &Builder) {
// adding a build step in `src/bootstrap/builder.rs`!
book!(
EditionGuide, "src/doc/edition-guide", "edition-guide", RustbookVersion::MdBook1;
EmbeddedBook, "src/doc/embedded-book", "embedded-book", RustbookVersion::MdBook2;
Nomicon, "src/doc/nomicon", "nomicon", RustbookVersion::MdBook1;
Reference, "src/doc/reference", "reference", RustbookVersion::MdBook1;
RustByExample, "src/doc/rust-by-example", "rust-by-example", RustbookVersion::MdBook1;
@ -71,10 +72,6 @@ fn run(self, builder: &Builder) {
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
enum RustbookVersion {
MdBook1,
/// Note: Currently no books use mdBook v2, but we want the option
/// to be available
#[allow(dead_code)]
MdBook2,
}

1
src/ci/docker/x86_64-gnu-tools/checktools.sh
View File

@ -23,6 +23,7 @@ python2.7 "$X_PY" test --no-fail-fast \
src/doc/nomicon \
src/doc/reference \
src/doc/rust-by-example \
src/doc/embedded-book \
src/tools/clippy \
src/tools/rls \
src/tools/rustfmt \

1
src/doc/embedded-book Submodule

@ -0,0 +1 @@
Subproject commit 36bc507044a9596df426e67e2e1685a3ed6e3c60

16
src/doc/index.md
View File

@ -117,3 +117,19 @@ Rust. It's also sometimes called "the 'nomicon."
[The `rustc` Guide](https://rust-lang.github.io/rustc-guide/) documents how
the compiler works and how to contribute to it. This is useful if you want to build
or modify the Rust compiler from source (e.g. to target something non-standard).
# Specialize Rust
When using Rust in specific domain areas, consider using the following resources tailored to each domain.
## Embedded Systems
When developing for Bare Metal or Embedded Linux systems, you may find these resources maintained by the [Embedded Working Group] useful.
[Embedded Working Group]: https://github.com/rust-embedded
### The Embedded Rust Book
[The Embedded Rust Book] is targeted at developers familiar with embedded development and familiar with Rust, but have not used Rust for embedded development.
[The Embedded Rust Book]: embedded-book/index.html