Attention is currently required from: fixeria. osmith has posted comments on this change by fixeria. ( https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364?usp=email )
Change subject: doc/manuals: add overview, document running and configuration ...................................................................... Patch Set 4: (8 comments) File README.md: https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/4215086b_47ca9554?usp=email : PS4, Line 131: `make install` deploys a complete ERTS release together with a convenience the edits in this line until the end of this section don't seem like improvements to me, it just adds more LLM style with mdashes and verbosity IMHO. File doc/manuals/chapters/overview.adoc: https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/306782c9_c8248fa6?usp=email : PS4, Line 9: , i.e. radio base stations seems unnecessary, people reading this should be familiar with what an eNodeB is, so I suggest to remove that https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/a43ed260_875dfa60?usp=email : PS4, Line 38: ---- instead of such ascii art diagrams, we typically use graphviz graphs in manuals: https://gitea.osmocom.org/cellular-infrastructure/osmo-hlr/src/commit/459ae06783dadfd67130dd9fa61568eef6d4146f/doc/manuals/chapters/overview.adoc#L39-L68 File doc/manuals/chapters/running.adoc: https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/7495f2c9_9736fd63?usp=email : PS4, Line 32: Useful for testing new features or bug fixes before they are formally released. Given that this is project specific documentation, I would remove above block starting with "Two package feeds are available". This is on the wiki page as well, with additional information, and then we have one less location where we potentially need to update this information, e.g. if we added a third feed at some point. https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/f60869db_f2ab4db7?usp=email : PS4, Line 97: | `BINDIR` | Installation directory for executables | `/usr/bin` side note: other Osmocom programs "make install" to /usr/local by default https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/8b7ba778_4353ea51?usp=email : PS4, Line 107: Running `make install` (typically as root, or with `DESTDIR` set for This is very verbose. Do we need to explain where every single file goes here? This also means it needs to be updated when we should add additional files. IMHO saying that the user needs to run `make install`, and maybe also describing that there is `DESTDIR`, is enough. (also this doesn't render properly: https://nextcloud.sysmocom.de/s/FYMZ2rpe3aRKQYm) https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/02186ffd_88a25058?usp=email : PS4, Line 128: ==== The `osmo-s1gw` Bootstrap Script This is also very verbose. Do we need this section at all? We could also briefly refer to running `osmo-s1gw -h` for more information, then we don't need to update the help text in two places when making changes to the arguments. https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364/comment/1203b10a_0ba6543b?usp=email : PS4, Line 198: Wireshark and are tagged with the application name `OsmoS1GW`. why is this worth mentioning? " and are tagged with the application name `OsmoS1GW`." -- To view, visit https://gerrit.osmocom.org/c/erlang/osmo-s1gw/+/42364?usp=email To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings?usp=email Gerrit-MessageType: comment Gerrit-Project: erlang/osmo-s1gw Gerrit-Branch: master Gerrit-Change-Id: I4ceca069866d7191ef2b153af95a20cb522bffeb Gerrit-Change-Number: 42364 Gerrit-PatchSet: 4 Gerrit-Owner: fixeria <[email protected]> Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: osmith <[email protected]> Gerrit-Reviewer: pespin <[email protected]> Gerrit-Attention: fixeria <[email protected]> Gerrit-Comment-Date: Tue, 17 Mar 2026 11:08:15 +0000 Gerrit-HasComments: Yes Gerrit-Has-Labels: No
