From 41816ed647a3b2121f612207f612ccbc939c1f6d Mon Sep 17 00:00:00 2001 From: chrysn Date: Wed, 14 Feb 2024 17:28:49 +0100 Subject: [PATCH 1/2] doc: Link to thread primer --- pkg/openthread/doc.txt | 4 ++++ sys/net/ieee802154.txt | 4 +++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/pkg/openthread/doc.txt b/pkg/openthread/doc.txt index 4c04a6737a..46a41ad3d2 100644 --- a/pkg/openthread/doc.txt +++ b/pkg/openthread/doc.txt @@ -7,4 +7,8 @@ * @note Currently there's only support for @ref drivers_at86rf2xx. * There's a work in progress to support more radio drivers * (see [this issue](https://github.com/RIOT-OS/RIOT/issues/10045)) + * @note A good technical introduction to how Thread works is available in + * the [thread primer] of OpenThread. + * + * [thread primer]: https://openthread.io/guides/thread-primer */ diff --git a/sys/net/ieee802154.txt b/sys/net/ieee802154.txt index 930e61c532..b9c58031b1 100644 --- a/sys/net/ieee802154.txt +++ b/sys/net/ieee802154.txt @@ -66,9 +66,11 @@ * protocols used on top of it, applications always need to pick their * components; that selection is often guided by standards or organizations * that pick an interoperable set of components (higher-level protocol, MAC, - * band and others), like Thread (6LoWPAN, nonbeacon-enabled, 2.4GHz), + * band and others), like [Thread] \(6LoWPAN, nonbeacon-enabled, 2.4GHz), * WirelessHART (HART, TSCH, 2.4GHz) or 6TiSCH (6LoWPAN, TSCH). * + * [Thread]: https://openthread.io/guides/thread-primer + * * Availability in RIOT * -------------------- * From b85a71acbd17747d5abc29ba48bf2a30b8c7f67d Mon Sep 17 00:00:00 2001 From: chrysn Date: Wed, 14 Feb 2024 17:30:32 +0100 Subject: [PATCH 2/2] openthread/doc: Remove obsolete note Since [14979], the submac has been supported. [14979]: https://github.com/RIOT-OS/RIOT/pull/14979/files --- pkg/openthread/doc.txt | 3 --- 1 file changed, 3 deletions(-) diff --git a/pkg/openthread/doc.txt b/pkg/openthread/doc.txt index 46a41ad3d2..bc35d7f961 100644 --- a/pkg/openthread/doc.txt +++ b/pkg/openthread/doc.txt @@ -4,9 +4,6 @@ * @ingroup net * @brief Provides a RIOT adaption of the OpenThread network stack * @see https://github.com/openthread/openthread - * @note Currently there's only support for @ref drivers_at86rf2xx. - * There's a work in progress to support more radio drivers - * (see [this issue](https://github.com/RIOT-OS/RIOT/issues/10045)) * @note A good technical introduction to how Thread works is available in * the [thread primer] of OpenThread. *