2017-04-07 11:20:57 +00:00
|
|
|
Dependencies needed, by example of a debian system:
|
|
|
|
|
|
|
|
|
|
apt-get install \
|
|
|
|
|
make \
|
|
|
|
|
asciidoc \
|
2017-11-17 21:48:41 +00:00
|
|
|
asciidoc-dblatex \
|
2017-04-07 11:20:57 +00:00
|
|
|
xsltproc \
|
|
|
|
|
dblatex \
|
|
|
|
|
mscgen \
|
2017-07-19 13:31:55 +00:00
|
|
|
graphviz \
|
2017-09-19 00:32:00 +00:00
|
|
|
python-pychart \
|
|
|
|
|
python-nwdiag
|
2017-04-07 11:20:57 +00:00
|
|
|
|
2017-11-17 21:48:41 +00:00
|
|
|
(Note that asciidoc-dblatex is required from debian 9 on and did not exist before.)
|
|
|
|
|
|
2017-04-07 11:20:57 +00:00
|
|
|
Build PDFs, run:
|
|
|
|
|
make
|
|
|
|
|
or for a parallel build using more CPU cores:
|
|
|
|
|
make -j 5
|
2017-09-19 00:32:00 +00:00
|
|
|
|
2018-03-06 13:52:23 +00:00
|
|
|
To update the VTY reference for a given program, use 'osmo_interact_vty.py -X',
|
|
|
|
|
available from git.osmocom.org/python/osmo-python-tests:
|
2017-09-19 00:32:00 +00:00
|
|
|
|
|
|
|
|
cd ~/osmo-python-tests
|
2018-03-06 13:52:23 +00:00
|
|
|
python3 setup.py install
|
2017-09-19 00:32:00 +00:00
|
|
|
|
2018-03-06 13:52:23 +00:00
|
|
|
osmo_interact_vty.py -X -p $VTY_PORT > vty/*_vty_reference.xml
|
2017-09-19 00:32:00 +00:00
|
|
|
|
2018-03-06 13:52:23 +00:00
|
|
|
Find the VTY port number at
|
|
|
|
|
https://osmocom.org/projects/cellular-infrastructure/wiki/Port_Numbers
|
|
|
|
|
|
|
|
|
|
For example, for osmo-msc, which has VTY port 4254:
|
|
|
|
|
|
|
|
|
|
a) with an osmo-msc already running:
|
|
|
|
|
|
|
|
|
|
osmo_interact_vty.py -X -p 4254 > OsmoMSC/vty/msc_vty_reference.xml
|
|
|
|
|
|
|
|
|
|
b) launching an osmo-msc along:
|
|
|
|
|
|
|
|
|
|
osmo_interact_vty.py -r "osmo-msc -c ~/src/osmo-msc/doc/examples/osmo-msc/osmo-msc.cfg" \
|
|
|
|
|
-X -p 4254 > OsmoMSC/vty/msc_vty_reference.xml
|
