Skip to content

Commit 0e5c717

Browse files
tmon-nordicnashif
authored andcommitted
doc: Fix kernel data structures typos
Add missing colons to properly render C references. Signed-off-by: Tomasz Moń <[email protected]>
1 parent e97e24e commit 0e5c717

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

doc/kernel/data_structures/mpsc_pbuf.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A :dfn:`MPSC Packet Buffer` has the following key properties:
1717

1818
* Allocate, commit scheme used for packet producing.
1919
* Claim, free scheme used for packet consuming.
20-
* Allocator ensures that continue memory of requested length is allocated.
20+
* Allocator ensures that contiguous memory of requested length is allocated.
2121
* Following policies can be applied when requested space cannot be allocated:
2222

2323
* **Overwrite** - oldest entries are dropped until requested amount of memory can

doc/kernel/data_structures/rbtree.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ required.
1818
Unlike a list, where position is explicit, the ordering of nodes
1919
within an rbtree must be provided as a predicate function by the user.
2020
A function of type :c:func:`rb_lessthan_t` should be assigned to the
21-
``lessthan_fn`` field of the :c:struct`rbtree` struct before any tree
21+
``lessthan_fn`` field of the :c:struct:`rbtree` struct before any tree
2222
operations are attempted. This function should, as its name suggests,
2323
return a boolean True value if the first node argument is "less than"
2424
the second in the ordering desired by the tree. Note that "equal" is

doc/kernel/data_structures/ring_buffers.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ its contents are copied to the data buffer, along with its associated metadata
154154
values (which occupy one additional 32-bit word). If the ring buffer has
155155
insufficient space to hold the new data item the enqueue operation fails.
156156

157-
A data items is **dequeued** (:c:func:`ring_buf_item_get`) from a ring
157+
A data item is **dequeued** (:c:func:`ring_buf_item_get`) from a ring
158158
buffer by removing the oldest enqueued item. The contents of the dequeued data
159159
item, as well as its two metadata values, are copied to areas supplied by the
160160
retriever. If the ring buffer is empty, or if the data array supplied by the
@@ -200,7 +200,7 @@ Defining a Ring Buffer
200200

201201
A ring buffer is defined using a variable of type :c:type:`ring_buf`.
202202
It must then be initialized by calling :c:func:`ring_buf_init` or
203-
c:func:`ring_buf_item_init`.
203+
:c:func:`ring_buf_item_init`.
204204

205205
The following code defines and initializes an empty **data item mode** ring
206206
buffer (which is part of a larger data structure). The ring buffer's data buffer

0 commit comments

Comments
 (0)