Commit Graph

362 Commits

Author SHA1 Message Date
bors[bot]
b81ffb7a6f Merge #227
227: Setting output to `high` needs a `true` argument r=therealprof a=Rosto75

See the comment in line 239.

Co-authored-by: Tomasz Różański <rosto@tlen.pl>
2020-02-27 08:06:04 +00:00
Tomasz Różański
fb382e5fa6 Setting output to high needs a true argument 2020-02-27 01:30:57 +01:00
bors[bot]
0056a652c7 Merge #226
226: Add licence notes to index.md r=therealprof a=thejpster

After discussions with someone who had re-used material without attribution, we agreed it would be useful to make the licence terms more prominent to those reading the rendered book (as opposed to browsing the Github repo).

Co-authored-by: Jonathan 'theJPster' Pallant <github@thejpster.org.uk>
2020-02-17 17:50:10 +00:00
Jonathan 'theJPster' Pallant
7edcc136ae Add licence notes to index.md
After discussions with someone who had re-used material without attribution, we agreed it would be useful to make the licence terms more prominent to those reading the rendered book (as opposed to browsing the Github repo).
2020-02-17 15:55:12 +00:00
bors[bot]
b2e1092bf6 Merge #224
224: Make typestate initialization notes correct r=therealprof a=Logan-Hunter

As written previously, the note after the initial typestate
programming example saying that there's no direct way to create
a Foo object wasn't quite accurate; in the sample given you
definitely could, since Foo and FooBuilder weren't isolated
into a module. Isolated Foo and FooBuilder into a module to
make the statement correct.

Co-authored-by: Logan Hunter <loganhunter27@gmail.com>
2020-01-30 08:45:46 +00:00
Logan Hunter
ba253673bb Make typestate initialization notes correct
As written previously, the note after the initial typestate
programming example saying that there's no direct way to create
a Foo object wasn't quite accurate; in the sample given you
definitely could, since Foo and FooBuilder weren't isolated
into a module. Isolated Foo and FooBuilder into a module to
make the statement correct.
2020-01-29 21:03:51 -07:00
bors[bot]
0a6af4da99 Merge #219
219: Mention discovery book more prominently r=thejpster a=phansch

Hi, I just started reading the book and only by chance found the discovery book via the bookshelf.

I think it's worth mentioning it explicitly somewhere on this page for people who are not familiar with embedded development.

Co-authored-by: Philipp Hansch <dev@phansch.net>
2020-01-27 21:18:08 +00:00
bors[bot]
6126e21792 Merge #222
222: Replace nursery links with rust-lang links r=thejpster a=phansch

Both repos have been moved to the `rust-lang` org and the links are
still redirecting properly. This way we just avoid the redirect and make
the link shorter.

Co-authored-by: Philipp Hansch <dev@phansch.net>
2020-01-27 21:14:59 +00:00
bors[bot]
ccda305cda Merge #223
223: Add a Glossary appendix page r=thejpster a=phansch

Same structure as the [rustc-guide] basically.

I added some initial abbreviations and hope the explanations are correct.
I think it would be nice to get this merged without much iteration, so other people can start filling things in, too.

Closes #220

[rustc-guide]: https://rust-lang.github.io/rustc-guide/appendix/glossary.html#appendix-c-glossary

Co-authored-by: Philipp Hansch <dev@phansch.net>
2020-01-27 21:12:49 +00:00
Philipp Hansch
6622409b81 Add a Glossary appendix page
Same structure as the [rustc-guide] basically.

I added some initial abbreviations and hope the explanations are correct.

[rustc-guide]: https://rust-lang.github.io/rustc-guide/appendix/glossary.html#appendix-c-glossary
2020-01-27 08:08:53 +01:00
Philipp Hansch
b778f530cc CI: Remove workaround for mdBook issue
rust-lang/mdbook#789 has been fixed and this was working locally without
the `ignore-url`.
2020-01-27 07:27:17 +01:00
Philipp Hansch
103e14698e Replace nursery links with rust-lang links
Both repos have been moved to the `rust-lang` org and the links are
still redirecting properly. This way we just avoid the redirect and make
the link shorter.
2020-01-27 07:11:13 +01:00
bors[bot]
4d78994915 Merge #221
221: Update .gitattributes r=therealprof a=jethrogb

See https://github.com/rust-lang/rust/pull/57858

Co-authored-by: jethrogb <github@jbeekman.nl>
2020-01-14 08:25:25 +00:00
jethrogb
dde3bbc031 Update .gitattributes
See https://github.com/rust-lang/rust/pull/57858
2020-01-13 20:07:02 -08:00
Philipp Hansch
9070d63581 Mention discovery book more prominently 2020-01-06 07:39:27 +01:00
bors[bot]
9493b7d4dc Merge #218
218: fixed typo in Interrupts.md r=therealprof a=tessi

Just fixing a double-`to` I encountered while reading the book.
Thanks for the great content ❤️ 

