Commit Graph

38 Commits

Author SHA1 Message Date
Harald Welte 3a61b920f2 manual: Add missing documentation for '-i' command line option
Change-Id: Iec0f2ecd610e63baba46a63d3e1a0979a9d8c5a8
2019-12-01 14:32:54 +00:00
Harald Welte f6d282822e manual: Fix documentation missing "-D" command line option
Change-Id: I2fd0b6f52ddc6931f413921b45d9756cb1fe456d
2019-12-01 14:32:54 +00:00
Harald Welte c925ccccfc manual: Fix copy+paste error
Change-Id: I27744628edeca6895f50f84c6f2f04c2e6e2de0b
2019-12-01 14:32:54 +00:00
Pau Espin 1e6eb30f51 Clarify (M)CS related VTY attributes
Some are used to control (M)CS values for downlink while some do it for
uplink. Let's make clear which one is used for what. Take the chance to
document the fields a bit better than they were.

Some more information about the origin of cs_downgrade_threshold can be
found in the commit introducing it: 70b96aa232.

Related: OS#4286
Change-Id: I4e890e924b094a1937fbd3794de96704cf0421a8
2019-11-28 17:11:56 +01:00
Pau Espin 1d8497ba6a doc: vty: Update osmo-pcu_vty_reference.xml
Change-Id: I287893cabf0468f0c110eb751eb887f58ff238c0
2019-11-28 17:09:09 +01:00
Pau Espin 28f160e76c Introduce osmo_tdef infra and timer VTY commands
This will allow for configuration of some of the timers by the user,
and allow him to inspect current values being used.
It will be also useful for TTCN3 tests which may want to test some of
the timers without having to wait for lots of time.

Timers are splitted into 2 groups: BTS controlled ones and PCU controlled
ones. The BTS controlled ones are read-only by the user (hence no
"timer" VTY command is provided to change them).

TbfTest.err output changes due to timers being set up correctly as a
consequence of changes. Other application such as pcu_emu.cpp and
pcu_main.cpp had to previosuly set the initial values by hand (and did
so), but apparently TbfTest.c was missing that part, which is now fixed
for free.

Depends: libosmocore.git Id56a1226d724a374f04231df85fe5b49ffd2c43c
Change-Id: I5cfb9ef01706124be262d4536617b9edb4601dd5
2019-09-12 14:17:07 +02:00
Oliver Smith 45fdc44d68 tbf_dl: make preemptive retransmission optional
Since [1], OsmoPCU already starts to retransmit downlink blocks before
the MS has had a chance to receive them and/or send the related
acknowledgement in uplink. Make this optional with the new VTY option
"no dl-tbf-preemptive-retransmission".

[1] e25b5b91f6 ("tbf: Only create dummy frames if necessary")
Related: OS#2408
Change-Id: Id08aed513d4033aa0d4324c6ce07cbb2852f2f92
2019-09-11 06:16:29 +00:00
Oliver Smith 37ae22ab13 doc: update generated VTY reference
Change-Id: I6243a2856df9db0f06e704e51e87113f9b57bb36
2019-09-11 06:16:29 +00:00
Daniel Willmann 79c6c4db3b manuals: Update VTY documentation
Related: OS#1700
Change-Id: I4a5da9b2b1caa625754383b0f9a180e7503bc60e
2019-06-19 12:43:02 +00:00
Daniel Willmann 76791d20f5 manuals: Add script to regenerate vty/counter documentation
Change-Id: Iff570e85828c87d69a7a49a00d9459094077ca30
Related: OS#1700
2019-06-19 12:43:02 +00:00
Oliver Smith a558ad4269 debian: create -doc subpackage with pdf manuals
I have verified, that the resulting debian packages build in my own OBS
namespace (see the -doc packages):
https://download.opensuse.org/repositories/home:/osmith42/Debian_9.0/all/
https://build.opensuse.org/project/show/home:osmith42

Depends: Ib7251cca9116151e473798879375cd5eb48ff3ad (osmo-ci)
Related: OS#3899
Change-Id: I9f2e7cfd93ee0b13d064c606a20378c1ea01400e
2019-05-29 12:14:18 +02:00
Oliver Smith 47aab58ec3 build manuals moved here from osmo-gsm-manuals.git
Moved to doc/manuals/, with full commit history, in preceding merge commit.
Now incorporate in the build system.

Build with:

$ autoreconf -fi
$ ./configure --enable-manuals
$ make

Shared files from osmo-gsm-manuals.git are found automatically if
- the repository is checked out in ../osmo-gsm-manuals; or
- if it osmo-gsm-manuals was installed with "make install"; or
- OSMO_GSM_MANUALS_DIR is set.

Related: OS#3385
Change-Id: I7270652de393a98748c0cdc51e626c17ab8f44c2
2018-11-27 18:30:56 +01:00
Neels Hofmeyr dfb08d31fe Merge history from osmo-gsm-manuals.git
Change-Id: I33ce528bb58a8a730a15cc8a7a74852a14f42921
2018-11-27 18:30:39 +01:00
Daniel Willmann 96481c8d3f Change OpenBSC mentions to OsmoBSC where applicable
Change-Id: I4cc6874302b6089a54d44b09f08660a25e46d4dc
2018-11-27 18:30:23 +01:00
Harald Welte 2eeddee132 vty-ref: Update URI of docbook 5.0 schema
... to match the /etc/xml/catalog file on debian (no "www" in hostname)

