Skip to content

Commit

Permalink
fixup! docs(book): move the networking documentation into the book
Browse files Browse the repository at this point in the history
Co-authored-by: Kaspar Schleiser <kaspar@schleiser.de>
  • Loading branch information
ROMemories and kaspar030 committed Jan 21, 2025
1 parent ee60826 commit 89ce142
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions book/src/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Network Link Selection

Ariel OS currently supports two different networking links: Ethernet-over-USB (aka CDC-NCM) and Wi-Fi.
Boards may support both of them, only one of them, or none of them.
Boards may support both of them, only one of them, or none of them. However, currently the network stack supports at most one interface.

Which link layer is used for networking must be selected at compile time,
through [laze modules](./build_system.md#laze-modules):
Expand Down Expand Up @@ -44,9 +44,9 @@ When the `override-network-config` Cargo feature is enabled, DHCP is disabled an
Support for various network protocols can be enabled through [Cargo features listed in the documentation][rustdoc-homepage].
Most of these use `embassy_net`, which should be used through the [`ariel_os::reexports::embassy_net`][embassy-net-reexport-rustdoc] re-export.

### Obtaining a Network Stack
### Using the Network Stack

A network stack can then be obtained using [`ariel_os::network::network_stack()`][network-stack-rustdoc].
A network stack handle can then be obtained using [`ariel_os::network::network_stack()`][network-stack-rustdoc].

See the [examples][examples-dir-repo] for details.

Expand Down

0 comments on commit 89ce142

Please sign in to comment.