From 76ebe71fcbf40fd876edcc0cd3eb9d3d6855a754 Mon Sep 17 00:00:00 2001 From: Peter Bigot Date: Mon, 16 Nov 2020 14:27:56 -0600 Subject: [PATCH] doc: data structures: fix description of sflist Fix a confusing type and clarify what the alternative data structure adds. Signed-off-by: Peter Bigot --- doc/reference/misc/data_structures.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/reference/misc/data_structures.rst b/doc/reference/misc/data_structures.rst index 28e2baded03..0af11f95a63 100644 --- a/doc/reference/misc/data_structures.rst +++ b/doc/reference/misc/data_structures.rst @@ -125,9 +125,10 @@ Flagged List The ``sys_sflist_t`` is implemented using the described genlist template API. With the exception of symbol naming ("sflist" instead -of "sflist"), it operates in all ways identically to the slist API. +of "slist") and the additional API described next, it operates in all +ways identically to the slist API. -It includes the ability to associate exactly two bits of user defined +It adds the ability to associate exactly two bits of user defined "flags" with each list node. These can be accessed and modified with ``sys_sflist_flags_get()`` and ``sys_sflist_flags_get()``. Internally, the flags are stored unioned with the bottom bits of the