aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2018-11-29manuals/OsmoNITB: integrate into this repositoryOliver Smith13-6039/+0
Move from doc/manuals to manuals/OsmoNITB as we have two more manuals (OsmoMGCP and OsmoNAT) that need to be moved to manuals/. Make the manuals build without a toplevel configure.ac file from autotools: $ cd manuals/OsmoNITB $ make openbsc/configure.ac is not used to integrate the manuals, as it would be extra effort to integrate all three of the manuals there. This is not worth it for the legacy codebase. Related: OS#3385 Change-Id: I0036ad8dbecd23695305ac491c7ee87caa44c7f9
2018-11-28build manuals moved here from osmo-gsm-manuals.gitOliver Smith4-31/+36
Moved to doc/manuals/, with full commit history, in preceding merge commit. Now incorporate in 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: I4466d820cb3a5609a4a8534b1581684f891a04cd
2018-11-28vty/bsc_vty_additions.xml: copy from osmo-bscOliver Smith1-1/+10
Replace the symlink with a full copy, as the manuals are in the project repositories now. Related: OS#3385
2018-11-28author info: add "former" to Holger's job titleNeels Hofmeyr1-1/+1
It doesn't seem to have an effect on the generated PDFs though. Change-Id: I0556a3f8dafc051f20a3854fc9006edf4ec1a0d3
2018-11-28vty-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-28refactor Makefile build rules, don't use the FORCENeels Hofmeyr2-40/+7
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-28OsmoNITB: update vty referenceNeels Hofmeyr2-118/+761
Change node IDs to use the names derived from the node prompt, in the process fix the node references to not place the vty_additions in the wrong places. Related: I8fa555570268b231c5e01727c661da92fad265de (libosmocore) Change-Id: I48edb65be94be56c4b57293d8edc1b30271acc12
2018-11-28move smpp.adoc to common chapters, generalizeNeels Hofmeyr2-145/+1
OsmoMSC will need the same SMPP chapter as OsmoNITB. In smpp.adoc, replace program name with parameter, add parameter to OsmoNITB's main adoc and move smpp.adoc to common/chapters. Change-Id: I15febdea6569316dad3eed5f9dc7158adb5b078c
2018-11-28tweak common/mncc.adoc: use variable for program nameNeels Hofmeyr1-0/+1
Change-Id: I993a3c3bf617b9823f49898364b5f728a4549330
2018-11-28move mncc.adoc to common chaptersNeels Hofmeyr2-207/+1
Upcoming OsmoMSC will reference the same, hence MNCC becomes a common chapter. Move the file and adjust various wording to include OsmoMSC. Change-Id: I404758ff7f1372e841ffe33c75455f513fff3caf
2018-11-28Allow 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-28SMPP: Document Osmocom extensionsHarald Welte1-2/+51
Change-Id: I4cedd07a33633bdd2350d2bda0a22cc0c631c0a9
2018-11-28smpp.adoc: describe VTY cmd 'local-tcp-ip' instead of 'local-tcp-port'Pau Espin Pedrol1-4/+5
Change-Id: I594b89094413758146bb25f5262902e263f8f3d1
2018-11-28osmo-nitb: Update VTY command referencePhilipp Maier2-393/+1045
Change-Id: Ia4c2d71eeca853ef277e802e9e8e200eb3414bca
2018-11-28Add chapter on Cell Broadcast Support in Osmocom (to BSC+NITB manual)Harald Welte1-0/+2
Change-Id: I2c621def499dc0564d31eb9440e22e79948a5466
2018-11-28Describe how to run multiple instances of osmo-nitb and osmo-btsPhilipp1-1/+45
Change-Id: I69adeef85adda6f08b31b7d176f51e16968c1435
2018-11-28fix 'make clean': shell glob, ignore failureNeels Hofmeyr1-2/+4
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-28OsmoNITB: include abis.adoc from common/chapters/Neels Hofmeyr1-1/+1
Change-Id: If3d92fe19d402d77b0db0eb9d00efef0a8d02122
2018-11-28OsmoBSC+NITB/running: fix title levels, one too deepNeels Hofmeyr1-2/+2
Change-Id: If81e44c9a0774e5de39cc536989cef5cb214a224
2018-11-28add 'make check' targetNeels Hofmeyr1-1/+1
Generate *.check files from asciidoc output and grep for WARNINGs. Add *.check files to gitignore and to 'make clean'. Change-Id: Ibccc83a3415930a528f2e8e4e4dda3b81c6d0b64
2018-11-28make clean: also remove generated image filesNeels Hofmeyr1-0/+1
Change-Id: I80798e79b4ccee64f26f58f9754de02b2958e33e
2018-11-28Typo in Chapter 14.2Ivaylo Kostov1-1/+1
2018-11-28Add OsmoNITB control interface descriptionMax2-0/+59
2018-11-28fix various typos across all manualsJonathan Brielmaier4-5/+5
2018-11-28OsmoNITB HLR: expand on how to create subscribersHarald Welte1-18/+105
2018-11-28Add link to Asciidoc source code of manualHarald Welte1-0/+6
2018-11-28initial checkin of manuals to public repoHarald Welte13-0/+4859
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.