Commit Graph

581 Commits

Author SHA1 Message Date
Oliver Smith acc127c022 debian/check-depends.sh: add inkscape to depends
Related: OS#4314
Change-Id: I83864af60ccb1ae4170c2cec90ce3f388cc305ae
2019-12-09 08:38:35 +01:00
Oliver Smith 0999d41794 Drop python2 and pychart dependencies
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-05 16:40:13 +01:00
Oliver Smith 33d3786e1c tests: add second VTY reference
Related: OS#4292
Change-Id: I2f0170e14febc68c0122062358f362003a2e3e5e
2019-12-03 11:45:03 +01:00
Oliver Smith a05e5940f1 Support multiple VTY reference manuals
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-03 11:44:57 +01:00
Oliver Smith 6ddd200cda Cosmetic: fix Makefile.vty.reference.inc example
All files listed in VTY_REFERENCE must end in ".xml".

Change-Id: I20abc1899f4bdf0a11482224937217dfddc17c53
2019-12-02 15:54:27 +01:00
Harald Welte f1499959dd gsup: Fix description of Purge MS procedure
Change-Id: I5386e438a12edbc6c2ffa3e63400dd2756bb1be6
Closes: OS#1921
2019-12-01 10:18:07 +01:00
Pau Espin b34ffdd069 trx_if.adoc: Fix typo and formatting of bullet list
Change-Id: I45c3ea655139d4777100af02d6b0d9cbf25b02e5
2019-11-22 16:29:58 +01:00
Pau Espin de57f626df Fix python-nwdiag dependency on new debian distros
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
2019-11-22 11:24:16 +01:00
Harald Welte 6084c89831 some more missing items from glossary.
Change-Id: I5b1b06342517042b77a42a57d506c8826b556267
2019-11-20 11:06:27 +01:00
Harald Welte 135fd1159d missing glossary items; mostly MSC/3G related
Change-Id: I61a03badbd63b211821f01ec16f64c28ac495952
2019-11-20 11:03:11 +01:00
Harald Welte 9a47d43e2d typo / stylistic fixes by Tom Tessier
Change-Id: Id3009c0c34dd84ab86ce9d34e7a94e0d1003c1ff
2019-11-20 11:02:52 +01:00
Martin Hauke 6239015e03 Fix some typos
Change-Id: Idd9f9640101816ab979b11cc13ffa12d2245108d
2019-11-11 22:08:00 +01:00
Pau Espin 7758a7fedb sigtran-osmocom.adoc: Fix typos
Change-Id: I31314dd36bac202103483bc93350736bfbc76be1
2019-10-09 18:40:24 +02:00
Oliver Smith 7e1ab03302 tests/Makefile.am: always put glossary at the end
Make sure that glossary.adoc is the last file, when building the test
pdf with all common chapters included. Otherwise, newer asciidoc
versions will complain that we cannot have subchapters after the
glossary began:

asciidoc: ERROR: mgcp_extension_osmux.adoc: line 2: glossary section cannot contain sub-sections

