summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
2018-11-21cosmetic: update usage of OSMO_GSM_MANUALS_DIROliver Smith3-4/+10
OSMO_GSM_MANUALS_DIR should use pkg-config to figure out the location of the shared osmo-gsm-manuals files. (moving manuals to project repositories 6/19) Related: OS#3385 Change-Id: I64cfffb5104edcf7a20f41aeb5bf8ee6988b57c4
2018-11-21use autotools to add "make install" targetOliver Smith25-79/+131
For reasoning why a transition to autotools is desired, see the commit message of the previous patch in this series. "make install" copies the "build", "common" dirs, as well as the "*.xsl" files to $(prefix)/share/osmo-gsm-manuals. Prefix is typically /usr/local. Also a pkg-config file gets installed, so the path of the shared files can be looked up by autoconf scripts of the project repositories. The check-depends script is installed to $(prefix)/bin/osmo-gsm-manuals-check-depends and will be used by project specific autoconf scripts, too. All existing make targets ("make", "make check", "make upload") are still working, users only need to run "autoreconf -fi" and "./configure" beforehand. Makefile.am uses custom install-data-hook and uninstall-local targets, so we don't need to specify each file of the relevant subdirs in a _DATA variable (no extra maintenance effort). (moving manuals to project repositories 5/19) Related: OS#3385 Change-Id: I8e7036fae062ee783cb132b14608827a82c5e7c7
2018-11-20prepare for autotools: add git-version-genOliver Smith2-0/+155
Add the same version of git-version-gen, which most other Osmocom repositories (libasn1c, libosmocore, libosmo-netif, libosmo-sccp, ...) are using, so they behave the same. git-version-gen generates a version string derived from the git repository, or from a .tarball-version file when running outside of a git directory. Unfortunatelly it seems to be impossible to use git-version-gen from autoconf without adding it to the source tree. Autotools will be used to install the shared manual files into the system in a way that is consistent with the other Osmocom repositories: $ autoreconf -fi $ ./configure --prefix=/usr/local $ make $ make install Project repositories will check with pkg-config if osmo-gsm-manuals is installed (like any other shared Osmocom component), when a new configure flag for building the manuals is passed. This will also work with distribution's package managers, for instance we could have a osmo-gsm-manuals-dev package in Debian on which the other packages would have a build-time dependency to build the UNIX man pages (OS#3386). (moving manuals to project repositories 4/19) Related: OS#3385 Change-Id: I34b0d20046417179250a5065574e2bc303889cf6
2018-11-20s/TOPDIR/OSMO_GSM_MANUALS_DIR/gOliver Smith20-88/+88
Replace TOPDIR with OSMO_GSM_MANUALS_DIR. When the project specific manuals will be built out of this repository, we still need to refer to the top directory of the shared content. But it will be in another repository, so we need to rename the variable to avoid confusion. (moving manuals to project repositories 3/19) Related: OS#3385 Change-Id: I2af797546de048a6ab19a5cbc755e5e15575d7ab
2018-11-20tests: add shared content pdf build testsOliver Smith7-0/+121
Build project independent "test-usermanual.pdf" (with all common chapters automatically included) and "test-vty-reference.pdf" files. This allows testing if changed common chapters and the build scripts are still working, even when the project specific manuals will be moved away from this repository. (moving manuals to project repositories 2/19) Related: OS#3386 Change-Id: Ia74e32678c95e22ba493e80d0a4a8f783c5a5ddf
2018-11-20make check: properly reference dependenciesOliver Smith1-1/+1
Use $(ASCIIDOC_DEPS) instead of assuming that the value would be "chapters/*.adoc". The variable exists already, but it was not used yet in 'make check' of Makefile.asciidoc.inc. This allows creating a tests dir without its own chapters subdir (follow-up commit), which is part of a larger effort to move manuals to project repositories. The reason for moving manuals to project repositories is that we can have documentation changes together with code changes in the same patches. Not part of this patchset, but possible in the future, is optionally building UNIX man pages in the project repositories (OS#3386) as well as generating the VTY documentation on the fly from running the project binaries (OS#3695). (moving manuals to project repositories 1/19) Related: OS#3386 Change-Id: Id8b26759607a3490d6cbd93c68ba1f89aa8ef1f2
2018-11-18stp: update vty reference with added SCCP commandsNeels Hofmeyr1-1/+99
After I66e97706de0c546db3c6ff77fb5e6ac6e32bff55 which adds the missing sccp_vty_init(), update VTY reference with the new SCCP show / config commands. Depends: I66e97706de0c546db3c6ff77fb5e6ac6e32bff55 Change-Id: Id941b8e31d3b4cfdb3f912beedc1e7af321a0113
2018-11-18stp: update vty referenceNeels Hofmeyr1-55/+130
Change-Id: Id5f1067760db7a11ec380a541bfe7357a21a3bb3
2018-11-18sip-connector: update vty referenceNeels Hofmeyr1-14/+106
Change-Id: I79b91847337b6022f8f750533301b3bf0eb086df
2018-11-18sgsn: update vty referenceNeels Hofmeyr1-55/+252
Change-Id: I64d775efa6791aca025d116905e951e10ffa5d04
2018-11-18msc: update vty referenceNeels Hofmeyr1-157/+311
Change-Id: I31f1d388b5323af8ece8a71a82c1b91f80d404e1
2018-11-18mgw: update vty referenceNeels Hofmeyr1-14/+146
Change-Id: Ib30ea8b02f8a950648b85e7ebc96a40ba5a36b34
2018-11-18hlr: update vty referenceNeels Hofmeyr1-46/+184
Change-Id: I5a2322c0488cb36b089303bbfec5d4db18c41099
2018-11-18ggsn: update vty referenceNeels Hofmeyr1-44/+118
Change-Id: I8a5c37505c0180d5c04c7792d6d0afdb0dffb282
2018-11-18OsmoBSC: 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-18Logging: Describe all log options, including set-all and force-allDaniel Willmann1-0/+47
Change-Id: Ica03c3ea08289314819448a22ae7ed38a7bd4f83
2018-11-18common/chapters/bts: Remove duplicate spaces in textDaniel Willmann1-21/+21
Change-Id: I38f3e94342461f494ef547bcdccd2594c30e679d
2018-11-18Change OpenBSC mentions to OsmoBSC where applicableDaniel Willmann2-2/+2
Change-Id: I4cc6874302b6089a54d44b09f08660a25e46d4dc
2018-11-18OsmoBSC/HLR/MSC: Fix default config file nameDaniel Willmann3-3/+3
Mention that the default is not openbsc.cfg, but osmo-*.cfg Change-Id: I139e6004e28d6f918f31792e634214a6153edd0e
2018-11-18OsmoBTS: Fix typoDaniel Willmann1-1/+1
Change-Id: I0a4c9f052f14816e88ed0a4a5fff9b3854da195a
2018-11-18VTY: Remove osmo-nitb VTY port number exampleDaniel Willmann1-1/+1
We reference the port list appendix where all the ports used by various Osmocom projects are listed and it's unlikely that pointing out the osmo-nitb port would significantly help the reader, so just remove the reference. Change-Id: I354d50314ba248835191fa3da122032201618a0e
2018-11-18OsmoBTS: Print VTY command in fixed-width fontDaniel Willmann2-2/+2
Surrounding with '@' didn't seem to yield the intended result, the charactars appeared in the compiled document. Change-Id: I66e7949fa4a6c2164bf9572a2beaf8ace169fa1c
2018-11-18Abis: Change abisip-find/ipaccess-config path to osmo-bsc repoDaniel Willmann1-4/+7
Change-Id: I4b92a611abd6e92ad69f77f8ec81a6501224afe5
2018-11-16jenkins.sh: do not use libosomcore sourceOliver Smith1-12/+2
Build scripts do not depend on the libosmocore sources anymore with 161365f ("merge_doc.xsl: move from libosmocore.git"), so don't try to use them in jenkins.sh anymore. Related: OS#3385 Change-Id: Ied3661b8a02e9defca0e5aedcc4494845553db84
2018-11-12Makefile: move dep-check code to check-depends.shOliver Smith2-17/+31
Make it possible to run the dependency check without the Makefile. This is needed to split up the manual pages into the projects repositories, so we can call check-depends.sh from there. Related: OS#3385 Change-Id: I82a7efd7e9c265c82d1ba8a60856c892a15a7a33
2018-11-12merge_doc.xsl: move from libosmocore.gitOliver Smith3-8/+49
Allow building manuals without the libosmocore source. Related: OS#3385 Change-Id: Ifb81b18422987cdf36b75993d2782abf93b5f48c
2018-11-12unix-time-to-fmt.py: fix crash without argumentOliver Smith1-0/+4
Print "unknown" to stdout when unix-time-to-fmt.py was called without an argument, instead of printing a Python stack trace to stderr. It gets called that way when building outside of a git folder. Change-Id: I3ba27cc23543e47cc8a1e494c35cc33f1dc8f297
2018-11-12Makefile.asciidoc.inc: make clean: also rm *.htmlOliver Smith1-1/+1
HTML files get created when a2x fails and asciidoc runs. Change-Id: I4d5e9c36f75141ce88d11b16c89809be4dce87d8
2018-11-12Makefile.asciidoc.inc: always exit 1 on a2x errorOliver Smith1-1/+2
a2x wraps asciidoc. When a2x fails, we run asciidoc without a2x to print verbose output. Make sure that 'make' fails at this point, even if asciidoc runs through. Change-Id: I30931303ecc6094efaedcb08380433a34211a169
2018-11-01author info: add "former" to Holger's job titleNeels Hofmeyr3-3/+3
It doesn't seem to have an effect on the generated PDFs though. Change-Id: I0556a3f8dafc051f20a3854fc9006edf4ec1a0d3
2018-11-01bsc: handover: mention the need to resend SI for telnet neighbor cfgNeels Hofmeyr1-0/+9
Change-Id: I305ef558b75697015e2532aa7c135f7995662e0d
2018-11-01bsc: handover: clarify default of all-cells-are-neighborsNeels Hofmeyr1-0/+16
Change-Id: I61f877c7a60419132bdd27c1b4e64150c0520751
2018-11-01bsc: 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-10-05add SGs / CSFB related dot + msc filesHarald Welte7-0/+135
Those graphs + message sequence charts are not yet used by any of our manuals, but they should become used by the OsmoMSC user manual once SGs interface support is added. Related: OS#2583 Change-Id: Idfd3a66c18131b5458d183b8e66f62eaaab65991
2018-10-01mncc: add note about DTMF considerationsPhilipp Maier1-0/+26
Add an informative note on how DTMF signalling is done in mobile networks and mention the limitations regarding DTMF, when internal MNCC is used. Change-Id: Iedcf4ad5e0e4697c6a05ebdd4f43173c14c7c448 Related: OS#2777
2018-10-01mncc: add missing DTMF message types.Philipp Maier1-0/+30
The list that describes the MNCC message types lacks the message types used for DTMF. Change-Id: I4251b296e043e7583518d6672e614b376331d25e Related: OS#2777
2018-10-01running: Add note about DTMF supportPhilipp Maier1-0/+26
osmo-sip-connector does not yet support full DTMF support. The current implementation only supports DTMF tones to be send from MNCC to SIP, but not in the opposite direction. Change-Id: I578e50b0a42d88b05cf6da80443b71494b5eb26f Related: OS#2777
2018-09-25Add OsmoSIPConnector to master make fileDaniel Willmann1-0/+4
Change-Id: Icdb405abfa560846f1ebb848f8d8dd34610cfc89
2018-09-25osmo-sip-connector: Explicitly note OsmoMSC config with external MNCCDaniel Willmann1-0/+4
Change-Id: Ia186ea48b1012e65dc6446c839fdb548d44b6a6c
2018-09-20osmotrx: Introduce code architecture chapterPau Espin Pedrol3-0/+145
Change-Id: I21084e6315d79a1adcb305e12343da218837dc31
2018-09-20osmotrx: Create a common chapter for section documenting backendsPau Espin Pedrol1-3/+6
Change-Id: I6bea1ccca4ce72b92641a36f9f5894ac9a6cae72
2018-09-19osmotrx: configuration: Add section to document multi-arfcn featurePau Espin Pedrol1-0/+49
Change-Id: Id04c7f7c36d8a8be8145ef8009ece26ef1a7cdff
2018-09-19osmotrx: Write initial documentation for several supported devicesPau Espin Pedrol2-1/+68
Change-Id: I902b01ca661416eb9705afac8a34ec8d2fb13789
2018-09-19osmotrx: Split Device specific section from backend onePau Espin Pedrol3-26/+27
Device specific sections will be added to this new chapter. Change-Id: Id96cbf857e2ef92d9ad2cb58fd18132f981447d7
2018-08-30OsmoSIPConnector: fix: avoid OsmoMGW/OsmoSIPcon confusionVadim Yanitskiy1-7/+7
Change-Id: If20700d94775e91f174a1a07e00820ef0a91cd2f
2018-08-26OsmoMGW: document the 'X-Osmo-IGN' MGCP extensionNeels Hofmeyr2-0/+70
See also Ia6fe5ead4b601931c1bf41b29fc1b237aac37d2c in osmo-mgw.git, which changes the initial single-character implementation to match this specification of string tokens separated by spaces. Change-Id: If15a88c3b5b40fd1d24ad0f94f3231f678669ab1
2018-08-23Add manual for OsmoSIPConnectorDaniel Willmann6-0/+233
Ticket: OS#1684 Change-Id: I70d3014deb459e0b91a9a92c60710b994153538e
2018-08-23Add VTY reference for osmo-sip-connectorDaniel Willmann4-0/+1086
Ticket: OS#1684 Change-Id: I1045c20dd7234d425836ba93fa292a35ccddc7fd
2018-08-07hlr: Add chapter on USSD configurationHarald Welte2-0/+80
Change-Id: Ie5196ece9f340303bcb4868e3333a9698e28c3d0
2018-08-07Add initial OsmoMGW manualDaniel Willmann8-0/+282
Change-Id: I1b4ff96309d280c6a63105a6e06a82ec2e7b6908