Commit Graph

545 Commits

Author SHA1 Message Date
Oliver Smith dec39cdea9 s/TOPDIR/OSMO_GSM_MANUALS_DIR/g
Replace TOPDIR with OSMO_GSM_MANUALS_DIR. When the project specific
manuals will be built out of this repository, we still need to refer to
the top directory of the shared content. But it will be in another
repository, so we need to rename the variable to avoid confusion.

(moving manuals to project repositories 3/19)

Related: OS#3385
Change-Id: I2af797546de048a6ab19a5cbc755e5e15575d7ab
2018-11-20 17:13:25 +01:00
Oliver Smith e1fdd1ac20 tests: add shared content pdf build tests
Build project independent "test-usermanual.pdf" (with all common
chapters automatically included) and "test-vty-reference.pdf" files.

This allows testing if changed common chapters and the build scripts
are still working, even when the project specific manuals will be moved
away from this repository.

(moving manuals to project repositories 2/19)

Related: OS#3386
Change-Id: Ia74e32678c95e22ba493e80d0a4a8f783c5a5ddf
2018-11-20 17:13:25 +01:00
Oliver Smith 712e2a2e3f make check: properly reference dependencies
Use $(ASCIIDOC_DEPS) instead of assuming that the value would be
"chapters/*.adoc". The variable exists already, but it was not used
yet in 'make check' of  Makefile.asciidoc.inc.

This allows creating a tests dir without its own chapters subdir
(follow-up commit), which is part of a larger effort to move manuals to
project repositories.

