@@ -9,6 +9,16 @@ nodes (the objects used to store pairs of links), which can pose challenges
99on embedded systems. Consequently, it is advisable to avoid such allocations
1010where possible, particularly at the system level.
1111
12+ ## Regular lists
13+
14+ A standard doubly linked list comprises a pair of pointers (represented
15+ by the red object) and a set of additional pointers that connect to
16+ each other as well as to the payload (depicted by the yellow objects).
17+
18+ Whenever a payload is added to the list, the corresponding object must
19+ be acquired from an allocator. Similarly, whenever an object is removed
20+ from the list, it must be returned to the free storage.
21+
1222![ Regular list] ( /img/2023/regular.png )
1323
1424## Intrusive lists
@@ -79,7 +89,7 @@ The definitions are organised within a namespace under `micro_os_plus`:
7989
8090- ` micro_os_plus::utils `
8191
82- ### Intrusive double linked lists class
92+ ### Intrusive doubly linked lists class
8393
8494The intrusive lists can be defined by instantiating a class template:
8595
@@ -96,9 +106,9 @@ template <class T, class N, N T::*MP, class L = double_list_links,
96106class intrusive_list;
97107```
98108
99- See the reference [Intrusive double linked lists](pathname:///reference/group__micro-os-plus-utils-lists-intrusive-lists.html) page.
109+ See the reference [Intrusive doubly linked lists](pathname:///reference/group__micro-os-plus-utils-lists-intrusive-lists.html) page.
100110
101- ### Double linked lists class
111+ ### Doubly linked lists class
102112
103113For simpler use cases, such as traditional lists or low intrusive lists,
104114there is a simpler template:
@@ -114,7 +124,7 @@ template <class T, class L = double_list_links>
114124class double_list;
115125```
116126
117- See the reference [ Double linked lists] ( pathname:///reference/group__micro-os-plus-utils-lists-double-lists.html ) page.
127+ See the reference [ Doubly linked lists] ( pathname:///reference/group__micro-os-plus-utils-lists-double-lists.html ) page.
118128
119129### Methods
120130
0 commit comments