Hi,
On 1/11/25 10:19 PM, Mychaela Falconia wrote:
- When I run './configure --enable-manuals' followed by 'make' on the
Debian machine which Vadim provided to me for Osmocom documentation work, everything seems successful and I get a PDF rendering of my WIP manual. However, as soon as I uploaded this patch to Gerrit, I see a build failure in Jenkins. What am I doing wrong? I'm afraid that my knowledge of Autotools is not good enough to figure this one out.
I think, as I mentioned in the patch just now, that we shouldn't add a User Manual document in libosmo-netif. Instead, add the chapter to osmo-gsm-manuals and include it in whatever app (eg. osmo-bts.git) User Manual it is used in.
- My progress in writing the actual manual has reached the point
where I need to insert some graphical diagrams showing the flow of RTP packets and the latency and jitter they experience in transit. I am thinking of one horizontal axis showing regularly spaced packets as they are emitted by the source, then forward-and-down arrows showing their transit with fixed or variable latency, then another horizontal axis below showing the receiver's view of time, with marked arrival times of packets (endpoints of latency arrows) and fixed-spacing times when the GSM or TDM system polls the jitter buffer.
Wouldn't a message sequence diagram be good for that? See for instance osmo-bsc/doc/handover.msc You can manually generate a png with: mscgen -T png -i handover.msc -o /tmp/handover.png
You can include the .msc file into the asciidoc document, grep for "mscgen" in osmo-bsc/doc/ for examples.
Similarly, you can include graphviz files like osmo-bsc/doc/assignment-fsm.dot.
You can also generate packet definitions with packetdiag format. Grep for "packetdiag" in osmo-bsc/doc/.
Regards,