Commit Graph

30 Commits

Author SHA1 Message Date
Alexander Couzens b4045a0c69 OsmoBSC: add rate counter documentation
Change-Id: Ia8711dd4bc9db36a7121552dc067c7afb1051b0a
2018-11-27 17:12:40 +01:00
Max cef1d72ba8 OsmoBSC: update CTRL docs
* use proper naming scheme for BTS-specific CTRL commands
* add/update oml-* commands

Change-Id: I5b2cd940b4d84c140fce871f236aeab091b27360
Related: OS#2486
2018-11-27 17:12:40 +01:00
Neels Hofmeyr ea9a44dade refactor Makefile build rules, don't use the FORCE
The initial goal was to make sure we don't have overall FORCE rules causing
unnecessary rebuilds -- annoying while writing documentation. As I looked
through possible dependencies, I finally understood what's going on here.

Remove code dup and nicely sort which belongs where in build/Makefile.*.inc. In
each, describe in a top comment how to use it, and also unify how they are
used:

- Rename Makefile.inc to Makefile.docbook.inc and refactor
- Add Makefile.vty-reference.inc
- Add Makefile.common.inc

Make sure that we accurately pick up all dependencies.

Drop use of the macro called 'command', that silenced the actual command lines
invoked and replaced them with short strings: it obscures what is actually
going on and makes the Makefiles hard to read and understand.

Each manual's makefile is greatly reduced to few definitions and a Makefile
include, e.g. one for asciidoc, one for VTY reference.

Move common/bsc_vty_additions.xml to OsmoBSC/vty/libbsc_vty_additions.xml, link
from OsmoNITB. It applies only to OsmoBSC and OsmoNITB.

Add a script that combines a VTY reference file with *all* additions files
found in a manual's vty/ dir. Call this from Makefile.vty-reference.inc.

Change-Id: I9758e04162a480e28c7dc83475b514cf7fd25ec0
2018-11-27 17:12:40 +01:00
Pau Espin 88faeefdc9 Allow easily disabling GFDL references
All parts referencing GFDL can be easily disabled by removing the
'gfdl-enabled' attribute from the document.

Change-Id: I2489726ad2e90301bceadfada926e31ae0f85986
2018-11-27 17:12:40 +01:00
Harald Welte f77da129a8 MGW: Include MGCP endpoint naming scheme of old IPA/SCCPlite approach
Change-Id: Ib1fe96f0041534fa027b70ee67978cb7c6bc5207
2018-11-27 17:12:40 +01:00
Harald Welte d9400a977f mgw: Fix endpoint names for new MGW
According to RFC3435, an RTP bridge forrwarding packets, transcoding
or otherwise, is a single endpoint with two connections.  Let's treat
it as such.  We introduce the "rtpbridge/" prefix to identify such
special RTP endpoints.