Co-authored-by: Philipp Tessenow <philipp@tessenow.org>
2019-12-27 20:05:00 +00:00
Philipp Tessenow
b0caac378c fixed typo in Interrupts.md 2019-12-27 20:49:12 +01:00
bors[bot]
c262349302 Merge #216
216: Fix `impl Gpio` -> `impl GpioConfig` r=andre-richter a=andebjor

In the two sections "Peripherals as State Machines" and "Design
Contracts" of the "Static Guarantees" chapter, `impl Gpio` was
incorrectly used in place of `impl GpioConfig` at one place in each
section.

Co-authored-by: Björn Andersson <andebjor@gmail.com>
2019-12-07 17:25:11 +00:00
Björn Andersson
5e193988db Fix impl Gpio -> impl GpioConfig`
In the two sections "Peripherals as State Machines" and "Design
Contracts" of the "Static Guarantees" chapter, `impl Gpio` was
incorrectly used in place of `impl GpioConfig` at one place in each
section.

This commit fixes that.
2019-12-07 18:11:22 +01:00
bors[bot]
5ca585c4a7 Merge #205
205: Fixup book CI r=adamgreig a=jamesmunns

mdbook now has binary releases: https://github.com/rust-lang-nursery/mdBook/releases

Edit:

closes https://github.com/rust-embedded/book/issues/59

Co-authored-by: James Munns <james.munns@ferrous-systems.com>
2019-08-27 13:39:14 +00:00
James Munns
7395ddb811 Fixup book CI 2019-08-27 15:16:57 +02:00
bors[bot]
432ca26686 Merge #203
203: semihosting: add comment adding feature flag to panic-semihosting r=therealprof a=chibby0ne

This wasn't entirely trivial to find if you've never worked with feature
flags for dependencies. Hopefully it helps others out there.

Signed-off-by: Antonio Gutierrez <chibby0ne@gmail.com>

Co-authored-by: Antonio Gutierrez <chibby0ne@gmail.com>
2019-08-09 23:20:22 +00:00
Antonio Gutierrez
75a8510f59 semihosting: add comment adding feature flag to panic-semihosting
This wasn't entirely trivial to find if you've never worked with feature
flags for dependencies. Hopefully it helps others out there.

Signed-off-by: Antonio Gutierrez <chibby0ne@gmail.com>
2019-08-10 01:11:12 +02:00
bors[bot]
c5da1e1191 Merge #202
202: install/verify: fix next section link r=jamesmunns a=chibby0ne

The next section in the book is the "Getting Started", not the already
seen section Hardware in the same chapter.

Signed-off-by: Antonio Gutierrez <chibby0ne@gmail.com>

Co-authored-by: Antonio Gutierrez <chibby0ne@gmail.com>
2019-08-05 23:02:10 +00:00
Antonio Gutierrez
db6bd32c66 install/verify: Fix broken link pointed by bors
Signed-off-by: Antonio Gutierrez <chibby0ne@gmail.com>
2019-08-06 00:56:25 +02:00
Antonio Gutierrez
f106cba28e install/verify: fix next section link
The next section in the book is the "Getting Started", not the already
seen section Hardware in the same chapter.

Signed-off-by: Antonio Gutierrez <chibby0ne@gmail.com>
2019-08-05 23:58:42 +02:00
bors[bot]
f4ce2dfeeb Merge #198
198: Syst small fix r=adamgreig a=thalesfragoso

To comply with `cortex-m` docs (https://docs.rs/cortex-m/0.6.0/cortex_m/peripheral/struct.SYST.html)

> NOTE The reference manual indicates that:
>
>"The SysTick counter reload and current value are undefined at reset, the correct initialization >sequence for the SysTick counter is:
>
>    Program reload value
>    Clear current value
>    Program Control and Status register"
>
>The sequence translates to self.set_reload(x); self.clear_current(); self.enable_counter()

I think this just slipped through, since the other example on systick does that.

Co-authored-by: thalesfragoso <thales.fragosoz@gmail.com>
2019-07-18 17:57:58 +00:00
thalesfragoso
1b25e043e6 syst small fix 2019-07-18 12:41:56 -03:00
bors[bot]
ff334e74fd Merge #197
197: use_core() is required for #![no_std] compatible generated bindings r=therealprof a=david-perez



Co-authored-by: david-perez <hallaplay835@gmail.com>
2019-07-16 13:47:34 +00:00
david-perez
8b72c1e16a use_core() is required for #![no_std] compatible generated bindings 2019-07-16 00:08:35 +01:00
bors[bot]
b229e8ed5c Merge #196
196: concurrency: update shared resource examples r=andre-richter a=geomatsi

Hi all,

This PR suggests the following updates for the section on concurrency:

1. Use lazy_static macro to declare shared resources
    Suggested example of shared resource declaration does not compile
    neither on stable (edition 2018) nor on nightly with the following error:
    "error[E0015]: calls in statics are limited to constant functions, tuple structs and tuple variants"
2. Add example of mutable references to shared resources
  
Regards,
Sergey


Co-authored-by: Sergey Matyukevich <geomatsi@gmail.com>
2019-07-11 21:37:37 +00:00
Sergey Matyukevich
314a00be58 fixup: address review comments
Address review comments by @andre-richter: proof-reading

Signed-off-by: Sergey Matyukevich <geomatsi@gmail.com>
2019-07-11 21:43:19 +03:00
Sergey Matyukevich
18557e7486 concurrency: add note about const-fn feature in cortex-m crate
At the moment cortex-m crate hides const versions of some functions,
including Mutex::new(), behind the const-fn feature. So this feature
needs to be enabled to cortex-m in Cargo.toml for shared resource
examples.

Signed-off-by: Sergey Matyukevich <geomatsi@gmail.com>
2019-07-09 23:15:49 +03:00
Sergey Matyukevich
a0f62dd355 concurrency: example of mutable reference to shared resource
Add example of mutable reference to shared resource
using borrow_mut and deref_mut.

Signed-off-by: Sergey Matyukevich <geomatsi@gmail.com>
2019-07-09 22:39:50 +03:00
bors[bot]
ef27b517dc Merge #194
194: Fix link for more strict commonmark interpretation. r=therealprof a=ehuss

mdbook will be moving to a newer version of pulldown-cmark which more
closely follows the commonmark spec. Link labels do not allow square brackets.

Co-authored-by: Eric Huss <eric@huss.org>
2019-06-18 22:59:47 +00:00
Eric Huss
a7da551162 Fix link for more strict commonmark interpretation.
mdbook will be moving to a newer version of pulldown-cmark which more
closely follows the commonmark spec. Link labels do not allow square brackets.
2019-06-18 15:55:07 -07:00
bors[bot]
f0c75b75f9 Merge #193
193: Qemu md changes r=therealprof a=stefaneicher



Co-authored-by: Stefan Eicher <stefan.eicher@swisscom.com>
2019-06-03 10:49:02 +00:00
Stefan Eicher
b003f33afa create section ## Program Overview
to make obvious that this is no part of those sections
### Using `cargo-generate`
### Using `git`
### Using neither
2019-06-03 11:05:36 +02:00
Stefan Eicher
a9e976af03 move "**IMPORTANT** We'll use the name "app" for the project name"
since the term app is already used before
2019-06-03 11:05:36 +02:00
Stefan Eicher
c0f7b63c30 delete "Using the command line:" to make the documentation style consistent to the previous command line blocks 2019-06-03 11:05:36 +02:00
Stefan Eicher
753d71acb9 add comment to run "cargo install cargo-generate" first 2019-06-03 11:05:36 +02:00
Stefan Eicher
51845ac403 Update headings to get the the following TOC
# QEMU
## Creating a non standard Rust program
### Using `cargo-generate`
### Using `git`
### Using neither
## Cross compiling
## Inspecting
## Running
## Debugging

pull request is related to https://github.com/rust-embedded/book/issues/186
2019-06-03 11:05:29 +02:00
bors[bot]
9858872bd1 Merge #167
167: Update linux.md r=korken89 a=flip111

https://github.com/rust-embedded/book/issues/136

https://github.com/rust-embedded/book/issues/137

Co-authored-by: flip111 <flip101@gmail.com>
Co-authored-by: Vadim Kaushan <admin@disasm.info>
2019-05-02 18:56:54 +00:00
Vadim Kaushan
abb79175fb Remove obsoleve AUR instructions 2019-05-01 21:38:22 +02:00
Vadim Kaushan
4f7338edc9 Merge branch 'master' into patch-10 2019-05-01 21:36:31 +02:00
bors[bot]
8f366fec4f Merge #165
165: Clarify list of available targets for installation r=korken89 a=adamgreig



Co-authored-by: Adam Greig <adam@adamgreig.com>
2019-05-01 15:35:35 +00:00
bors[bot]
cd672551b9 Merge #188
188: minor grammar fix r=andre-richter a=erichschroeter

This reads better.

Co-authored-by: Erich Schroeter <erichschroeter@gmail.com>
2019-04-29 18:32:58 +00:00
Erich Schroeter
df601ce501 minor grammar fix 2019-04-29 13:30:12 -05:00
bors[bot]
de3d55f521 Merge #185
185: Minor fixes r=therealprof a=nickgolangi

As per issue https://github.com/rust-embedded/book/issues/184.

I removed the word "long" as well, to further shift the tone from teaching toward collaboration.

Co-authored-by: nickgolangi <48889034+nickgolangi@users.noreply.github.com>
2019-04-22 12:58:28 +00:00
nickgolangi
6e2cc8fc49 Change to first person and improve tone 2019-04-20 12:03:22 -04:00