summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
6 dayscs7-config: Reference the OsmoSTP user manual for more info on SS7HEADmasterHarald Welte1-0/+4
Change-Id: I2ae95e41ac7c3f7219b353ec1968ac5f5772a5f0
6 dayscs7-config: Explain that A/Iu/Lb interfaces are reouted via STPHarald Welte1-0/+11
Change-Id: Iabba390b41b9d2ad9c3975a6e6cc504a56e59d0b
6 dayscs7-config: Mention OsmoSMLCHarald Welte1-0/+1
Change-Id: I07ec996393c00f13a73eddb3503c019418523ee6
6 dayssigtran: Describe sctp/m3ua role, multi-homing, traffic-modesHarald Welte1-0/+62
Change-Id: I4c54dbde5a0b0f6ae38efdd047b17b4dbaae12c3
6 dayssigtran: Mention that M3UA was chosen by 3GPPHarald Welte1-0/+3
Change-Id: I2bc7cfdcada9e524f0fa6d7fe98f4bed8614363d
2020-11-06Makefile.common.inc: make 'publish' target use $(UPLOAD_FILES)Vadim Yanitskiy1-4/+2
In some projects, the VTY reference PDFs may be located in sub- directories. Let's use $(UPLOAD_FILES), it already contains the list of all *.pdf files to be uploaded / published. Change-Id: I7d46dc3b67dee1a91f3ade5a166d833df816abd4 Related: SYS#4937
2020-11-03Makefile.docbook.inc: generate *.pdf in the given directoryVadim Yanitskiy1-1/+1
Change-Id: If6d19dd0359239582d41ab3577c4b8bada4c81b8 Related: SYS#4937
2020-11-02vty_reference_combine.sh: print the final result to stdoutVadim Yanitskiy2-17/+18
This is a follow-up change for [1], making this script more flexible. It's now a task of the caller to store the merge results to a file. This approach allows to merge several *.xml files and store all the results in a single directory. Unfortunately, it's impossible to pass the same file as both input and output to xsltproc, because it would immediately overwrite its input. To work this around, create two temporary files and remove them at the end of the script. [1] Iabe729af22c235cf9c4b252acda99b43ebcae20c Change-Id: I6aac73d998c5937894233631e654a160d5623198 Related: SYS#4937
2020-11-02Makefile.docbook.inc: allow to re-define the include directoryVadim Yanitskiy1-1/+4
Change-Id: I08481319bbe14c3f45bf38bafa478de239751400 Related: SYS#4937
2020-11-02Makefile.vty-reference.inc: create 'generated' in this fileVadim Yanitskiy2-11/+15
Ideally, 'vty_reference_combine.sh' should not create any files nor directories on its own; it should do exactly what its name suggests - combine several XML files into a single one. Let's first make the target directory ('generated') creation a task of 'Makefile.vty-reference.inc', and then make it output the results to stdout in a follow-up change. Change-Id: Iabe729af22c235cf9c4b252acda99b43ebcae20c Related: SYS#4937
2020-11-02Makefile.docbook.inc: fix incorrect variable name in documentationVadim Yanitskiy1-1/+1
Change-Id: I1d451820fdf8b7d4dd1b48065eaa7617919af392
2020-10-30chapters/vty: add in-place comments to the attribute examplesVadim Yanitskiy1-5/+9
Change-Id: Ic68ca1de32e6ceceb75039045bf28d6680a59287 Related: SYS#4937
2020-10-30chapters/vty: add documentation for the expert modeVadim Yanitskiy1-0/+37
Change-Id: Ic43fbef8df77ad5561ca4521a29bc9f60bd3d7ac Related: SYS#4910
2020-10-24chapters/vty: add IPv4/mask and IPv6/mask examplesVadim Yanitskiy1-0/+3
Change-Id: I0946cf8629c4a77dfa8e9be90da85c2988ecef38
2020-10-14biblio: Add 3GPP TS 31.103 (ISIM)Harald Welte1-0/+3
Change-Id: I7ca068ff5cb8a21b1a48f95b8b7b660ae0f0dae0
2020-10-09vty: explain how command attributes are usedPhilipp Maier1-0/+88
The VTY features a method to associate commands with certain attrubutes. Tell the VTY user how to use the help to display the attributes and their meaning. Change-Id: If03e07f1f8e7e3c0166a00e3f395e2a46a9a7713 Related: SYS#4937, OS#1601
2020-10-07vty_reference.xsl: also handle 'global' and 'library' attributesVadim Yanitskiy1-1/+56
Unfortunately, there is no xsl:function support in XSL 1.0, so we have to duplicate the existing code :/ For more details about the attribute scopes / types, see: https://lists.osmocom.org/pipermail/openbsc/2020-October/013278.html Change-Id: I7f7e6e32c156de24dcc80166a29119e6dda8c169 Related: SYS#4937
2020-09-21vty_reference.xsl: handle application specific attributesVadim Yanitskiy1-0/+25
Change-Id: I17794b2cb476bd54c7b35a1e23c0727352c3a2a9 Related: SYS#4937
2020-08-26trx_if.adoc: Document RFMUTE TRXC commandPau Espin Pedrol1-0/+9
Change-Id: Id7031b52639f55d36d1589a786e0d29ebb5def53
2020-08-21port_numbers: Add port numbers for upcoming OsmoSMLCHarald Welte1-0/+2
Change-Id: I09c9a2141dda266999b89513f1faa86adfca8e6a
2020-08-10chapters: Introduce vty_cpu_sched.adoc chapterPau Espin Pedrol1-0/+117
Documents new features added in libosmocore.git Change-Id If76a4bd2cc7b3c7adf5d84790a944d78be70e10a. This file will be imported in user manuals of programs using the mentioned libosmovty features. Related: SYS#4986 Change-Id: Icd75769ef630c3fa985fc5e2154d5521689cdd3c
2020-07-20Drop common/chapters/{bts,bsc}.adocPau Espin Pedrol2-625/+0
Those files were only used by osmo-bsc.git and openbsc.git, the later being depreacted and not maintained. Hence, new features are added to the first one only, and documentation diverges over time, so it makes no sense to keep it shared. Files were copied over in: openbsc.git Change-Id Ic3b4192238be3147f61779845521eae84511fb7e osmo-bsc.git Change-Id I20aa60d2f4111d66e922f3e2a73a20352ec1f7e4 Change-Id: I4d98049f6b49871bf5aabe4392da7a608fbc1fe9
2020-06-29synchronize port_numbers.adoc with wikiHarald Welte1-0/+3
The osmo-uecups related ports were not added at the time, and the upcoming osmo-e1d VTY port had to be added, too. Change-Id: If4128991efdba3a1c3c38e6cd688593a212346f6
2020-06-18bibliography, glossary: add MSC pooling related bitsNeels Hofmeyr2-0/+11
Add 3GPP TS 23.236, "NRI" and "MSC pool". Depends: Ia60afc8a91189c9de0d8e8065781ed463bf18d7e (osmo-bsc) Change-Id: I0640db26dc85ab7723c7160e405fc73f412fd706
2020-06-08vty reference: allow reference XML generated at build timeNeels Hofmeyr2-4/+43
Add variable BUILT_REFERENCE_XML for callers to indicate dependencies for the VTY reference. Add script find_existing_path.sh to pick a given path from either builddir or srcdir, whichever exists. In Makefile.vty-reference.inc, use find_existing_path.sh to make the VTY reference build rules work no matter whether the reference.xml is built in builddir or committed in srcdir. Change-Id: I613d692328050a036d05b49a436ab495fc2087ba
2020-06-02trx_if.adoc: Document cmd NOMTXPOWERPau Espin Pedrol1-0/+8
TRXC message is implemented in: osmo-bts.git I682211f3d664c21f923ca4a530e0464ca383b6d9 osmo-trx.git I1d7efe56e008d8d60e23f9a85aa40809f7f84d9c Change-Id: Idb5bb56fc039c7393922243c761f3395a094a55b
2020-06-02trx_if: Clarify {SET;ADJ}POWER TRXC commandsPau Espin Pedrol1-10/+11
Change-Id: I4f1986a1ace3fc9cbef10fc0508407a3d608670b
2020-04-19GSUP: fix E-Routing-Error: both session state / ID IEs are optionalVadim Yanitskiy1-2/+2
If a message that has triggered the E-Routing-Error contains no session related IEs, they will also be absent in the error message. Change-Id: Iaf9d8e77c8734672cfd8a265b8cfdb3bc929a31b
2020-04-17port_numbers: fix: GSMTAP has noting to do with port 2427/udpVadim Yanitskiy1-1/+0
Change-Id: Ic37ee2e2da290521ac226a9720d48fbbe0883f3d
2020-04-17logging: fix section 6.5.3: logging level s/all/force-all/ fatalVadim Yanitskiy1-1/+1
The special 'all' keyword has been deprecated a long time ago due to its ambiguity, and replaced by 'force-all'. Change-Id: I759d96716e964d499c0724d481b2f3e5062fb052
2020-03-19add common/chapters/cs7-configNeels Hofmeyr1-0/+293
This will be used by the manuals of osmo-bsc, osmo-hnbgw, osmo-msc, osmo-sgsn. Related: OS#2767 Change-Id: Ia2508d4c7b0fef9cdc57e7e122799a480e340bf7
2020-03-08port_numbers: Add missing mDNS port for D-GSM / osmo-hlrHarald Welte1-0/+1
Somehow despite all the warnings everywhere about keeping wiki + code in sync, this didn't get updated :( Change-Id: I37e4ea4e6ac8291a36761ecc1849f06847a69557
2020-03-08port_numbers: Add osmo-mgw CTRL portHarald Welte1-0/+1
Change-Id: I41de762bbceeaf219d00bdc4e4f2c46c3b11c436 Related: OS#4441
2020-02-10fixup: ensure existence of $(abs_srcdir)Neels Hofmeyr1-1/+2
Use $(abs_srcdir) if present, or use `realpath $(srcdir)` otherwise. Previous commit introduced using $(abs_srcdir) instead of $(srcdir), but in setups with static makefiles (osmo-nitb and osmocom-bb), there is no $(abs_srcdir) set, which in effect broke their manuals build. Change-Id: I1db85c9319c79171bbc6de2f4f8d3a9db3b11b57
2020-01-24fix srcdir to reflect $abs_srcdirNeels Hofmeyr1-1/+1
When building .adoc files, we pass a srcdir variable to allow including files that are only in the source tree, but not in the build tree. However, so far {srcdir} is a relative path, and when an .adoc file includes an .adoc file in a subdir, then the directive include::{srcdir} is evaluated relative to the .adoc file in the subdir, not in the original make CWD. Hence the path ends up pointing at the wrong place. Fix this by passing an absolute path as srcdir instead. I discovered this here: osmo-hlr/doc/manuals/osmohlr-usermanual.adoc: include::{srcdir}/chapters/proxy_cache.adoc[] osmo-hlr/doc/manuals/chapters/proxy_cache.adoc: ["mscgen"] ---- include::{srcdir}/chapters/proxy_cache_attach.msc[] ---- (Note that I could have just removed "{srcdir}/chapters/" since .adoc and .msc are in the same dir, but the point of this patch is to make {srcdir} generally useful in all levels of included .adoc files.) The above resulted in: asciidoc: include: /n/s/dev/src/osmo-hlr/doc/manuals/chapters/proxy_cache.adoc asciidoc: osmohlr-usermanual.adoc: line 29: reading: /n/s/dev/src/osmo-hlr/doc/manuals/chapters/proxy_cache.adoc asciidoc: WARNING: proxy_cache.adoc: line 263: include file not found: /n/s/dev/src/src/osmo-hlr/doc/manuals/chapters/proxy_cache_attach.msc Note that /n/s/dev/src/src/osmo-hlr should only have one 'src' element. With $abs_srcdir this becomes: asciidoc: include: /n/s/dev/make/osmo-hlr/../../src/osmo-hlr/doc/manuals/chapters/proxy_cache.adoc asciidoc: osmohlr-usermanual.adoc: line 29: reading: /n/s/dev/make/osmo-hlr/../../src/osmo-hlr/doc/manuals/chapters/proxy_cache.adoc asciidoc: include: /n/s/dev/make/osmo-hlr/../../src/osmo-hlr/doc/manuals/chapters/proxy_cache_attach.msc asciidoc: proxy_cache.adoc: line 263: reading: /n/s/dev/make/osmo-hlr/../../src/osmo-hlr/doc/manuals/chapters/proxy_cache_attach.msc I have not investigated whether/why all the other 'include::' all over the place seem to be working -- maybe we never include .adoc in subdirectories that in turn use {srcdir}? Or we have lots of missing images we didn't notice yet? Todo: the missing include should have fatally broken the build, but it just builds the PDF with missing images. a) the mscgen plugin finding empty content and b) the missing .png files should have caused the build to abort? Change-Id: If847f16eab3ddba6009f67ed641b48805467eb1b
2020-01-09bts.adoc: Add information about RACH tuning parametersDaniel Willmann2-0/+60
Related: OS#2722 Change-Id: I9a6b84cb988be2143672b954e7c6827f691f4a01
2020-01-06bts: Document access control classes and acc rampingDaniel Willmann1-0/+47
Change-Id: Ia6fbd2da0d03dd372f3d1a34fbed8ac6fc7ed08c Related: OS#2722
2020-01-03Bump version: 0.2.0.18-258b → 0.3.00.3.0Pau Espin Pedrol1-0/+34
Change-Id: I555f20da93d4cad0998d5067b5999a4a253061a7
2020-01-03chapters/gsup.adoc: fix message definitions containing gsup-ie-pdpinfoVadim Yanitskiy1-3/+3
Change-Id: I7713635e15c1d0680fd8d8c11703683710d9c457
2020-01-03chapters/gsup.adoc: further documentation for SM-RP-DA/OA IE codingVadim Yanitskiy1-7/+30
Change-Id: I315ae412c83de80f09284c8c1f28faf360ac4662 Related: OS#4324
2019-12-26Add GPRSHarald Welte1-0/+2
Change-Id: Ib3218c035445875a079f3ef3aa72bbf6d8c668b6
2019-12-09D-GSM biblio entriesNeels Hofmeyr1-0/+8
Change-Id: Ief8dd1998e2445aea41fe9f0c8a98d6cd515c8a5
2019-12-09debian/check-depends.sh: add inkscape to dependsOliver Smith2-0/+3
Related: OS#4314 Change-Id: I83864af60ccb1ae4170c2cec90ce3f388cc305ae
2019-12-05Drop python2 and pychart dependenciesOliver Smith7-41/+4
Python 2 is EOL at the end of 2019, so don't depend on it anymore. Remove pychart support, because upstream is dead and there is no python3 version. We were only using it for one graph, and that has been replaced in osmo-bsc I36b721f895caee9766528e14d854b6aa2a2fac85. Depends: osmo-bsc I36b721f895caee9766528e14d854b6aa2a2fac85 Related: OS#2819 Change-Id: I57522e57e39682d6d123af4584785d327361e5a3
2019-12-03tests: add second VTY referenceOliver Smith4-2/+62
Related: OS#4292 Change-Id: I2f0170e14febc68c0122062358f362003a2e3e5e
2019-12-03Support multiple VTY reference manualsOliver Smith2-3/+43
Adjust vty_reference_combine.sh, so we can change the output dir from "generated" to a subdir inside "generated" when building anything but the first VTY reference. Add a generic pattern to Makefile.vty-reference for additional VTY references, that uses slightly different paths compared to the first VTY reference, in order to avoid collisions. Related: OS#4292 Change-Id: I4dea3e07b88175b2a88e577129360af7ec5f87e1
2019-12-02Cosmetic: fix Makefile.vty.reference.inc exampleOliver Smith1-1/+1
All files listed in VTY_REFERENCE must end in ".xml". Change-Id: I20abc1899f4bdf0a11482224937217dfddc17c53
2019-12-01gsup: Fix description of Purge MS procedureHarald Welte1-2/+3
Change-Id: I5386e438a12edbc6c2ffa3e63400dd2756bb1be6 Closes: OS#1921
2019-11-22trx_if.adoc: Fix typo and formatting of bullet listPau Espin Pedrol1-1/+3
Change-Id: I45c3ea655139d4777100af02d6b0d9cbf25b02e5
2019-11-22Fix python-nwdiag dependency on new debian distrosPau Espin Pedrol4-6/+6
As seen by https://packages.debian.org, python-nwdiag is only available in buster and older stables, while python3-nwdiag is available in both old and new releases as well as testing and unstable. Related: OS#4246 Depends: osmo-ci I0ebee6ac11df779ab954bd6648a0bebefc3350a2 Change-Id: Ia2c0c833329f8ecab1c427e0d2c002f17ab49a94