https://osmocom.org/https://osmocom.org/favicon.ico?16647414092018-03-17T23:42:17ZOpen Source Mobile CommunicationsOsmoBTS - Feature #3036: update vty reference -- and make it so that it can be done without manual editshttps://osmocom.org/issues/3036?journal_id=83232018-03-17T23:42:17Zlaforge
<ul><li><strong>Assignee</strong> set to <i>neels</i></li></ul><p>I think it's easiest to have separate reference manuals, one for each of the osmo-bts-* programs. This sticks with our existing tools, processes and the notion that we run one program and generat the vty reference for that program.</p>
<p>regarding osmo-bts exiting: it may be time to finally change that? This was a very early "fail fast" hack in 2011 or so.</p> OsmoBTS - Feature #3036: update vty reference -- and make it so that it can be done without manual editshttps://osmocom.org/issues/3036?journal_id=83322018-03-19T00:11:28Zneelsnhofmeyr@sysmocom.de
<ul></ul><p>laforge wrote:</p>
<blockquote>
<p>I think it's easiest to have separate reference manuals, one for each of the osmo-bts-* programs. This sticks with our existing tools, processes and the notion that we run one program and generat the vty reference for that program.</p>
</blockquote>
<p>ack</p>
<blockquote>
<p>regarding osmo-bts exiting: it may be time to finally change that? This was a very early "fail fast" hack in 2011 or so.</p>
</blockquote>
<p>(wrong issue? --> <a class="issue tracker-1 status-3 priority-2 priority-default closed" title="Bug: osmo-bts segfaults when osmo-bsc connection goes down (Resolved)" href="https://osmocom.org/issues/3011">#3011</a>?)</p> OsmoBTS - Feature #3036: update vty reference -- and make it so that it can be done without manual editshttps://osmocom.org/issues/3036?journal_id=201812020-10-28T20:45:21Zneelsnhofmeyr@sysmocom.de
<ul></ul><p>libosmocore now has this patch [1] which allows client programs to dump the XML reference to stdout directly.<br />At least some osmo-programs support that by the --vty-ref-xml cmdline option: dump the reference and exit</p>
<p>[1] <a class="external" href="https://git.osmocom.org/libosmocore/commit/?id=cf70aa0c40c574c32b832454f725cc37459c5d8d">https://git.osmocom.org/libosmocore/commit/?id=cf70aa0c40c574c32b832454f725cc37459c5d8d</a><br /> "enable vty xml dumping to stdout"</p>
<p>see also<br /><a class="external" href="https://git.osmocom.org/osmo-bsc/commit/?id=10983f206ba2d58424bd829c73ebc1ac7e9e7c0b">https://git.osmocom.org/osmo-bsc/commit/?id=10983f206ba2d58424bd829c73ebc1ac7e9e7c0b</a></p>
<p>Generating separate manuals for each BTS model is not addressed yet.</p> OsmoBTS - Feature #3036: update vty reference -- and make it so that it can be done without manual editshttps://osmocom.org/issues/3036?journal_id=201852020-10-28T21:00:47Zfixeria
<ul><li><strong>Status</strong> changed from <i>New</i> to <i>In Progress</i></li><li><strong>Assignee</strong> changed from <i>neels</i> to <i>fixeria</i></li><li><strong>Priority</strong> changed from <i>Normal</i> to <i>High</i></li></ul><p>Oh, I didn't know that we have a ticket for this problem. Nice!</p>
<blockquote>
<p>Should we change osmo-gsm-manuals to produce N different VTY references, one for each BTS model?</p>
</blockquote>
<p>Yep, this sounds like the most reasonable approach. Generating a single file with all model specific options would be better, but more complicated.</p>
<p>I am actually already working on it as a part of SYS#4937. Will submit the patches soon.</p> OsmoBTS - Feature #3036: update vty reference -- and make it so that it can be done without manual editshttps://osmocom.org/issues/3036?journal_id=201992020-10-29T02:49:01Zfixeria
<ul><li><strong>% Done</strong> changed from <i>0</i> to <i>80</i></li></ul><p>After several days of hard work, I am finally getting the first results: *.pdf files are generated separately for all BTS models.</p>
<p>Here are changes for osmo-gsm-manuals:</p>
<p><a class="external" href="https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/20950">https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/20950</a> Makefile.docbook.inc: fix incorrect variable name in documentation<br /><a class="external" href="https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/20951">https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/20951</a> Makefile.vty-reference.inc: create 'generated' in this file<br /><a class="external" href="https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/20952">https://gerrit.osmocom.org/c/osmo-gsm-manuals/+/20952</a> vty_reference_combine.sh: print the final result to stdout</p>
<p>and for osmo-bts-trx:</p>
<p><a class="external" href="https://gerrit.osmocom.org/c/osmo-bts/+/20956">https://gerrit.osmocom.org/c/osmo-bts/+/20956</a> doc/manuals: generate XML VTY reference at build-time<br /><a class="external" href="https://gerrit.osmocom.org/c/osmo-bts/+/20953">https://gerrit.osmocom.org/c/osmo-bts/+/20953</a> main: do not print asciiart to stdout, remove that printf()<br /><a class="external" href="https://gerrit.osmocom.org/c/osmo-bts/+/20954">https://gerrit.osmocom.org/c/osmo-bts/+/20954</a> main: register VTY commands before handle_options()<br /><a class="external" href="https://gerrit.osmocom.org/c/osmo-bts/+/20955">https://gerrit.osmocom.org/c/osmo-bts/+/20955</a> osmo-bts-lc15: use consistent name for containing directory</p>
<p>However, the generated *.pdf files still lack documentation for model-specific VTY options. The problem is that those options are registered when 'struct gsm_bts' is allocated (!), and not when the program starts. What's even worse, some commands depend on a global pointer to 'struct gsm_bts'. This needs to be reworked.</p> OsmoBTS - Feature #3036: update vty reference -- and make it so that it can be done without manual editshttps://osmocom.org/issues/3036?journal_id=202192020-11-01T12:16:29Zfixeria
<ul><li><strong>Status</strong> changed from <i>In Progress</i> to <i>Feedback</i></li><li><strong>% Done</strong> changed from <i>80</i> to <i>100</i></li></ul><p>I've finally managed to get the model specific options appear in the XML VTY reference:</p>
<p><a class="external" href="https://gerrit.osmocom.org/c/osmo-bts/+/20954">https://gerrit.osmocom.org/c/osmo-bts/+/20954</a> main: register VTY commands before handle_options()<br /><a class="external" href="https://gerrit.osmocom.org/c/osmo-bts/+/21010">https://gerrit.osmocom.org/c/osmo-bts/+/21010</a> main: move general options from bts_vty_init()<br /><a class="external" href="https://gerrit.osmocom.org/c/osmo-bts/+/21011">https://gerrit.osmocom.org/c/osmo-bts/+/21011</a> vty: call bts_model_vty_init() from bts_vty_init()</p>
<p>All changes are submitted for review, once merged - we can close this ticket.</p> OsmoBTS - Feature #3036: update vty reference -- and make it so that it can be done without manual editshttps://osmocom.org/issues/3036?journal_id=202822020-11-06T17:48:56Zfixeria
<ul><li><strong>Status</strong> changed from <i>Feedback</i> to <i>Resolved</i></li></ul><p>All changes have been merged, new PDFs are available:</p>
<p><a class="external" href="http://ftp.osmocom.org/docs/latest/osmobts-lc15-vty-reference.pdf">http://ftp.osmocom.org/docs/latest/osmobts-lc15-vty-reference.pdf</a><br /><a class="external" href="http://ftp.osmocom.org/docs/latest/osmobts-oc2g-vty-reference.pdf">http://ftp.osmocom.org/docs/latest/osmobts-oc2g-vty-reference.pdf</a><br /><a class="external" href="http://ftp.osmocom.org/docs/latest/osmobts-octphy-vty-reference.pdf">http://ftp.osmocom.org/docs/latest/osmobts-octphy-vty-reference.pdf</a><br /><a class="external" href="http://ftp.osmocom.org/docs/latest/osmobts-sysmo-vty-reference.pdf">http://ftp.osmocom.org/docs/latest/osmobts-sysmo-vty-reference.pdf</a><br /><a class="external" href="http://ftp.osmocom.org/docs/latest/osmobts-trx-vty-reference.pdf">http://ftp.osmocom.org/docs/latest/osmobts-trx-vty-reference.pdf</a><br /><a class="external" href="http://ftp.osmocom.org/docs/latest/osmobts-virtual-vty-reference.pdf">http://ftp.osmocom.org/docs/latest/osmobts-virtual-vty-reference.pdf</a></p>