[Doc] Fix cross-reference warnings (#25058)

Signed-off-by: Punit Vara <punitvara@gmail.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
This commit is contained in:
Punitvara
2025-09-18 14:35:16 +05:30
committed by GitHub
parent aa3f105c59
commit 05b044e698
6 changed files with 18 additions and 14 deletions

View File

@@ -30,7 +30,7 @@ class SingleWriterShmRingBuffer:
- Maintains metadata for each allocated buffer chunk in the writer process
- Supports custom "is_free_fn" functions to determine when buffers can be
reused
- Each buffer chunk contains: [4-byte id][4-byte size][actual_data]
- Each buffer chunk contains: `[4-byte id][4-byte size][actual_data]`
Key Concepts:
- monotonic_id_start/end: Track the range of active buffer IDs
@@ -99,7 +99,7 @@ class SingleWriterShmRingBuffer:
- Writer handles garbage collection (free_buf) based on reader feedback
Memory Layout per Buffer Chunk:
[4-byte monotonic_id][4-byte chunk_size][actual_data...]
`[4-byte monotonic_id][4-byte chunk_size][actual_data...]`
^metadata_start ^data_start
The monotonic_id ensures data integrity - readers can verify they're
@@ -185,7 +185,7 @@ class SingleWriterShmRingBuffer:
'''
Allocate a buffer `MD_SIZE` + `size` bytes in the shared memory.
Memory layout:
[4-byte monotonic_id][4-byte size][buffer data...]
`[4-byte monotonic_id][4-byte size][buffer data...]`
'''
assert self.is_writer, "Only the writer can allocate buffers."
assert size > 0, "Size must be greater than 0"
@@ -413,7 +413,7 @@ class SingleWriterShmObjectStorage:
allocation
Memory Layout per Object:
[4-byte reference_count][metadata_size][serialized_object_data]
`[4-byte reference_count][metadata_size][serialized_object_data]`
Thread Safety:
- Writer operations (put, clear) are single-threaded by design