Skip to content

Commit 22167b6

Browse files
committed
website update user's guide
1 parent a3995ab commit 22167b6

File tree

4 files changed

+36
-15
lines changed

4 files changed

+36
-15
lines changed

website/docs/developer/_project/_test-details.mdx

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,24 @@ test 1
1919
1: Working Directory: /Users/ilg/MyProjects/micro-os-plus.github/xPacks/utils-lists-xpack.git/tests/build/native-cmake-sys-debug/platform-bin
2020
1: Test timeout computed to be: 10000000
2121
1: micro_os_plus::trace::initialize()
22-
1: Mary
23-
1: Bob
24-
1: Sally
2522
1:
26-
1: Mary
27-
1: Sally
28-
1/2 Test #1: sample-test ...................... Passed 0.24 sec
23+
1: All kids:
24+
1: - Mary
25+
1: - Bob
26+
1: - Sally
27+
1: - Doug
28+
1:
29+
1: Bob is gone...
30+
1: - Mary
31+
1: - Sally
32+
1: - Doug
33+
1:
34+
1: School kids:
35+
1: - Sally
36+
1: - Doug
37+
1:
38+
1: Done.
39+
1/2 Test #1: sample-test ...................... Passed 0.00 sec
2940
```
3041

3142
### unit-test
@@ -34,7 +45,7 @@ The [unit-test.cpp](https://github.com/micro-os-plus/utils-lists-xpack/blob/xpac
3445
file is an exhaustive test trying to validate that all the library
3546
functions work as expected. It uses the
3647
[µTest++](https://github.com/micro-os-plus/micro-test-plus-xpack)
37-
framework.
48+
testing framework.
3849

3950
A typical run looks like:
4051

website/docs/getting-started/_project/_overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Overview
55

66
The **µOS++ Intrusive Lists** project is a C++ source code library
7-
that implements the **µOS++ intrusive double linked lists**.
7+
that implements the **µOS++ intrusive doubly linked lists**.
88
These are special lists that avoid dynamic memory allocations by
99
storing the links inside the list elements. This is particularly
1010
useful in embedded systems.

website/docs/user/_project/_content.mdx

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ nodes (the objects used to store pairs of links), which can pose challenges
99
on embedded systems. Consequently, it is advisable to avoid such allocations
1010
where 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

8494
The 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,
96106
class 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
103113
For simpler use cases, such as traditional lists or low intrusive lists,
104114
there is a simpler template:
@@ -114,7 +124,7 @@ template <class T, class L = double_list_links>
114124
class 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

website/doxygen/topics.doxyfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ not provide equivalent definitions for the C programming language.
4545

4646
/**
4747

48-
@defgroup micro-os-plus-utils-lists-intrusive-lists Intrusive double linked lists
48+
@defgroup micro-os-plus-utils-lists-intrusive-lists Intrusive doubly linked lists
4949
@ingroup micro-os-plus-utils-lists-cpp-api
5050
@details
5151

52-
Intrusive lists are double linked lists that keep the two pointers inside
52+
Intrusive lists are doubly linked lists that keep the two pointers inside
5353
each linked object.
5454

5555
The intrusive lists can be defined by instantiating the
@@ -91,7 +91,7 @@ static_children_list kids_registry;
9191

9292
/**
9393

94-
@defgroup micro-os-plus-utils-lists-double-lists Double linked lists
94+
@defgroup micro-os-plus-utils-lists-double-lists Doubly linked lists
9595
@ingroup micro-os-plus-utils-lists-cpp-api
9696
@details
9797

0 commit comments

Comments
 (0)