The reason for moving manuals to project repositories is that we can
have documentation changes together with code changes in the same
patches. Not part of this patchset, but possible in the future, is
optionally building UNIX man pages in the project repositories
(OS#3386) as well as generating the VTY documentation on the fly from
running the project binaries (OS#3695).

(moving manuals to project repositories 1/19)

Related: OS#3386
Change-Id: Id8b26759607a3490d6cbd93c68ba1f89aa8ef1f2
2018-11-20 17:13:25 +01:00
Neels Hofmeyr 84629eee1e stp: update vty reference with added SCCP commands
After I66e97706de0c546db3c6ff77fb5e6ac6e32bff55 which adds the missing
sccp_vty_init(), update VTY reference with the new SCCP show / config commands.

Depends: I66e97706de0c546db3c6ff77fb5e6ac6e32bff55
Change-Id: Id941b8e31d3b4cfdb3f912beedc1e7af321a0113
2018-11-18 20:41:28 +00:00
Neels Hofmeyr 83d15e9833 stp: update vty reference
Change-Id: Id5f1067760db7a11ec380a541bfe7357a21a3bb3
2018-11-18 20:41:28 +00:00
Neels Hofmeyr 31b2fbe75a sip-connector: update vty reference
Change-Id: I79b91847337b6022f8f750533301b3bf0eb086df
2018-11-18 20:41:28 +00:00
Neels Hofmeyr b954330c1d sgsn: update vty reference
Change-Id: I64d775efa6791aca025d116905e951e10ffa5d04
2018-11-18 20:41:28 +00:00
Neels Hofmeyr 242585a212 msc: update vty reference
Change-Id: I31f1d388b5323af8ece8a71a82c1b91f80d404e1
2018-11-18 20:41:28 +00:00
Neels Hofmeyr d6dffb5401 mgw: update vty reference
Change-Id: Ib30ea8b02f8a950648b85e7ebc96a40ba5a36b34
2018-11-18 20:41:28 +00:00
Neels Hofmeyr 87325793ba hlr: update vty reference
Change-Id: I5a2322c0488cb36b089303bbfec5d4db18c41099
2018-11-18 20:41:28 +00:00
Neels Hofmeyr 020641da2e ggsn: update vty reference
Change-Id: I8a5c37505c0180d5c04c7792d6d0afdb0dffb282
2018-11-18 20:41:28 +00:00
Neels Hofmeyr b33f6973d0 OsmoBSC: update VTY reference
Re-generate bsc_vty_reference.xml from osmo-bsc, including updates to:
- handover and neighbor config
- SCCP timers
- logging

Change-Id: Ia9ba8d5eba531b1156de57573ab42517e0c1ca15
2018-11-18 20:41:28 +00:00
Daniel Willmann 6e5b7d3cdc Logging: Describe all log options, including set-all and force-all
Change-Id: Ica03c3ea08289314819448a22ae7ed38a7bd4f83
2018-11-18 20:06:00 +00:00
Daniel Willmann 987aa54d56 common/chapters/bts: Remove duplicate spaces in text
Change-Id: I38f3e94342461f494ef547bcdccd2594c30e679d
2018-11-18 20:06:00 +00:00
Daniel Willmann b7b5ce0a28 Change OpenBSC mentions to OsmoBSC where applicable
Change-Id: I4cc6874302b6089a54d44b09f08660a25e46d4dc
2018-11-18 20:06:00 +00:00
Daniel Willmann 1d56daeaeb OsmoBSC/HLR/MSC: Fix default config file name
Mention that the default is not openbsc.cfg, but osmo-*.cfg

Change-Id: I139e6004e28d6f918f31792e634214a6153edd0e
2018-11-18 20:05:12 +00:00
Daniel Willmann 94b857aac7 OsmoBTS: Fix typo
Change-Id: I0a4c9f052f14816e88ed0a4a5fff9b3854da195a
2018-11-18 20:05:12 +00:00
Daniel Willmann 4d3e83f785 VTY: Remove osmo-nitb VTY port number example
We reference the port list appendix where all the ports used by various
Osmocom projects are listed and it's unlikely that pointing out the
osmo-nitb port would significantly help the reader, so just remove the
reference.

Change-Id: I354d50314ba248835191fa3da122032201618a0e
2018-11-18 20:05:02 +00:00
Daniel Willmann 34837943d7 OsmoBTS: Print VTY command in fixed-width font
Surrounding with '@' didn't seem to yield the intended result, the
charactars appeared in the compiled document.

Change-Id: I66e7949fa4a6c2164bf9572a2beaf8ace169fa1c
2018-11-18 20:04:53 +00:00
Daniel Willmann a400b9598f Abis: Change abisip-find/ipaccess-config path to osmo-bsc repo
Change-Id: I4b92a611abd6e92ad69f77f8ec81a6501224afe5
2018-11-18 20:04:53 +00:00
Oliver Smith 82c6c9ba14 jenkins.sh: do not use libosomcore source
Build scripts do not depend on the libosmocore sources anymore
with 161365f ("merge_doc.xsl: move from libosmocore.git"),
so don't try to use them in jenkins.sh anymore.

Related: OS#3385
Change-Id: Ied3661b8a02e9defca0e5aedcc4494845553db84
2018-11-16 15:10:06 +01:00
Oliver Smith e4f2811296 Makefile: move dep-check code to check-depends.sh
Make it possible to run the dependency check without the Makefile. This
is needed to split up the manual pages into the projects repositories,
so we can call check-depends.sh from there.

Related: OS#3385
Change-Id: I82a7efd7e9c265c82d1ba8a60856c892a15a7a33
2018-11-12 13:42:11 +01:00
Oliver Smith 161365fa6f merge_doc.xsl: move from libosmocore.git
Allow building manuals without the libosmocore source.

Related: OS#3385
Change-Id: Ifb81b18422987cdf36b75993d2782abf93b5f48c
2018-11-12 12:18:41 +01:00
Oliver Smith 10ffc82237 unix-time-to-fmt.py: fix crash without argument
Print "unknown" to stdout when unix-time-to-fmt.py was called without
an argument, instead of printing a Python stack trace to stderr. It gets
called that way when building outside of a git folder.

Change-Id: I3ba27cc23543e47cc8a1e494c35cc33f1dc8f297
2018-11-12 11:01:46 +01:00
Oliver Smith e65d9efb31 Makefile.asciidoc.inc: make clean: also rm *.html
HTML files get created when a2x fails and asciidoc runs.

Change-Id: I4d5e9c36f75141ce88d11b16c89809be4dce87d8
2018-11-12 11:01:43 +01:00
Oliver Smith 0b9d46f883 Makefile.asciidoc.inc: always exit 1 on a2x error
a2x wraps asciidoc. When a2x fails, we run asciidoc without a2x to
print verbose output. Make sure that 'make' fails at this point, even
if asciidoc runs through.

Change-Id: I30931303ecc6094efaedcb08380433a34211a169
2018-11-12 10:58:04 +01:00
Neels Hofmeyr c3db2aadbf author info: add "former" to Holger's job title
It doesn't seem to have an effect on the generated PDFs though.

Change-Id: I0556a3f8dafc051f20a3854fc9006edf4ec1a0d3
2018-11-01 18:09:32 +01:00
Neels Hofmeyr d3c34d6a9d bsc: handover: mention the need to resend SI for telnet neighbor cfg
Change-Id: I305ef558b75697015e2532aa7c135f7995662e0d
2018-11-01 18:07:11 +01:00
Neels Hofmeyr 61ce544926 bsc: handover: clarify default of all-cells-are-neighbors
Change-Id: I61f877c7a60419132bdd27c1b4e64150c0520751
2018-11-01 18:07:11 +01:00
Neels Hofmeyr 37278281f3 bsc: document handover
Add chapter "Handover", explaining:
- intra- and
- inter-BSC handover,
- HO algorithm 1 and
- algorithm 2
- new neighbor configuration

Adjust copyright, add revision and add me as author.

Change-Id: I7afb3f66c98abda07fc8acc76e00c46091fe55e2
2018-11-01 18:07:11 +01:00
Harald Welte aea2086fd4 add SGs / CSFB related dot + msc files
Those graphs + message sequence charts are not yet used by any
of our manuals, but they should become used by the OsmoMSC user
manual once SGs interface support is added.

Related: OS#2583
Change-Id: Idfd3a66c18131b5458d183b8e66f62eaaab65991
2018-10-05 23:42:49 +02:00
Philipp Maier 903e0f62a5 mncc: add note about DTMF considerations
Add an informative note on how DTMF signalling is done in mobile
networks and mention the limitations regarding DTMF, when internal MNCC
is used.

Change-Id: Iedcf4ad5e0e4697c6a05ebdd4f43173c14c7c448
Related: OS#2777
2018-10-01 16:50:01 +02:00
Philipp Maier 734e0ea24c mncc: add missing DTMF message types.
The list that describes the MNCC message types lacks the message types
used for DTMF.

Change-Id: I4251b296e043e7583518d6672e614b376331d25e
Related: OS#2777
2018-10-01 16:49:54 +02:00
Philipp Maier 2e72bd5e76 running: Add note about DTMF support
osmo-sip-connector does not yet support full DTMF support. The current
implementation only supports DTMF tones to be send from MNCC to SIP,
but not in the opposite direction.

Change-Id: I578e50b0a42d88b05cf6da80443b71494b5eb26f
Related: OS#2777
2018-10-01 15:59:57 +02:00
Daniel Willmann 7bd771bbc0 Add OsmoSIPConnector to master make file
Change-Id: Icdb405abfa560846f1ebb848f8d8dd34610cfc89
2018-09-25 12:18:08 +00:00
Daniel Willmann 6e11da02f0 osmo-sip-connector: Explicitly note OsmoMSC config with external MNCC
Change-Id: Ia186ea48b1012e65dc6446c839fdb548d44b6a6c
2018-09-25 12:18:08 +00:00
Pau Espin a270d9375b osmotrx: Introduce code architecture chapter
Change-Id: I21084e6315d79a1adcb305e12343da218837dc31
2018-09-20 15:03:56 +02:00
Pau Espin 39e3dc9460 osmotrx: Create a common chapter for section documenting backends
Change-Id: I6bea1ccca4ce72b92641a36f9f5894ac9a6cae72
2018-09-20 15:03:56 +02:00
Pau Espin 72e569f784 osmotrx: configuration: Add section to document multi-arfcn feature
Change-Id: Id04c7f7c36d8a8be8145ef8009ece26ef1a7cdff
2018-09-19 17:43:09 +02:00
Pau Espin 0381f5a169 osmotrx: Write initial documentation for several supported devices
Change-Id: I902b01ca661416eb9705afac8a34ec8d2fb13789
2018-09-19 17:14:25 +02:00
Pau Espin 8d38254227 osmotrx: Split Device specific section from backend one
Device specific sections will be added to this new chapter.

Change-Id: Id96cbf857e2ef92d9ad2cb58fd18132f981447d7
2018-09-19 16:36:34 +02:00
Vadim Yanitskiy d0d5d0eca5 OsmoSIPConnector: fix: avoid OsmoMGW/OsmoSIPcon confusion
Change-Id: If20700d94775e91f174a1a07e00820ef0a91cd2f
2018-08-30 01:35:44 +07:00
Neels Hofmeyr 7ef86bb587 OsmoMGW: document the 'X-Osmo-IGN' MGCP extension
See also Ia6fe5ead4b601931c1bf41b29fc1b237aac37d2c in osmo-mgw.git, which
changes the initial single-character implementation to match this specification
of string tokens separated by spaces.

Change-Id: If15a88c3b5b40fd1d24ad0f94f3231f678669ab1
2018-08-26 23:49:42 +02:00
Daniel Willmann bf2a61aafa Add manual for OsmoSIPConnector
Ticket: OS#1684
Change-Id: I70d3014deb459e0b91a9a92c60710b994153538e
2018-08-23 17:41:22 +02:00
Daniel Willmann 078c7a4666 Add VTY reference for osmo-sip-connector
Ticket: OS#1684
Change-Id: I1045c20dd7234d425836ba93fa292a35ccddc7fd
2018-08-23 17:41:06 +02:00
Harald Welte 128c2db0f6 hlr: Add chapter on USSD configuration
Change-Id: Ie5196ece9f340303bcb4868e3333a9698e28c3d0
2018-08-07 18:04:12 +00:00
Daniel Willmann 0c1dad4a5b Add initial OsmoMGW manual
Change-Id: I1b4ff96309d280c6a63105a6e06a82ec2e7b6908
2018-08-07 18:57:53 +02:00
Daniel Willmann fa787b2e30 mgw: Add new VTY reference
Change-Id: Ic8ca983f3358aae9362fb21ff3a111f9c4f3935b
2018-07-31 18:54:34 +02:00
Pau Espin 557e928d91 trx: Add Hardware device support section
Change-Id: I87fc54cf1751f31a3e92d6503625e984f9a6130f
2018-07-06 12:01:01 +02:00
Pau Espin 6e16895356 trx: Add Hardware architecture support section
Change-Id: I38388bcb2ea7c0481052d3bca589cb34965ea7fa
2018-07-06 11:56:20 +02:00