Attention is currently required from: Hoernchen, laforge, osmith.
pespin 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:
(13 comments)
File doc/manuals/chapters/ipc_if.adoc:
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/991159a7_ebbfb5e5
PS2, Line 42: Once connected, _osmo-trx-ipc_ will submit a `GREETING_REQ` message
primitive
(The whole description of the IPC messages could be
done with mscgen and diag graphs, like we do in […]
Yeah, it can be improved later
on. It's not like the whole procedure is super complex anyway.
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/0de3cd0d_23702d30
PS2, Line 113: @closed@
this gets printed literally as @closed@ in the pdf, I
guess it should be monospace `closed` instead?
I'll use __ since it's not
some keyword in the code.
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/b85b8c1b_a259221b
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 […]
I think it's fine having it
at the end, otherwise I have the feeling you are redirecting too much the user when
entering a section.
But no strong opinion with it though. I think I'll leave it as it is for now.
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/158ec7df_3a7446fd
PS2, Line 170: +w
missing space
Ack
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/6448d3ca_9a33af92
PS2, Line 171: +w
missing space
Done
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/09410d55_ee9996eb
PS2, Line 223: ``
`
Done
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/e31b8e86_9516cc96
PS2, Line 226: ``
`
Done
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/4562aa55_9a5779ff
PS2, Line 275: `N``
``` […]
Done
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/bb215fba_824b5028
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``.
``` […]
Done
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/65a6b0ab_d519c183
PS2, Line 290: `N``
``` […]
Done
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/89c3ddc6_57c5798d
PS2, Line 300: next_write was == next_read
is this written as intended, maybe "next_write
prev" would be more clear?
Done
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/c1e5c28b_c38e8858
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.
``` […]
Done
File doc/manuals/chapters/trx-backends.adoc:
https://gerrit.osmocom.org/c/osmo-trx/+/36465/comment/9edef49b_b30e69e2
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
Done
--
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: osmith <osmith(a)sysmocom.de>
Gerrit-Attention: Hoernchen <ewild(a)sysmocom.de>
Gerrit-Attention: laforge <laforge(a)osmocom.org>
Gerrit-Comment-Date: Wed, 27 Mar 2024 12:35:33 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Comment-In-Reply-To: osmith <osmith(a)sysmocom.de>
Gerrit-MessageType: comment