Commit Graph

570 Commits (master)

Author SHA1 Message Date
Pau Espin 08b5ff7ebb sigtran: Document SCTP INIT VTY parameters
Related: SYS#6558
Change-Id: I2a8c2b3708d72bf0974b17bf018f2c667ae6b824
2023-09-12 13:41:29 +02:00
Pau Espin 8ee1ca7084 Bump version: → 1.5.0
Change-Id: I7d4569f53b3dbbee8d5f0034448ade5f18cb6bbb
2023-09-12 12:24:04 +02:00
Pau Espin 3460af57bc sigtran: Document SCTP (peer) primary address configuration
Related: OS#6076
Related: SYS#6501
Change-Id: I8737ca3033293391c999395e2db1fe19cac3e911
2023-08-29 11:39:13 +02:00
Oliver Smith a3dc45e8d4 build: replace inkscape with rsvg-convert
Do not require having the graphical application inkscape and all its
dependencies installed, just to convert svgs to pdfs. This is still the
default in dblatex, even though converting on the command-line with
inkscape is deprecated. Use the lightweight rsvg-convert instead.

Merge at the same time as the docker-playground patch.

Depends: docker-playground I012c61eb777e6dc267dd4a52500da98c01ac1438
Change-Id: I0d132f8f6fd73fbe14b5bfa10a8659acaddf38f7
2023-08-17 13:03:49 +02:00
Oliver Smith cc71aeb2e7 build/Makefile.asciidoc: print less clutter
* Move the comments above the build targets, so they don't get printed
  during the build
* Remove the "TO REMOVE DRAFT MODE…" note. Printing this is no longer
  useful, the manuals for releases are now generated automatically with
  the Osmocom-release-manuals jenkins job, which removes the draft mode.
  There is no need to do this step manually.

Depends: osmo-ci Ia27cb8e4dd0204c0a91c322bed65bf8c9847a7be
Change-Id: I23d11bab274793eb8bcedc3fd9290901823e32d2
2023-08-04 13:09:06 +02:00
Pau Espin 3aba72f9e4 mgwpool: Document keepalive feature
Related: SYS#6481
Change-Id: I2cb4e2098b71b386278eb6026271a6d786a34c2a
2023-06-15 11:29:16 +02:00
Pau Espin eb6fa0a04c Write explicit role & sctp-role fields in ASP configurations
Change-Id: I00243a2d549e900f872826c2a4b025936797b5ef
2023-06-08 19:40:54 +02:00
Oliver Smith afc081e131 build/Makefile.docbook: fix INC_DIR for openbsc
When gets included by openbsc, the PWD Makefile
variable is empty (probably because the including file is not generated
by automake). Use the shell pwd command instead.

This fixes the master-openbsc jenkins job which has been failing since
previous patch dba860c7 ("VTY references: set git version and date")
was merged.

