Attention is currently required from: Hoernchen, laforge, pespin.
osmith has posted comments on this change. (
https://gerrit.osmocom.org/c/osmo-trx/+/36465?usp=email )
Change subject: doc: Introduce documentation for osmo-trx-ipc and its IPC interface
......................................................................
Patch Set 2:
(12 comments)
File doc/manuals/chapters/ipc_if.adoc:
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/8e60ad46_b2a8d957
PS2, Line 113: @closed@
this gets printed literally as @closed@ in the pdf, I guess it should be monospace
`closed` instead?
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/d2f21c39_a475f018
PS2, Line 116: TIP: See
Maybe move this TIP to the start of the section? Then the reader could open it next to
this document and look at e.g. "struct ipc_sk_if_greeting" while reading about
it in this document.
Same with the TIP for "Channel UD Socket".
Same with the TIP for "Posix Shared Memory format".
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/003938c4_096b439a
PS2, Line 170: +w
missing space
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/a7b6efc7_ef7b8b3f
PS2, Line 171: +w
missing space
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/1a2b098d_51991324
PS2, Line 223: ``
`
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/d1ab9b2d_c364de6e
PS2, Line 226: ``
`
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/88257270_caa80d26
PS2, Line 275: `N``
```
`N`
```
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/e209df9d_f0402fbb
PS2, Line 283: . Read `buff->data_len` samples, reset the buffer data (`data_len=0``),
: increment `next_read` and if read samples is `<N``, continue with next
buffer
: until `next_read==next_write``, then block again or if timeout elapsed,
then we
: reach conditon buffer underflow and `return len < N``.
```
s/``/`/g
```
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/8c856724_5d6ef8f3
PS2, Line 290: `N``
```
`N`
```
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/bea6bad5_6441c023
PS2, Line 300: next_write was == next_read
is this written as intended, maybe "next_write prev" would be more clear?
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/e641b6fa_9730cfdb
PS2, Line 294: . Write samples to `buff = stream->buffers[next_write]`. If
`data_len!=0``,
: signal `buffer_overflow`` (increase field in stream object) and probably
: increase next_read``.
:
: . Increase `next_write``.
:
: . If `next_write was == next_read``, signal the reader through the other
: semaphore that it can continue reading.
```
s/``/`/g
```
File doc/manuals/chapters/trx-backends.adoc:
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/89812ae4_90b029bb
PS2, Line 132: * Test and experiment with _osmo-trx-ipc_.
: * Write your own IPC _Driver_ connecting to osmo-trx-ipc.
these do not show up as bullet points in the pdf
--
To view, visit
https://gerrit.osmocom.org/c/osmo-trx/+/36465?usp=email
To unsubscribe, or for help writing mail filters, visit
https://gerrit.osmocom.org/settings
Gerrit-Project: osmo-trx
Gerrit-Branch: master
Gerrit-Change-Id: Id6863731f9398720030b16efaaf559e05f2444ed
Gerrit-Change-Number: 36465
Gerrit-PatchSet: 2
Gerrit-Owner: pespin <pespin(a)sysmocom.de>
Gerrit-Reviewer: Hoernchen <ewild(a)sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <vyanitskiy(a)sysmocom.de>
Gerrit-Reviewer: laforge <laforge(a)osmocom.org>
Gerrit-Reviewer: osmith <osmith(a)sysmocom.de>
Gerrit-Attention: Hoernchen <ewild(a)sysmocom.de>
Gerrit-Attention: laforge <laforge(a)osmocom.org>
Gerrit-Attention: pespin <pespin(a)sysmocom.de>
Gerrit-Comment-Date: Wed, 27 Mar 2024 09:47:38 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Gerrit-MessageType: comment