The chapters are not 100% finished, as there is still some
implementation work going on in terms of the libosmogb 'ns2' code
as well as the introduction of the SGSN pool feature to osmo-gbproxy.
Change-Id: I0ba2ed2a72db52a7282f4f1055812644421b2a98
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
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
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
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
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
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
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
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
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
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
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
Vadim Yanitskiy
Harald Welte
Philipp Maier
Pau Espin
Neels Hofmeyr
Daniel Willmann