Commit Graph

551 Commits

Author SHA1 Message Date
Oliver Smith 42cb9816db build/Makefile.common: full path for shrink script
Use the full path to shrink-pdfs.sh, so it works as expected when the
symlinks are not present. This is how pysim uses the publish/shrink
targets.

Fix for:
  build/shrink-pdfs.sh _build/latex/osmopysim-usermanual.pdf
  make: build/shrink-pdfs.sh: 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/Makefile.common.inc: 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/Makefile.common.inc: 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
uninstall.

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:

  osmo-hlr/
  osmo-hlr/master/
  osmo-hlr/master/osmohlr-usermanual.pdf
  osmo-hlr/master/osmohlr-vty-reference.pdf

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
otherwise.

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.3.0.14-b22d → 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
configuration.

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
https://gitea.osmocom.org/retronetworking/osmo-isdntap

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
PFCP.

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
manuals.

Change-Id: I9593e484a0df7cbfc3fa68f071246e3fb714bd4c
2022-08-12 14:11:55 +02:00
Pau Espin dda6a7e446 Bump version: 1.2.0.12-6984 → 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
ago.

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
https://osmocom.org/projects/cellular-infrastructure/wiki/Port_Numbers

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
Harald Welte 2106fce829 bibliography: Add reference to TS 48.049 (CBSP)
Change-Id: Id1504cb8f9331f36b6085d238a43fe041703ab23
2022-05-13 10:09:35 +02:00
Harald Welte 9d0ef861a1 Add CBSP port number to default list of ports
Change-Id: Ifff8eb076bef29a64d9d20237fe5c8ee402788dc
2022-05-13 10:06:52 +02:00
Alexander Couzens 1f8a888261 common: gb-ns2: add chapter Gb/NS maintenance
Add chapter to describe common maintenance

Change-Id: I5571001a127c933397a4bc26e85410288d50fc2f
2022-03-01 18:15:51 +01:00
Alexander Couzens 5cba08b88d common: gb-ns2: fix typo in configures
Change-Id: Ia3d41d5fae8af7a35e86feba6ecb37c0692206b1
2022-02-22 19:03:13 +01:00
Alexander Couzens b1318e3c63 common: gb-ns2: correct ip.access static configuration
Change-Id: I652f7cda1e79e452af7740c1cae192a9f2b1acab
2022-02-22 18:20:02 +01:00
Alexander Couzens 0d173b3b99 common: gb-ns2: update ip-sns configuration example
Change-Id: I0b20634d683ad8f93c1c8af35eacbb953c1db46b
2022-02-22 18:19:55 +01:00
Alexander Couzens 389cc79742 common: gb-ns2: remove empty VTY chapter
Change-Id: Iee28046fbb0a5a034c2a33c495a3ca6f8ef953c4
2022-02-22 18:19:51 +01:00
Philipp Maier cccc44ded3 counters-overview: add documentation about socket statistics
How and when socket statistics are generated is not immediately obvious.
Lets add some documentation about it.

Change-Id: Icb06b3934e9ea5f3526263dc8915bc3529a64324
Related: OS#5701
2022-01-07 12:45:40 +01:00
Pau Espin 738c0840e0 Bump version: 1.1.0.18-cec5 → 1.2.0
Change-Id: Id9167fa8aa474bb6feb349a2dcecb015b2a1d3b4
2021-11-16 13:18:04 +01:00
Vadim Yanitskiy cec5b5d74d mncc: do not mention deprecated -m / --mncc-sock options
Change-Id: Icb18fb9e95c5a7f32a85a1b269185298c07354ee
2021-11-12 20:22:22 +03:00
Pau Espin b92c3ae264 cs7-config.adoc: Improve doc on default SS7 SCTP addresses
Related: OS#5186
Change-Id: Ic8d9c00ae50907f1adad8f70b773e7b1362c4f50
2021-10-05 17:25:28 +02:00
Oliver Smith 581ef10981 d/patches/build-for-debian8.patch: remove
Remove this workaround, as we are not building for debian 8 anymore.

Related: OS#5223
Depends: osmo-ci Ibe7ba124557969df62798ba49c4489e9606c2341
Change-Id: I8285b8c483fe2d136b83946414587fc993d5f489
2021-09-01 16:50:17 +02:00
Oliver Smith 1f1d93cf38 port_numbers: add osmo-pcap-client, -server
Related: OS#5203
Related: libosmocore I098f211370bba61995ce424ab64029bdd4c49e2d
Change-Id: Iebbb07bfa1ecb6597de9925f79eb8e0aff26ae4f
2021-08-05 19:17:27 +02:00
Vadim Yanitskiy 13f502bb6f TRXDv2: add primary/shadow classification for VAMOS PDUs
Introduce a new flag (1-bit field) indicating whether a VAMOS PDU
is for a _primary_ ('0'B) or for a _shadow_ ('1'B) timeslot.  This
field shall be present only in the Uplink VAMOS PDUs, which unlike
the Downlink (AQPSK) PDUs are sent separately.  This will simplify
routing of such PDUs in osmo-bts.

Change-Id: Ie00a12824938c6a65480bde1af364dcc9febb8f7
Related: SYS#4895, OS#4941, OS#4006
2021-06-02 04:36:42 +02:00
Harald Welte 5533b2ee48 glossary: fix various typos I introduced.
Change-Id: Iaf045bd20afb86384e00663df234197eed4d31c4
2021-04-28 17:38:15 +02:00
Harald Welte 2ee1a2f34d Add new common chapter about QoS, IP DSCP and IEEE 802.1q PCP
Related: SYS#5427
Change-Id: Id344c29eda2a9b3e36376302b425e9db1f6c0f28
2021-04-28 12:11:53 +02:00
Harald Welte e87733176f bibliography: Re-introduce RFC768 (UDP)
It's unclear why it was removed in I5fe6263ac666e41cbe34407f09e9023aafa57d2c
when common/chapters/glossary.adoc of this very same repository uses it.

Change-Id: Ib8d2f22450a84ed802b34845ad19a7af8d6b7968
2021-04-28 11:48:36 +02:00
Neels Hofmeyr 619c2cbfd8 bib: add reference to 3GPP TS 45.002, for Training Sequence definitions
Change-Id: I2d72bff8496d7b3a0ad59ce28d6be0fd3f842839
2021-04-22 18:48:55 +00:00
Harald Welte 811f3e8526 build: Switch from rita -> ftp.osmocom.org
We should use service-aliases and not the primary host name, as
that makes migration between machines hard.

Change-Id: Ie139a8cbf2aaa746c0edf6c90a567eb43bc51f45
2021-04-22 11:24:50 +02:00