Related: OS#4063
Change-Id: I6026623ec9a5eef0ca8c47bf46605086e361c2bc
2023-05-16 11:49:39 +02:00
Oliver Smith dba860c733 VTY references: set git version and date
Fix that VTY references currently don't have the version from which they
were generated. Set the same REVNUMBER and GIT_DATE variables in (gets included in
as in Use them with a new script to rewrite the
<revhistory> block of vty references.

Closes: OS#4063
Change-Id: I68a8c3893d3c3a3b1bc1aee442a17635b60ac531
2023-05-11 17:05:58 +02:00
Oliver Smith c88a70d262 debian: set compat level to 10
Related: OS#5958
Change-Id: I4b2988fffba12cc84ff0834bb9ef0f3d9de2bcda
2023-04-25 16:48:22 +02:00
Pau Espin 5c88351a1e sigtran: Update supported xUA Traffic modes
Related: SYS#6412
Change-Id: I22110440e23faa7facaa5bcd0d57b3a6ef24d4a7
2023-04-13 16:20:38 +02:00
Harald Welte 58e8146179 chapters/spectrum: Extend disclaimer to Osmocom authors
Change-Id: I22dc5bde7a8d48c1a7dc876343ee66954afc2f8d
2023-03-22 10:09:52 +01:00
Harald Welte 21808eb4d2 preface: indicate where to ask for commercial support
Change-Id: I386d9bd31afe363677f23751d9ffe99f14800484
2023-03-22 10:09:52 +01:00
Harald Welte e6e07a7101 common/chapters: http -> https
Change-Id: Idf88e6141aad37d731a1955ad8b30f956c44a417
2023-03-22 10:09:52 +01:00
Harald Welte 9ec6183ca9 chapters/preface: Thank NLnet and WaveMobile
Change-Id: Ib887489fce522981df298594931100b9e553c291
2023-03-22 10:09:52 +01:00
Harald Welte 063523d11a chapters/logging: Expand documentation on GSMTAP logging
Change-Id: I9d7a15fd81bb0f3bc89b97ebfd35e9efc48c94e2
2023-03-22 10:09:52 +01:00
Harald Welte 9ff23bca66 chapters/cell-broadcast: Bring up-to-date with reality
This chapter was written at a time where OsmoCBC and the related
BSC support didn't exist yet.

Change-Id: If02adf2f9e7beeb7f238ab1c3aa74e8c0155db2b
2023-03-22 10:09:52 +01:00
Harald Welte 79a3b9e2c2 chapters/mncc: Update the wording to be less confusing and more up-to-date
Change-Id: Ic8876509878e565f140508dc2e3494b0e21c566c
2023-03-22 10:09:48 +01:00
Harald Welte cf76fcea5a chapters/*: Fix typos
Change-Id: I3c5cc64435c808f981d705d1d99c89fde2a6a74e
2023-03-22 10:09:25 +01:00
Oliver Smith 42cb9816db build/Makefile.common: full path for shrink script
Use the full path to, so it works as expected when the
symlinks are not present. This is how pysim uses the publish/shrink

Fix for:
  build/ _build/latex/osmopysim-usermanual.pdf
  make: build/ Command not found

Related: SYS#6380
Change-Id: Iba6e0e4932741adcb9e54e54eb7774716fb2e244
2023-03-20 11:15:46 +01:00
Oliver Smith 24cca7086b build/Makefile.common: shrink pdfs before publish
Closes: SYS#6380
Change-Id: I7c01b1cb1a0e7de385359671461a0ad142dfa5ad
2023-03-17 12:42:01 +01:00
Oliver Smith 33b5f5c889 build/Makefile.common: move clean/distclean down
Group upload and publish closer together by moving the clean targets to
the bottom.

Related: SYS#6380
Change-Id: Id8b6ead89a2aeba28e9c55bcfde6564376e8418a
2023-03-17 12:41:58 +01:00
Oliver Smith 2cef0dc72f Cosmetic: build/ add comments
Describe what upload and publish do, it's not clear from the name of
these make targets.

Related: SYS#6380
Change-Id: Ic2ab9df2192912d20ede0241abe01e8d26a9afcc
2023-03-17 12:41:54 +01:00
Oliver Smith 7a71db4d0a build/graphviz-filter.conf: add config for svgs
Add a custom graphviz-filter.conf, so asciidoc instructs graphviz to
generate svgs.

Related: SYS#6380
Change-Id: Iee54012c41f554608b0915d707f7cf64bfbdc418
2023-03-17 12:41:52 +01:00
Oliver Smith 18ee65de21 build/{diag,mscgen}-filter.conf: png -> svg
Generate svgs instead of pngs. Vector graphics have smaller file size
and don't look blurry when zooming into them.

Related: SYS#6380
Change-Id: I24f345a19adbc5abe41737233f89916996569ea8
2023-03-17 12:30:42 +01:00
Vilius Panevėžys 832258a471 Fix mistypes
Change-Id: I87da6bec137c7be37ec748ec1f9f8d072517022d
2023-03-15 19:32:44 +02:00
Oliver Smith 59d031823d build/ unset OSMO_REPOSITORY
Don't have a default value for OSMO_REPOSITORY, as this leads to manuals
getting uploaded to the wrong directory (publish) target and installed
to the wrong directory (install, uninstall).

Add checks to ensure the variable is set before using it in install and

Related: OS#5902
Change-Id: Ie21d58dd57a893a83f566eea464ab3eec82b67a4
2023-03-07 15:54:40 +01:00
Oliver Smith 2d2d795348 Change upload path to project/master/
Don't upload the manuals for master to "latest" anymore, this is
confusing given that we also refer to the most recent release as
"latest". Add the "master" directory to prepare a directory structure
where we can have manuals for each release:


Related: OS#5902
Change-Id: Id090422afbd7b91ac78cc30e19372ac1c828cb6b
2023-03-07 11:21:27 +00:00
Oliver Smith 8d34902bb7 editorconfig: new file
Add an editorconfig file so editors can figure out that the *.inc files
should be indented with tabs. At least neovim would use spaces

Change-Id: I93f8fa0c1f2721d12183f33f4a14e13b2deed80b
2023-03-07 08:18:30 +00:00
Max d306b4da29 SIGTRAN: fix typo
Change-Id: Ieea85e57be0dc3526234d40af3708839af38908c
2023-02-25 19:10:11 +03:00
Pau Espin 1e1967891e Bump version: → 1.4.0
Change-Id: I02531474b2ab2b026d9401d6ab820c0eb118cbd1
2023-02-07 11:43:11 +01:00
Max b22df211f5 rate counter: add StatsD note
Add passage explaining basic visualisation of stat and rate counter items
with Netdata so user can start utilizing them without any special

Related: OS#5671
Change-Id: I124503c3707bbe005abbfb4245abe2829c6ff57c
2022-12-23 20:46:20 +03:00
Harald Welte 15b74288c0 merge gb-ns2 "chapters" in one
The files gb-nsw-{configuration-timer,configuration,maintenance} were
not actually chapters, but sub-chapters or sub-sub-chapters.  This
breaks our general idea that all of those files are top-level chapters.

It also breaks asciidoc validation on Debian 11:

asciidoc: WARNING: gb-ns2-configuration.adoc: line 1: section title out of sequence: expected level 1, got level 2
asciidoc: WARNING: gb-ns2-maintenance.adoc: line 6: section title out of sequence: expected level 2, got level 3

the only place where they were used was the osmo-gbproxy manual, and
there in the exact sequenc in which I now merged them over here.

Change-Id: I3c618e5af61b376435f400ef9c64245cec2f9b73
2022-11-28 17:46:55 +01:00
Harald Welte 6b21af4ff0 gfdl.adoc: Fix cross-reference typo
Change-Id: I56abfc7467f77ec662351df8b64b9bb4185fa865
2022-11-05 22:44:42 +01:00
Harald Welte 92d8990886 doc: Add a general chapter on installation of the Osmocom software
This is just a very high-level overview on the different options.

Change-Id: Ia13929a7f932e0c30b9d564b76ada1549ef2a589
2022-11-05 21:00:19 +00:00
Harald Welte 7c47922fdb add a documentation snippet for systemd services
... this can be included from the various user manuals to insert some
general language about the systemd service units we ship, and a few key
systemd commands to get users started.

Change-Id: I8b04047cbc4097676d69fad794bb3139c05a4a5f
2022-11-05 20:54:01 +01:00
Pau Espin 574b6a97a1 mgwpool.adoc: Use {program-name} instead of BSC
Change-Id: Iab6560d833e405a36bab142759719377ad302667
2022-10-20 17:07:20 +02:00
Pau Espin 43e5c52682 mgwpool.adoc: Fix typo
Change-Id: I10370b508caf06b08505933b306d79825674a8fa
2022-10-20 16:41:26 +02:00
Pau Espin 51e3f86b04 Copy mgwpool.adoc from osmo-bsc.git
Copied from osmo-bsc.git/doc/manuals/chapters/mgwpool.adoc, version from
Change-Id Id0d292506e8b2a888c8d7a682a38db80e9d0933a

Related: SYS#5987
Change-Id: Ieda0d4bfe6fc90da6e19c791d8ec2da89427ba3b
2022-10-20 16:14:24 +02:00
Harald Welte 4234cc99e0 port_numbers.adoc: Allocate VTY port number for osmo-isdntap
osmo-isdntap is an ISDN protocol + call tracing utility currently
under development, see

Change-Id: I3c5d681ba086ed7cf7fdb0408465a433000c799c
2022-10-16 17:14:48 +02:00
Pau Espin 370958df99 osmux: Improve NAT related documentation
Related: SYS#5987
Change-Id: I5ed7aa834bfd0d5ef84ff69ece6d1d5e5b920d4e
2022-10-13 12:38:26 +02:00
Pau Espin 4c9264e0ba Document osmux use in Abis interface
Related: SYS#5987
Change-Id: Ic02d379f35f29f633d0fb14da3597481a0b8b8ba
2022-09-16 12:54:58 +02:00
Pau Espin 1ab6dbc62a osmux: Use local/remote CID terminology
This terminology is much more common and used in other protocols, like

Related: SYS#5987
Change-Id: Ia5eb833c296c504555f273a7fc3af5d746af19c0
2022-09-15 16:19:15 +02:00
Vadim Yanitskiy 35b5e27b02 TRXD: further clarify meaning of Training / Synch. Sequence Code
Both Synch. sequence and Training sequence are basically the same thing,
only the length is different.  I guess this is why 3GPP TS 45.002 names
them differently.  Let's mention them both to avoid confusion.

Change-Id: I092af5ef6b66f8bdbd46cc3ae0c77fd806f2fe27
2022-08-19 17:37:36 +07:00
Pau Espin c948dc4491 port_number.adoc: Add default osmux port
This has been the port used historically in most existing deployments,
and it's the one already documented in the osmux section of user

Change-Id: I9593e484a0df7cbfc3fa68f071246e3fb714bd4c
2022-08-12 14:11:55 +02:00
Pau Espin dda6a7e446 Bump version: → 1.3.0
Change-Id: I9487c26c6f1898481c25f227bc462b6867a05b70
2022-06-28 17:27:15 +02:00
Pau Espin 6984a40c6b sigtran: Use caps in section header
Change-Id: Ie7ff0dced649a29817a5a46e37eaaaf7ee22aea6
2022-06-28 15:06:41 +02:00
Pau Espin 6be6ffb9f3 sigtran: Remove old comment about non-implemented stuff
As supports multiple ASP with loadshare and override since a long time

Change-Id: I703c64a85636c2f9ebbd809e49c0dc8891cb9527
2022-06-28 15:03:04 +02:00
Harald Welte 9ad5777ffc port_numbers: Add missing records for osmo-upf, pfcp-tool, hnodeb
Seems like the instructions for adding new port numbers were not
followed when those entires were added to

Change-Id: Ie077bc375d45202f6004d0a3d45e5fc772d5641d
2022-05-13 10:20:39 +02:00
Harald Welte 02525c816e glossary: add CBSP, CBC, CBS
Change-Id: Iac405366b2191415ebb1e71154fc3bf31ad37a59
2022-05-13 10:20:39 +02:00