aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2019-12-05doc: osmux: use generated svg instead of pychartOliver Smith2-45/+824
Replace python 2 code using pychart to draw a graph in osmux-reference.adoc with the generated svg file. The upstream of pychart is dead, there is no python 3 version, and python 2 is EOL at the end of 2019. This is the only time we ever made use of pychart in osmo-gsm-manuals, so with this change, we can just drop the dependency. I've generated the chart by saving the python code in chart.py, then: $ ./chart.py --format=svg --font-size=3 > chart.svg Related: OS#2819, OS#4193 Depends: osmo-ci I754b133d77743582bd84c33c74ecc9eb9ca4c0ef Change-Id: I36b721f895caee9766528e14d854b6aa2a2fac85
2019-12-01manual: Fix copy+paste errorHarald Welte1-1/+1
Change-Id: I787c4bd4b30a6620a987efed4fd8b46e14a7ea64
2019-11-13Fix some typosMartin Hauke11-21/+21
Fix typos and common misspellings in code comments and in the manual. Change-Id: I46fc9d424620c77ae9ccf78b58081bd303386d7c
2019-09-04manual: Update statements regarding SCCPliteHarald Welte1-14/+7
SCCPlite is long supported (again) by osmo-bsc, let's remove the outdated pointers to osmo-bsc-sccplite. Change-Id: Ia3d831aca7c3c7ef9f257e974faf6e8e360c59f5
2019-09-02doc: update bsc_vty_reference.xmlHarald Welte1-34/+140
Change-Id: I6244a0de8802f437b5b291c76b4fc7bd4262baf8
2019-09-02Cell Broadcast: CBSP and CBCH scheduling supportHarald Welte3-5/+160
This adds code to handle CBSP (Cell Broadcast Service Protocol) from the CBC (Cell Broadcast Centre), as well as BSC-internal data structures for scheduling the various SMSCB on the CBCH of each BTS. There are currently one known shortcoming in the code: We don't yet verify if keepalives are received within repetition period. Change-Id: Ia0a0de862a104d0f447a5d6e56c7c83981b825c7
2019-07-24osmo-bsc.cfg: work with osmo-bts example cfgOliver Smith1-2/+2
Change cell_identity and unit-id to match osmo-bts-virtual.cfg. Related: OS#3369 Change-Id: Ie8001611756b661ff1871508c6248b2e990ba1d7
2019-07-22doc: Add Osmux documentation to User ManualPau Espin Pedrol2-1/+46
Depends: osmo-gsm-manuals.git f3a734e6777a902abfb03257277454c7a879aeb7 Change-Id: I75dcdddc713b0dc43e2ba577ca377c20fc511f38
2019-07-19vty: Fix typo in VTY command descrption -> descriptionHarald Welte4-14/+14
Let's add deprecated aliases for backwards compatibility Change-Id: I0e5da9d702910cf2571486e22a56f3ec17d0d67b
2019-07-16Fix some spelling errors found by lintianRuben Undheim1-3/+3
Change-Id: I63a733f8bea69f355a6686d99c3aa194c8ac9012
2019-07-09doc/manuals, vty doc: more handover doc clarificationsNeels Hofmeyr1-4/+6
Related: OS#3487 Change-Id: I1639efb2dbcca4f0e9c33a74f3067606ce5f4209
2019-06-18doc/manuals: review and tweak handover docsNeels Hofmeyr3-53/+62
Change-Id: Ib25cee8fd8c243881b99173a9a3036ad19d0f8af
2019-06-17manuals: Add script to update vtr/counter documentation from dockerDaniel Willmann2-0/+18
Run it like this: COMMIT=master DOCKER_PLAYGROUND=~/scm/osmo/docker-playground OSMO_INTERACT_VTY=~/scm/osmo/osmo-python-tests/scripts/osmo_interact_vty.py ./regen_doc.sh COMMIT will default to current HEAD. Change-Id: Iedd1f55d021231d86c19b6f14ff296e3a55148c8 Related: OS#1700
2019-06-06vty: adjust config name for unit-idEric Wild6-15/+15
Having different names for the same config setting is misleading, so let's stick to the one used by osmo-bts. Change-Id: Ide5ceb5db7403a70313405752579e30d7bb94eac
2019-06-06manuals: Update generated VTY reference and countersDaniel Willmann3-92/+281
Change-Id: I9f75edf2e5b88ef8f4592fa89548f32e0a7df8d8 Related: OS#1700
2019-05-29debian: create -doc subpackage with pdf manualsOliver Smith1-0/+1
I have verified, that the resulting debian packages build in my own OBS namespace (see the -doc packages): https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/ https://build.opensuse.org/project/show/home:osmith42 Depends: Ib7251cca9116151e473798879375cd5eb48ff3ad (osmo-ci) Related: OS#3899 Change-Id: I8dfb5658e567978aa8fe82f45d8287dbd1df969c
2019-04-17manuals: Fix example config to reflect OsmoBSC commandsDaniel Willmann1-13/+1
Change-Id: Ic38eec67a2cbbef57d1d6349f08249ec20ff7e8c Related: OS#2299
2019-04-17doc: Add generic counter chapter in manualDaniel Willmann2-1/+3
Depends: I01b8529136450cb50e48b0fb5c17cb2daa5e24c3 (osmo-gsm-manuals) Change-Id: Ida53d79787aedc5b37a68e6795a863cb0b4a343a
2019-02-05manual: Remove bogus "Control interface" sub-section in overviewHarald Welte1-22/+0
We meanwhile have chapters about the CTRL interface protocol as well as the auto-generated list of CTRL interface commands/values, so let's remove the somewhat redundant information. Change-Id: I062d7eec3b3fc53c31726be3b3a407a2dd3b8b56
2019-02-05manual: s/OsmoNITB/OsmoBSC/ in examples; remove E1 based BTSsHarald Welte1-99/+6
We still haven't re-introduced support for E1 based BTSs, so let's remove the relevant chapters from the manuals. Also, make sure we don't call anything OsmoNITB in this manual anymore. Change-Id: I834d65836731958b6be823a18e35407183398715
2019-02-05manual: Re-order chapters in more logical orderHarald Welte1-6/+6
It makes a lot of sense to first describe the VTY interface before going on using it to configure something. Also, configuration related topics relevant to operators/sysadmins should precede other content only relevant to developers, like the details of the CTRL or Abis/IP protocol. Change-Id: I0872d072bbb06f9409a72b93133d136167f03b38
2019-02-05manual: Add sections on 3G/4G neighbor cellsHarald Welte1-1/+102
This adds some instructions on how to configure 3G/4G neighbor cells within osmo-bsc. I didn't want to add a new top-level chapter but instead chose to add it to the handover section which describes also the configuration of 2G neighbors. Change-Id: I81df1a453858b6fca80c8adf234b1d5b8bf5283d
2019-02-05manual: It's not "A over SCCP" but "BSSAP over SCCP"Harald Welte1-14/+14
In GSM specs, the entire interface between two elements is designated with some letter, like the A interface between BSC and MSC. The interface uses a variety of protocols stacked on each other. In the specific case of A, there is no "A" on top of SCCP, but there's "BSSAP" on top of SCCP. This is followed somewhat un-orthodox by 3GPP, as "A over IP" is a violation of that principle. It should have been called "A utilizing IP", "A based on IP", "A with IP" or something the like. In any case, at no point do the specs ever claim that "A" is stacked on top of SCCP, so let's fix this. Change-Id: Ieb0d8f6c71debe1234aff343a994c2096326da1b
2018-11-27build manuals included from osmo-gsm-manuals.gitOliver Smith6-33/+47
Moved to doc/manuals/, with full commit history, in preceding merge commit. Now incorporate in local the build system. Build with: $ autoreconf -fi $ ./configure --enable-manuals $ make Shared files from osmo-gsm-manuals.git are found automatically if - the repository is checked out in ../osmo-gsm-manuals; or - if it osmo-gsm-manuals was installed with "make install"; or - OSMO_GSM_MANUALS_DIR is set. Related: OS#3385 Change-Id: I92c0f771d4ffc2b0401d26e25cb0b3817e6f95ea
2018-11-27Merge history from osmo-gsm-manuals.gitNeels Hofmeyr35-0/+8016
Change-Id: I9ff481784ba8c6334b1e57b1f64dfc9262e6d0e2
2018-11-27copy NITB's osmobsc-usermanual.adoc to OsmoBSCOliver Smith2-1/+282
Includes from other projects don't work anymore when moving project specific manuals into other repositories. Related: OS#3385 Change-Id: I96933dd4dd6cac159847647f1c642215051a9aad
2018-11-27OsmoBSC: update VTY referenceNeels Hofmeyr1-447/+505
Re-generate bsc_vty_reference.xml from osmo-bsc, including updates to: - handover and neighbor config - SCCP timers - logging Change-Id: Ia9ba8d5eba531b1156de57573ab42517e0c1ca15
2018-11-27OsmoBSC/HLR/MSC: Fix default config file nameDaniel Willmann1-1/+1
Mention that the default is not openbsc.cfg, but osmo-*.cfg Change-Id: I139e6004e28d6f918f31792e634214a6153edd0e
2018-11-27author info: add "former" to Holger's job titleNeels Hofmeyr2-2/+2
It doesn't seem to have an effect on the generated PDFs though. Change-Id: I0556a3f8dafc051f20a3854fc9006edf4ec1a0d3
2018-11-27bsc: handover: mention the need to resend SI for telnet neighbor cfgNeels Hofmeyr1-0/+9
Change-Id: I305ef558b75697015e2532aa7c135f7995662e0d
2018-11-27bsc: handover: clarify default of all-cells-are-neighborsNeels Hofmeyr1-0/+16
Change-Id: I61f877c7a60419132bdd27c1b4e64150c0520751
2018-11-27bsc: document handoverNeels Hofmeyr6-2/+642
Add chapter "Handover", explaining: - intra- and - inter-BSC handover, - HO algorithm 1 and - algorithm 2 - new neighbor configuration Adjust copyright, add revision and add me as author. Change-Id: I7afb3f66c98abda07fc8acc76e00c46091fe55e2
2018-11-27vty-ref: Update URI of docbook 5.0 schemaHarald Welte1-2/+2
... to match the /etc/xml/catalog file on debian (no "www" in hostname) Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d
2018-11-27OsmoBSC: update VTY referenceNeels Hofmeyr2-3065/+4790
This is the first update since the libosmocore changes to the 'show online-help' generated output. Hence the produced document now benefits from the structural improvements: - not repeating common commands for every node; - using section names that match the VTY prompt. Update bsc_vty_additions.xml to match the new node ID scheme. Change-Id: I0d856563eee88527fda4c6940aa6cea779175aaa
2018-11-27add message sequence chart MS/BTS/BSC/MSC for 3GPP aoIP MO callHarald Welte1-0/+146
Change-Id: I7e41234cfe1483bb73589dc959851a54f9aafa36
2018-11-27common / OsmoBSC: drop unused alink.adocNeels Hofmeyr2-17/+0
Change-Id: Ia3219359be891c161d20eccb7bbcb65af35ef42b
2018-11-27OsmoBSC: update overview to explain both SCCPlite and SCCP/M3UANeels Hofmeyr1-77/+91
Change-Id: I1f105b3febd4f99f4491e217ff1b1d0b28912980
2018-11-27OsmoBSC: add rate counter documentationAlexander Couzens3-0/+82
Change-Id: Ia8711dd4bc9db36a7121552dc067c7afb1051b0a
2018-11-27OsmoBSC: update CTRL docsMax1-13/+14
* use proper naming scheme for BTS-specific CTRL commands * add/update oml-* commands Change-Id: I5b2cd940b4d84c140fce871f236aeab091b27360 Related: OS#2486
2018-11-27refactor Makefile build rules, don't use the FORCENeels Hofmeyr2-49/+250
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-27Allow easily disabling GFDL referencesPau Espin Pedrol1-0/+2
All parts referencing GFDL can be easily disabled by removing the 'gfdl-enabled' attribute from the document. Change-Id: I2489726ad2e90301bceadfada926e31ae0f85986
2018-11-27MGW: Include MGCP endpoint naming scheme of old IPA/SCCPlite approachHarald Welte1-8/+8
Change-Id: Ib1fe96f0041534fa027b70ee67978cb7c6bc5207
2018-11-27mgw: Fix endpoint names for new MGWHarald Welte2-16/+16
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-27osmux: Fix description for Dummy frames FT fieldPau Espin Pedrol1-3/+3
Change-Id: Ia421655bd1be45101da3db2a0af44fbb3cc111c1
2018-11-27osmux-reference-docinfo: Add latest changes to revhistoryPau Espin Pedrol1-0/+8
Change-Id: I01e513a71a3f830d393c57c43678d7e4c8d2d151
2018-11-27osmux-reference: Add traffic saving plotPau Espin Pedrol1-79/+55
Change-Id: I8fa60c1f95436c39fd1ff9424a907876d367484e
2018-11-27osmux-reference: Add sequence chartsPau Espin Pedrol1-0/+189
Change-Id: Ic2c63e4d9e67b877dc06a206ec7f07d0704329a5
2018-11-27osmux-reference: Use packetdiag to draw packet header structuresPau Espin Pedrol2-16/+50
Change-Id: Id75152278f41d56b7bd2e652b9947e33d6523c64
2018-11-27BSC: Add series of message sequence charts about MGCP handlingHarald Welte7-1/+353
Change-Id: Id5948677d23a58ce112b57f91bea953a93baab4c
2018-11-27Add chapter on Cell Broadcast Support in Osmocom (to BSC+NITB manual)Harald Welte1-0/+2
Change-Id: I2c621def499dc0564d31eb9440e22e79948a5466
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-27 10:22:19 +0000