Related: OS#4183
Change-Id: I91e857255b1b6d5b8708cc7f7b303a58403120d3
2019-08-30 14:15:39 +02:00
Pau Espin 2333c9f0d1 Bump version: 0.1.1.9-5275 → 0.2.0
Change-Id: I0d1981a1b049bf5a5272210e8553698a6e1571da
2019-08-08 12:07:24 +02:00
Oliver Smith 5275f262c8 Makefile.asciidoc.inc: warnings check not default
Only check for asciidoc warnings in "make check" if
ASCIIDOC_WARNINGS_CHECK is set. Enable it in jenkins.sh by using the
new ./configure --enable-asciidoc-warnings-check parameter (similar to
--enable-werror in other Osmocom projects' configure.ac files).

Related: OS#4140
Change-Id: Iac993a0d1b17205397a1f1ef1a7bd3f9df739e36
2019-08-05 17:50:35 +00:00
Oliver Smith 2d5d6c54e8 Makefile.asciidoc.inc: always run verbose asciidoc
a2x is a "toolchain manager" for asciidoc, that runs the asciidoc
command internally. Replace the previous logic of first running a2x
without any verbose flags, and on failure running asciidoc standalone,
with a verbose flag, to print the errors the occured. Always run a2x
with -vv, so it runs asciidoc in verbose mode.

This prevents losing the error message in case asciidoc or a2x fail
when running with a2x, but then asciidoc succeeds when running
standalone.

Related: OS#4132
Change-Id: I2cbd2985645ecdecc7851849be6a9a95d4b3246e
2019-08-05 17:50:35 +00:00
Pau Espin 35ca68b762 common: trx_if.adoc: Add documentation about TRXDv1 and SETFORMAT
Change-Id: I320539fc9ffb7dd0f09ec18892299bd603cd7a85
2019-07-31 13:13:38 +02:00
Pau Espin c7fb3f28f4 common: trx_if.adoc: Improve documentation
Several fixes and improvements to the documentation.
This documentation still doesn't contain infrmation about TRXDv1, it
will be added in a follow-up commit.

Change-Id: I36e6206b90435964842f9f1ebd982cdaf9777018
2019-07-31 13:13:34 +02:00
Daniel Willmann abadcd5f8a counters-overview: Add a section about the stats reporter
Fixes: OS#3768
Change-Id: Ia338409e6cb1b1478429e3a99158b9d8255dbb2c
2019-07-25 17:26:25 +02:00
Oliver Smith c19708bf1a tests: pick up subdirs inside common/chapters
The Osmux documentation that will be introduced in [1] creates a
common/chapters/osmux/ subdir. Update tests/Makefile.am to pick up the
files in that directory too, so they get built by jenkins during gerrit
verification.

[1] I182d94c63f7d74ef882b77be59a95b1b7d8a4e5e
Change-Id: I4d1f440b7bfef159c98f918a2d23069594c4bc95
2019-07-22 19:49:16 +00:00
Pau Espin 061cca4d73 common: Introduce Osmux documentation
Change-Id: I182d94c63f7d74ef882b77be59a95b1b7d8a4e5e
2019-07-22 10:14:36 +02:00
Pau Espin 66f7bea317 Makefile.asciidoc.inc: Export commondir attribute to asciidoc files
Otherwise, adoc files in osmo-*/doc/manuals/chapters/*.adoc cannot
include files from osmo-gsm-manuals/common/chapters/*.adoc, since
symbolic link to common/ is only available in builddir, but not in
srcdir.

This way, those files can include commons files like this:
include::{commondir}/chapters/foobar.adoc

Change-Id: Ifc2fdaf1a87d0715213b4eab13c6c9a4f8a987fd
2019-07-19 16:39:13 +02:00
Oliver Smith 523862c2d5 contrib/jenkins.sh: run "make maintainer-clean"
Related: OS#3047
Change-Id: I99b9cd46e564cc1c5c1e92b9870368ff515a9356
2019-07-10 12:27:35 +02:00
Oliver Smith 001c5787fe Bump version: 0.1.0.8-09689 → 0.1.1
Change-Id: If5a1b56158f867f7f93a98e1a473a853c8c61439
2019-05-29 10:13:45 +02:00
Oliver Smith f4ba9ecd36 Makefile.am: include osmo-release.mk
Allow using the same release process, as with other Osmocom components:
https://osmocom.org/projects/cellular-infrastructure/wiki/Make_a_new_release

Related: OS#3899
Change-Id: Id31b8aa3f8c46509774c44ee027ab89862249766
2019-05-29 10:07:08 +02:00
Oliver Smith f1d55d9574 debian: more explicit dependencies for debian 8
Add dh-autoreconf to build dependencies, and libxml2-utils (provides
xmllint) to dependencies. Both need to be explicitly installed on
debian 8.

Related: OS#3899
Change-Id: If929fca73e3a88567e144eb296e7fadd32904dd5
2019-05-21 14:31:14 +02:00
Oliver Smith 92cf519c8d GSUP: document inter-MSC handover additions
Message formats of the new messages look mostly the same (IMSI,
Message Class, Source Name, Destination Name, AN-APDU). That is, because
AN-APDU is storing results, error reasons etc. This can be seen clearly
in osmo-msc.git:
* src/libmsc/msc_a_remote.c:msc_a_remote_fsm_communicating()
* src/libmsc/msc_i_remote.c:msc_i_remote_fsm_ready()

The message squence charts in the E Procedures section are directly
based on Neels' interMSC_HO_GSUP_msgs.txt [1].

It seems that using AN-APDU made some other new IEs redundant: RR Cause,
BSSAP Cause, Session Management Cause had been added to GSUP for the MSC
handover, and are documented now, but they are currently not used in
osmo-msc.git. The new message OSMO_GSUP_MSGT_E_ABORT is not used either,
so I left a stub for it in the message format section.

I mentioned in the Source Name IE section, that source and destination
names are sent as nul-terminated strings. This is for legacy reasons,
Neels wrote a nice summary in the commit message of [2].

[1] https://osmocom.org/attachments/3720/interMSC_HO_GSUP_msgs.txt
[2] Change-Id: I9ca8c9eef104519ed1ea46e2fef46dcdc0d554eb (osmo-msc)

Related: OS#3774, OS#3619
Change-Id: I6b9f23d08cfe53c8b77f51c6afb900c2badc9e2c
2019-05-21 10:30:38 +00:00
Oliver Smith 068153c39e debian: fix empty debian package
Replace '--with autotools_dev' with '--with autoreconf' in
debian/rules, so a ./configure file gets generated from configure.ac,
and the debian package scripts don't generate an empty package.

I did not notice this earlier, because when building the package locally
with dpkg-buildpackage, it was not empty. (That is probably, because my
local dir already had the configure script generated.)

Related: OS#3899
Change-Id: I483136cd28395ae8fc2c112cf659ee83255afe87
2019-05-21 11:56:59 +02:00
Harald Welte 5c1ac995db port_numbers: Add VTY + CTRL port of upcoming OsmoCBC
Change-Id: I57d88f2bddedb7a97c3fc7bacfe978ed4557c4bf
2019-05-08 15:49:50 +02:00
Oliver Smith 1d16a26c7e debian: add patch for debian 8
Add a patch file that removes the asciidoc-dblatex dependency in
debian/control, so the package builds for debian 8. In debian 8, the
files are all in the asciidoc package, which does get installed.

The jenkins scripts will copy the source package, apply the patch, and
upload it separately to OBS [1]. A similar debian 8 patch exists for
osmo-trx.

I have also tried to do it without a patch, by changing the OBS
configuration. It is possible to bypass the dependency check from OBS
and get the build started, but there's an additional check by
dpkg-checkbuilddepends and this one does not pass. So we really need
the patch method.

[1]: Change-Id I3570599ede51b974d350064f44f77e360fafd8b0 (osmo-ci)

Related: OS#3899
Change-Id: I5b9575ceb1141961e570643a5755a2bd6b6a4254
2019-05-08 11:52:26 +00:00
Daniel Willmann 37a7ce7f1d Change VTY samples from OsmoNITB to OsmoMSC
Change-Id: I9fb3c43ea56087900eee4427f1ae50a7c9e84698
Related: OS#2299
2019-04-15 16:47:18 +02:00
Daniel Willmann 95be64fc37 Add a chapter to explain our different counters
Change-Id: I01b8529136450cb50e48b0fb5c17cb2daa5e24c3
2019-04-15 14:06:32 +00:00
Oliver Smith a7b4d1b48f Bump version: 0.0.0 → 0.1.0
Change-Id: Ied515c46f7de5fb0224ac5b3d16ee2709d614202
2019-04-15 09:40:43 +02:00
Oliver Smith 754b29e023 Add debian packaging for osmo-gsm-manuals-dev
Allow including pdf manuals in each Osmocom repositories -doc debian
package, by depending on osmo-gsm-manuals-dev.

Related: OS#3899
Example usage: I4c184c62804c0b805a0a2425a5bd0312e94e49ab (osmo-bts.git)
Change-Id: I7edb5093e5b58eb3b0f7af2376476db4026db735
2019-04-12 14:32:25 +02:00
Oliver Smith b9a369c3e8 Makefile.am: proper noarch pkgconfig install dir
Don't install the noarch osmo-gsm-manuals.pc file to
$prefix/lib/x86_64-linux-gnu/pkgconfig when building a debian package
(dpkg-buildpackage seems to set $libdir accordingly). Always install to
$prefix/lib/pkgconfig.

The debian dir for creating a package from this repository will be added
in a follow up patch.

Related: OS#3899
Change-Id: I63bc8ab6d2845751079f40383d2aa92c709ce2fe
2019-04-12 14:32:25 +02:00
Oliver Smith 5501ba607b Makefile.common.inc: add {,un}install targets
Allow installing generated pdfs with 'make install' in all Osmocom
projects using osmo-gsm-manuals. This makes proper debian packaging of
the manuals easier.

Autotools will automatically run this file's install target, when
running 'make install' in the top source dir. Do not install anything,
when OSMO_GSM_MANUALS_NO_INSTALL is set, and set this variable for the
tests dir, so we don't install the test pdfs.

Related: OS#3899
Change-Id: I66f33172fa410681acbaef4592e9405627948705
2019-04-12 14:32:20 +02:00
Oliver Smith 7390b95c11 check-depends.sh: don't depend on git binary
Remove git from depends, because it isn't needed when building the
manuals from a source tarball. Avoid having git in the build
dependencies of the upcoming manuals packaging for debian.

Related: OS#3899
Change-Id: I46ad818a1d009c03357821f7c8100ecb5d62962e
2019-04-10 14:48:15 +02:00
Oliver Smith 89e1e74d86 build/unix-time-to-fmt.py: use default python ver
Don't explicitly depend on python 3, so we don't need to have python 2
*and* python 3 installed to build osmo-gsm-manuals.

The script is short and works fine with either python version.

Related: OS#3899
Change-Id: I8af9b8159f5c7e39b905f85edd1584cb4d5a33ef
2019-04-10 14:33:46 +02:00
Daniel Willmann ece90c1377 bts: Change VTY sample output from OpenBSC to OsmoBSC
Change-Id: Id473b625f47b3cf7ee10ced866d49eb678161719
2019-04-04 11:31:05 +02:00
Harald Welte 4c946ee293 fix typo: SIGTAN->SIGTRAN
Change-Id: I4b9ed7d61a23cf327889b3e513af74e8c86b161c
2019-03-13 07:59:41 +01:00
Oliver Smith 40c5c2827a chapters/gsup.adoc: move IMEI IEs to right place
Move the "IMEI" and "IMEI Check Result" IEs from the "Session
(transaction) management" chapter (which describes session IEs) to the
"Information Elements" chapter. Add a comment to prevent this mistake in
the future.

Related: OS#2541
Change-Id: I6fd66419350e018a763b8fac3daf567b339a2637
2019-02-22 13:20:11 +01:00
Harald Welte ac42b58909 chapters/gsup.adoc: add message sequence charts for SMS over GSUP
Change-Id: I9a0536f285f98f24fec4d7318f1923782ed2e18c
Related Change-Id: Ie0150756c33c1352bc4eb49421824542c711175c
Related Change-Id: I549b6c8840a1e86caac09e77fb8bc5042d939e62
2019-02-19 18:08:18 +00:00
Oliver Smith 68bbdc5f02 GSUP: message category indicated by last two bits
Make this part of the specification, so we can simplify libosmocore
code by knowing that error message is (request message | 0x000001).

Related: I46d9f2327791978710e2f90b4d28a3761d723d8f (libosmocore)
Change-Id: Iec1b4ce4b7d8eb157406f006e1c4241e8fba2cd6
2019-02-01 16:05:12 +01:00
Oliver Smith 2bca846fab common: extend glossary.adoc
Add EIR, IMEISV, LU, SS, TS, USSD, and VLR, clarify the difference
between IMEI and IMEISV.

Change-Id: I054a8599a78eb5e62ab7af914875e1c8a992af71
2019-01-21 15:08:39 +01:00
Oliver Smith 0f41399d36 chapters/gsup.adoc: document CHECK-IMEI
Related Change-Id: (core) I085819df0ea7f3bfeb0cabebb5fd1942a23c6155
Related: OS#3733
Change-Id: I51dd09cda3c595f1d252546285ced9f06c748617
2018-12-21 16:11:50 +01:00
Oliver Smith c7afad3f4e chapters/gsup.adoc: explain msg format columns
Explain the M, O, C and V, TLV letters in the presence and format
columns.

Change-Id: Idf8614d4d0f462174426fd3afdb34bedfb859951
2018-12-21 16:02:20 +01:00
Vadim Yanitskiy d1596fe75a chapters/gsup.adoc: document READY-FOR-SM message
Change-Id: I549b6c8840a1e86caac09e77fb8bc5042d939e62
Related Change-Id: (core) Ic37f3b2114b8095cfce22977e67133b9103942e3
Related Change-Id: (TTCN) If2256607527ecfcb10285583332fb8b0515d7c78
Related: OS#3587
2018-12-18 00:52:05 +07:00
Vadim Yanitskiy f26967aad5 chapters/gsup.adoc: document MO-/MT-forwardSM messages
Change-Id: Ie0150756c33c1352bc4eb49421824542c711175c
Related Change-Id: (core) Ibe325c64ae2d6c626b232533bb4cbc65fc2b5d71
Related Change-Id: (TTCN) Ibf49474a81235096c032ea21f217170f523bd94e
Related: OS#3587
2018-12-18 00:51:47 +07:00
Oliver Smith d379a0e33c Makefile.common.inc: publish: don't depend on check
The 'check' target is only available when including
Makefile.asciidoc.inc, which is not always the case. Some projects only
build the VTY reference. Do not depend on check, so publishing the
VTY reference for these projects is working as expected.

Related: OS#3385
Change-Id: I64aae0016095d81ca9e9ebda9a2e3336ac126639
2018-12-07 16:01:58 +01:00