RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

Merge pull request #18311 from benpicco/gnrc/ipv6_auto_subnets-wording

Browse Source 
gnrc/ipv6_auto_subnets: improve wording in documentation, add to Doxygen
This commit is contained in:
Marian Buschsieweke 2022-07-16 13:49:20 +02:00 committed by GitHub
commit 576f82732f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/doxygen/riot.doxyfile
View File

@ -776,7 +776,8 @@ INPUT = ../../doc.txt \
src/release-cycle.md \
src/changelog.md \
../../LOSTANDFOUND.md \
../../makefiles/pseudomodules.inc.mk
../../makefiles/pseudomodules.inc.mk \
../../sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

16
sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c
View File

@ -17,9 +17,9 @@
* This module provides an automatic configuration for networks with a (simple)
* tree topology.
*
* If a sufficiently large IPv6 prefix (> /64) is provided via Router Advertisements,
* a routing node with this module will automatically configure subnets from it
* by dividing it into sub-prefixes for each downstream interface.
* If a sufficiently large IPv6 subnet (prefix length < /64) is provided via Router
* Advertisements, a routing node with this module will automatically configure
* subnets from it by dividing it into sub-prefixes for each downstream interface.
*
* When using the `gnrc_ipv6_auto_subnets_simple` module, there can only be a single
* routing node on each level of the network but an arbitrary number of leaf nodes.
@ -44,10 +44,10 @@
*
* The new subnet must no longer be considered on-link by the hosts in the
* parent network.
* Therefore the downstream router will send a router advertisement with only
* a Route Information Option included to the upstream network.
* Therefore the downstream router will send a router advertisement, which only
* contains a Route Information Option, to the upstream network.
* The Route Information Option contains the prefix of the downstream network
* so that upstream routers will no longer consider hosts in this subnet on-link
* so that upstream routers will no longer consider hosts in this subnet on-link,
* but instead will use the downstream router to route to the new subnet.
*
* Usage
@ -128,6 +128,9 @@
#define CONFIG_GNRC_IPV6_AUTO_SUBNETS_NUMOF (1)
#endif
/* Code below should not be included by Doxygen */
#ifndef DOXYGEN
#define SERVER_THREAD_STACKSIZE (THREAD_STACKSIZE_DEFAULT)
#define SERVER_MSG_QUEUE_SIZE (CONFIG_GNRC_IPV6_AUTO_SUBNETS_PEERS_MAX)
#define SERVER_MSG_TYPE_TIMEOUT (0x8fae)
@ -645,4 +648,5 @@ void gnrc_ipv6_auto_subnets_init(void)
_eventloop, NULL, "auto_subnets");
}
#endif /* !IS_USED(MODULE_GNRC_IPV6_AUTO_SUBNETS_SIMPLE) */
#endif /* !DOXYGEN */
/** @} */