Skip to content

Commit

Permalink
docs: fix various links
Browse files Browse the repository at this point in the history
  • Loading branch information
bradjc committed Jul 11, 2024
1 parent 7aea14a commit 95dee46
Show file tree
Hide file tree
Showing 12 changed files with 19 additions and 19 deletions.
6 changes: 3 additions & 3 deletions boards/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ but the approximate definitions:
shape, but not heavily tested. Some Tier 2 boards may
have known issues, which are documented in release notes
during release testing.
- **Tier 3:** New or highly experimental. These should support the
minimum platform requirements laid out in
[the Porting documentation](../doc/Porting.md), but
- **Tier 3:** New or highly experimental. These should support the minimum
platform requirements laid out in [the Porting
documentation](https://book.tockos.org/development/porting), but
make no promises beyond that.

- **Other:** See each board for specific details.
Expand Down
2 changes: 1 addition & 1 deletion boards/nano33ble/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Arduino Nano 33 BLE
===================

<img src="https://store-cdn.arduino.cc/usa/catalog/product/cache/1/image/1040x660/604a3538c15e081937dbfbd20aa60aad/a/b/abx00031_featured.jpg" width="35%">
<img src="https://store-usa.arduino.cc/cdn/shop/products/ABX00030_01.iso_1000x750.jpg?v=1626445244" width="35%">

The [Arduino Nano 33 BLE](https://store.arduino.cc/usa/nano-33-ble) and [Arduino
Nano 33 BLE Sense](https://store.arduino.cc/usa/nano-33-ble-sense) are compact
Expand Down
2 changes: 1 addition & 1 deletion boards/nano33ble_rev2/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Arduino Nano 33 BLE Sense Rev2
===================

<img src="https://media.elektor.com/media/catalog/product/cache/9cc822bfc6a57f9729d464b8b5e0e0df/a/r/arduino-nano-33-ble-sense-rev2-with-headers_front.jpg" width="35%">
<img src="https://store-usa.arduino.cc/cdn/shop/products/ABX00069_01.iso_1000x750.jpg?v=1669710070" width="35%">

The [Arduino Nano 33 BLE Sense Rev2](https://store.arduino.cc/products/nano-33-ble-sense-rev2) is a
compact board based on the Nordic nRF52840 SoC. It includes the following sensors:
Expand Down
2 changes: 1 addition & 1 deletion boards/nano_rp2040_connect/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Arduino Nano RP2040 Connect
===========================

<img src="https://store-cdn.arduino.cc/uni/catalog/product/cache/1/image/520x330/604a3538c15e081937dbfbd20aa60aad/a/b/abx00053_00.default.jpg" width="35%">
<img src="https://store-usa.arduino.cc/cdn/shop/products/ABX00052_01.iso_1000x750.jpg?v=1629816097" width="35%">

The [Arduino Nano RP2040 Connect](https://docs.arduino.cc/hardware/nano-rp2040-connect) is an Arduino Nano
board built using the Raspberry Pi Foundation's RP2040 chip.
Expand Down
2 changes: 1 addition & 1 deletion boards/nordic/nrf52840dk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ setting the `USB_DEBUGGING` constant to `true` in the [main.rs](src/main.rs)
file. This disables the UART interface.

For instructions about how to receive RTT messages on the host, see the
[corresponding capsule](../../../capsules/src/segger_rtt.rs).
[corresponding capsule](../../../capsules/extra/src/segger_rtt.rs).

## Debugging

Expand Down
2 changes: 1 addition & 1 deletion boards/sma_q3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ $ tockloader install --openocd --board sma_q3

## Debugging

See the [nrf52dk README](../nrf52dk/README.md) for information about debugging
See the [nrf52dk README](../nordic/nrf52dk/README.md) for information about debugging
the SMA Q3. Note: may need adjustment due to missing serial interface.
2 changes: 1 addition & 1 deletion boards/tutorials/nrf52840dk-thread-tutorial/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ nRF52840DK Board Definition for the Tock Thread Tutorial
========================================================

This is the board definition for the nRF52840DK target used in the
[Thread Network tutorial](https://book.tockos.org/course/thread-network/overview).
[Thread Network tutorial](https://book.tockos.org/course/thread-net/overview).

Please follow the instructions in that tutorial. You may also want to look at
the documentation of the base nRF52840DK board definition
Expand Down
2 changes: 1 addition & 1 deletion capsules/core/src/low_level_debug/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Low Level Debug
The Low Level Debug capsule provides debugging facilities to userspace for
debugging low-level issues such as miscompilation and incorrect relocation. It
implements the system call API described
[here](../../../doc/syscalls/00008_low_level_debug.md).
[here](../../../../doc/syscalls/00008_low_level_debug.md).
8 changes: 4 additions & 4 deletions doc/ExternalDependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,10 @@ be useful or desirable.
### Capsule Crate-Specific External Dependencies

Capsules are a mechanism to provide semi-trusted infrastructure to a Tock board,
for instance non chip-specific peripheral drivers (see [Design](./Design.md)).
As such, external dependencies may be useful to implement complex subsystems.
Examples for this are wireless or networking protocols such as Bluetooth Low
Energy or TCP.
for instance non chip-specific peripheral drivers (see
[Design](https://book.tockos.org/doc/design)). As such, external dependencies
may be useful to implement complex subsystems. Examples for this are wireless or
networking protocols such as Bluetooth Low Energy or TCP.

To support such use-cases without forcing all boards to include external
dependencies, capsules are split into multiple crates:
Expand Down
2 changes: 1 addition & 1 deletion doc/syscalls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This folder contains the detailed documentation for the interfaces between
userspace and the kernel. It includes details of the ABI interface, the kernel
provided syscalls, and the driver specific interfaces (using `allow`,
`schedule`, and `command`). For more information on the general syscalls, see
[here](../Syscalls.md).
[here](https://book.tockos.org/doc/syscalls).

<!-- toc -->

Expand Down
2 changes: 1 addition & 1 deletion libraries/tickv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on flash. It was written to be generic though, so other Rust applications can
use it if they want.

TicKV is based on similar concepts as
[Yaffs1](https://yaffs.net/documents/how-yaffs-works).
[Yaffs1](https://yaffs.net/sites/yaffs.net/files/HowYaffsWorks.pdf).

## Goals of TicKV

Expand Down
6 changes: 3 additions & 3 deletions libraries/tickv/SPEC.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ to add such features.
TicKV allows writing new key/value pairs (by appending them) and removing
old key/value pairs.

Similar to (Yaffs1)[https://yaffs.net/documents/how-yaffs-works] TicKV uses a
log structure and circles over the flash data. This means that the file
system is inherently wear leveling as we don't regularly write to the same
Similar to [Yaffs1](https://yaffs.net/sites/yaffs.net/files/HowYaffsWorks.pdf)
TicKV uses a log structure and circles over the flash data. This means that the
file system is inherently wear leveling as we don't regularly write to the same
flash region.

## Storage Format
Expand Down

0 comments on commit 95dee46

Please sign in to comment.