The special 'all' keyword has been deprecated a long time ago
due to its ambiguity, and replaced by 'force-all'.
Change-Id: I759d96716e964d499c0724d481b2f3e5062fb052
Somehow despite all the warnings everywhere about keeping wiki + code
in sync, this didn't get updated :(
Change-Id: I37e4ea4e6ac8291a36761ecc1849f06847a69557
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Vadim Yanitskiy
Harald Welte
Daniel Willmann
Pau Espin
Oliver Smith
Martin Hauke