Change-Id: Id1f079307225faf05d298dcb12aa1c421bfa680a
2018-11-27 17:12:40 +01:00
Pau Espin 1293ee10ba osmux: Fix description for Dummy frames FT field
Change-Id: Ia421655bd1be45101da3db2a0af44fbb3cc111c1
2018-11-27 17:12:40 +01:00
Pau Espin 9980b4aa1c osmux-reference-docinfo: Add latest changes to revhistory
Change-Id: I01e513a71a3f830d393c57c43678d7e4c8d2d151
2018-11-27 17:12:40 +01:00
Pau Espin 53ce68f977 osmux-reference: Add traffic saving plot
Change-Id: I8fa60c1f95436c39fd1ff9424a907876d367484e
2018-11-27 17:12:40 +01:00
Pau Espin 1ce6c62914 osmux-reference: Add sequence charts
Change-Id: Ic2c63e4d9e67b877dc06a206ec7f07d0704329a5
2018-11-27 17:12:40 +01:00
Pau Espin ac70cf9658 osmux-reference: Use packetdiag to draw packet header structures
Change-Id: Id75152278f41d56b7bd2e652b9947e33d6523c64
2018-11-27 17:12:40 +01:00
Harald Welte f1d4251461 BSC: Add series of message sequence charts about MGCP handling
Change-Id: Id5948677d23a58ce112b57f91bea953a93baab4c
2018-11-27 17:12:40 +01:00
Harald Welte b75422f9d4 Add chapter on Cell Broadcast Support in Osmocom (to BSC+NITB manual)
Change-Id: I2c621def499dc0564d31eb9440e22e79948a5466
2018-11-27 17:12:40 +01:00
Pau Espin b120272f86 Add osmux-reference document
Change-Id: I4d19df98af84560c147a637bc42ebe570bb280aa
2018-11-27 17:12:40 +01:00
Ivaylo Kostov 931ec5a5b6 BSC,BTS: add diagrams of PCU-BTS-NITB-SGSN relationships
Change-Id: I0eb09706efb768fa4f6810872fb6568cbc9838cb
2018-11-27 17:12:40 +01:00
Neels Hofmeyr 7f7ca91a04 fix 'make clean': shell glob, ignore failure
Unfortunately a glob like osmo-x__*.{svg,png} doesn't work, so have the
suffixes in separate globs.

Add dashes to indicate that failure should be ignored.

Change-Id: I6bc4d9ea72b43a573acbc860c23397f748de2c7b
2018-11-27 17:12:40 +01:00
Neels Hofmeyr d0f60df769 OsmoBSC: include bts-examples.adoc from OsmoNITB
Change-Id: I6b6d8c413762c710453b228f846216961b578597
2018-11-27 17:12:40 +01:00
Neels Hofmeyr 4c297e7b93 OsmoBSC+NITB/running: fix title levels, one too deep
Change-Id: If81e44c9a0774e5de39cc536989cef5cb214a224
2018-11-27 17:12:40 +01:00
Neels Hofmeyr 4d8fc869bf add 'make check' target
Generate *.check files from asciidoc output and grep for WARNINGs.
Add *.check files to gitignore and to 'make clean'.

Change-Id: Ibccc83a3415930a528f2e8e4e4dda3b81c6d0b64
2018-11-27 17:12:40 +01:00
Neels Hofmeyr b667aefb66 make clean: also remove generated image files
Change-Id: I80798e79b4ccee64f26f58f9754de02b2958e33e
2018-11-27 17:12:40 +01:00
Harald Welte 92c845eca5 OM2000 MSC: Fix spelling 2018-11-27 17:12:40 +01:00
Harald Welte 132e0861b8 OM2000 message sequence charts: specify MO in node name 2018-11-27 17:12:40 +01:00
Harald Welte d588a95904 add Ericsson OM2000 message sequence charts (one for each MO) 2018-11-27 17:12:40 +01:00
Max 7f3d8ea4d3 Add OsmoBSC control interface description 2018-11-27 17:12:40 +01:00
Neels Hofmeyr 1d772228e4 minor tweak 2018-11-27 17:12:40 +01:00
Jonathan Brielmaier 1389bd1756 fix various typos across all manuals 2018-11-27 17:12:40 +01:00
Max 2e904b1385 Add OsmoBSC control interface description 2018-11-27 17:12:40 +01:00
Harald Welte a412d9041f Add link to Asciidoc source code of manual 2018-11-27 17:12:40 +01:00
Harald Welte 75c0e08acc initial checkin of manuals to public repo
The manuals existed in different form for several years in an internal
sysmocom repository.  However, since they had just recently been
converted from docboox-xml to asciidoc and all files have been
re-shuffled for enabling the public release, there's not much point in
keeping the history with git-filter-branch.
2018-11-27 17:12:40 +01:00
Neels Hofmeyr a46eaef1be Importing history from osmo-gsm-manuals
Change-Id: Ie4afca5e32be5fbaf4e42043b076dab2e91cc5ef
2018-11-27 17:05:04 +01:00