Change-Id: Id9f3579c7f2bc3af13fe30b5268f249b6f59ed0d
2018-11-27 18:30:23 +01:00
Alexander Couzens 57d91ea785 OsmoPCU: add rate counter documentation
Change-Id: Ieb4e1dab415a70ded5c65c21752dca497856e96f
2018-11-27 18:30:23 +01:00
Neels Hofmeyr d2829b89c1 refactor Makefile build rules, don't use the FORCE
The initial goal was to make sure we don't have overall FORCE rules causing
unnecessary rebuilds -- annoying while writing documentation. As I looked
through possible dependencies, I finally understood what's going on here.

Remove code dup and nicely sort which belongs where in build/Makefile.*.inc. In
each, describe in a top comment how to use it, and also unify how they are
used:

- Rename Makefile.inc to Makefile.docbook.inc and refactor
- Add Makefile.vty-reference.inc
- Add Makefile.common.inc

Make sure that we accurately pick up all dependencies.

Drop use of the macro called 'command', that silenced the actual command lines
invoked and replaced them with short strings: it obscures what is actually
going on and makes the Makefiles hard to read and understand.

Each manual's makefile is greatly reduced to few definitions and a Makefile
include, e.g. one for asciidoc, one for VTY reference.

Move common/bsc_vty_additions.xml to OsmoBSC/vty/libbsc_vty_additions.xml, link
from OsmoNITB. It applies only to OsmoBSC and OsmoNITB.

Add a script that combines a VTY reference file with *all* additions files
found in a manual's vty/ dir. Call this from Makefile.vty-reference.inc.

Change-Id: I9758e04162a480e28c7dc83475b514cf7fd25ec0
2018-11-27 18:30:23 +01:00
Pau Espin f605f3d891 Allow easily disabling GFDL references
All parts referencing GFDL can be easily disabled by removing the
'gfdl-enabled' attribute from the document.

Change-Id: I2489726ad2e90301bceadfada926e31ae0f85986
2018-11-27 18:30:23 +01:00
Philipp Maier 452b533114 configuration: fixing typos
configuration.adoc has some minor typos in it, this commit fixes
that.

Change-Id: Id84238b89e5deeac99c043b79b26c7e7b8b8534b
2018-11-27 18:30:23 +01:00
Neels Hofmeyr 5c8f1ccff0 fix 'make clean': shell glob, ignore failure
Unfortunately a glob like osmo-x__*.{svg,png} doesn't work, so have the
suffixes in separate globs.

Add dashes to indicate that failure should be ignored.

Change-Id: I6bc4d9ea72b43a573acbc860c23397f748de2c7b
2018-11-27 18:30:23 +01:00
Neels Hofmeyr 6bc5c2aac6 add 'make check' target
Generate *.check files from asciidoc output and grep for WARNINGs.
Add *.check files to gitignore and to 'make clean'.

Change-Id: Ibccc83a3415930a528f2e8e4e4dda3b81c6d0b64
2018-11-27 18:30:23 +01:00
Neels Hofmeyr 5828b60af5 make clean: also remove generated image files
Change-Id: I80798e79b4ccee64f26f58f9754de02b2958e33e
2018-11-27 18:30:23 +01:00
Jonathan Brielmaier 58721eb350 fix various typos across all manuals 2018-11-27 18:30:23 +01:00
Harald Welte 6fb29639df gb/NS: Clarify the language regarding the UDP port numbers / socket 2018-11-27 18:30:23 +01:00
Harald Welte 032f94b099 consistently use '3GPP TS' not sometimes 3GPP TS and sometimes TS. 2018-11-27 18:30:23 +01:00
Harald Welte 32b58e6418 gb: Some language improvements, formatting changes 2018-11-27 18:30:23 +01:00
Harald Welte a27873f1e2 Gb: Various spelling fixes 2018-11-27 18:30:23 +01:00
Harald Welte 3a89f21540 Gb message sequence chart: Add notion of PCU unix domain socket 2018-11-27 18:30:23 +01:00
Harald Welte d930b4d5f4 Gb message sequence chart: flip sides (SGSN should be right)
... also, re-word some of th labels for more clarity
2018-11-27 18:30:23 +01:00
Max 8f934f55d7 OsmoPCU: add MSC chart 2018-11-27 18:30:23 +01:00
Max b1776b65b3 OsmoPCU: expand BSSGP documentation 2018-11-27 18:30:23 +01:00
Max 4e2a1e3e98 OsmoPCU: expand NS documentation
Add table with NS messages.
Add corresponding sections.
Clarify spec numbers.
2018-11-27 18:30:23 +01:00
Max c182b98998 OsmoPCU: fix Gb documentation front page
Add date and commit refs.
Add relevant standards.
Fix email typo.
2018-11-27 18:30:23 +01:00
Harald Welte b682cd6a51 Initial place-holder for the new Gb/IP interface documentation 2018-11-27 18:30:23 +01:00
Harald Welte 4095f31fea Add link to Asciidoc source code of manual 2018-11-27 18:30:23 +01:00
Harald Welte 4ff37feb4c initial checkin of manuals to public repo
The manuals existed in different form for several years in an internal
sysmocom repository.  However, since they had just recently been
converted from docboox-xml to asciidoc and all files have been
re-shuffled for enabling the public release, there's not much point in
keeping the history with git-filter-branch.
2018-11-27 18:30:23 +01:00
Pau Espin 076122f592 Install osmo-pcu.cfg to docdir/examples
Change-Id: I42938d9abd17575c2e0ce69cc20d44a131f26b6a
2018-09-13 11:36:01 +02:00
Pau Espin ac5e3e222a Move examples/ to doc/examples/
Change-Id: I1e163e10f8a2e22b9ebdcb2d0f13f6ad07c84efe
2018-09-13 11:36:01 +02:00