aboutsummaryrefslogtreecommitdiff
path: root/book/en
diff options
context:
space:
mode:
authorbors[bot] <26634292+bors[bot]@users.noreply.github.com>2019-09-17 18:41:45 +0000
committerGitHub <noreply@github.com>2019-09-17 18:41:45 +0000
commit38306389ea4d8fadac8565e681887740912e14bd (patch)
tree380d22ce8f365ad47fe77accfd04e61bfddcce57 /book/en
parentff3cfac6bbbfc9093df4bbe246ade18f8d3523e5 (diff)
parentd08f965080f90ff8bfb3515fe0c06cb504544eaa (diff)
Merge #248
248: update the changelog and fix some links r=korken89 a=japaric Co-authored-by: Jorge Aparicio <jorge@japaric.io>
Diffstat (limited to 'book/en')
-rw-r--r--book/en/src/by-example/app.md4
-rw-r--r--book/en/src/by-example/resources.md6
-rw-r--r--book/en/src/by-example/timer-queue.md2
-rw-r--r--book/en/src/by-example/tips.md2
-rw-r--r--book/en/src/preface.md4
5 files changed, 9 insertions, 9 deletions
diff --git a/book/en/src/by-example/app.md b/book/en/src/by-example/app.md
index ebb71f1..f687194 100644
--- a/book/en/src/by-example/app.md
+++ b/book/en/src/by-example/app.md
@@ -13,9 +13,9 @@ point to a *peripheral access crate* (PAC) generated using [`svd2rust`]
**v0.14.x** or newer. The `app` attribute will expand into a suitable entry
point so it's not required to use the [`cortex_m_rt::entry`] attribute.
-[`app`]: ../../api/cortex_m_rtfm_macros/attr.app.html
+[`app`]: ../../../api/cortex_m_rtfm_macros/attr.app.html
[`svd2rust`]: https://crates.io/crates/svd2rust
-[`cortex_m_rt::entry`]: ../../api/cortex_m_rt_macros/attr.entry.html
+[`cortex_m_rt::entry`]: ../../../api/cortex_m_rt_macros/attr.entry.html
> **ASIDE**: Some of you may be wondering why we are using a `const` item as a
> module and not a proper `mod` item. The reason is that using attributes on
diff --git a/book/en/src/by-example/resources.md b/book/en/src/by-example/resources.md
index e8f61d5..b33ca9b 100644
--- a/book/en/src/by-example/resources.md
+++ b/book/en/src/by-example/resources.md
@@ -46,8 +46,8 @@ instead of a reference. This resource proxy is a structure that implements the
[`Mutex`] trait. The only method on this trait, [`lock`], runs its closure
argument in a critical section.
-[`Mutex`]: ../../api/rtfm/trait.Mutex.html
-[`lock`]: ../../api/rtfm/trait.Mutex.html#method.lock
+[`Mutex`]: ../../../api/rtfm/trait.Mutex.html
+[`lock`]: ../../../api/rtfm/trait.Mutex.html#method.lock
The critical section created by the `lock` API is based on dynamic priorities:
it temporarily raises the dynamic priority of the context to a *ceiling*
@@ -89,7 +89,7 @@ consumer and producer end points in `init` and then each end point is stored
in a different resource; `UART0` owns the producer resource and `idle` owns
the consumer resource.
-[`Queue`]: ../../api/heapless/spsc/struct.Queue.html
+[`Queue`]: ../../../api/heapless/spsc/struct.Queue.html
``` rust
{{#include ../../../../examples/late.rs}}
diff --git a/book/en/src/by-example/timer-queue.md b/book/en/src/by-example/timer-queue.md
index 57e9d01..7c8be38 100644
--- a/book/en/src/by-example/timer-queue.md
+++ b/book/en/src/by-example/timer-queue.md
@@ -20,7 +20,7 @@ type (see [`core::time::Duration`]) and this `Duration` type must implement the
integer. If the result of the conversion doesn't fit in a 32-bit number then the
operation must return an error, any error type.
-[`Monotonic`]: ../../api/rtfm/trait.Monotonic.html
+[`Monotonic`]: ../../../api/rtfm/trait.Monotonic.html
[std-instant]: https://doc.rust-lang.org/std/time/struct.Instant.html
[`core::time::Duration`]: https://doc.rust-lang.org/core/time/struct.Duration.html
diff --git a/book/en/src/by-example/tips.md b/book/en/src/by-example/tips.md
index 3852b44..a008206 100644
--- a/book/en/src/by-example/tips.md
+++ b/book/en/src/by-example/tips.md
@@ -16,7 +16,7 @@ one can write a generic function that operates on generic resources and call it
from different tasks to perform some operation on the same set of resources.
Here's one such example:
-[`rtfm::Exclusive`]: ../../api/rtfm/struct.Exclusive.html
+[`rtfm::Exclusive`]: ../../../api/rtfm/struct.Exclusive.html
``` rust
{{#include ../../../../examples/generics.rs}}
diff --git a/book/en/src/preface.md b/book/en/src/preface.md
index 4b53706..b2f4980 100644
--- a/book/en/src/preface.md
+++ b/book/en/src/preface.md
@@ -5,14 +5,14 @@
# Preface
This book contains user level documentation for the Real Time For the Masses
-(RTFM) framework. The API reference can be found [here](../../api/rtfm/index.html).
+(RTFM) framework. The API reference can be found [here](../../api/).
There is a translation of this book in [Russian].
[Russian]: ../ru/index.html
This is the documentation of v0.5.x of RTFM; for the documentation of version
-v0.4.x go [here](../../0.4/book/en).
+v0.4.x go [here](/0.4).
**HEADS UP** This is a **beta** pre-release; there may be breaking changes in
the API and semantics before a proper release is made.