Commit Graph

28 Commits

Author SHA1 Message Date
Oliver Smith a3f9a1e909 *-vty-reference.xml: use ./common, not ../common
Change hardcoded ../common paths, which will break when moving the
project specific manuals in other repositories, to ./common so they
use the dynamically created symlink that always points to the right
path.

(moving manuals to project repositories 9/19)

Change-Id: I5368bcff34586c515af23e5a868417e561fd539d
2018-11-21 14:29:11 +01:00
Oliver Smith dc7c08ea08 *.adoc: include from ./common, not ../common
Change hardcoded ../common paths, which will break when moving the
project specific manuals in other repositories, to ./common so they
use the dynamically created symlink that always points to the right
path.

(moving manuals to project repositories 8/19)

Related: OS#3385
Change-Id: Id984f5e85481f7877567ee6d21f7ca455d773ef1
2018-11-21 14:29:11 +01:00
Oliver Smith 2947683c3a use autotools to add "make install" target
For reasoning why a transition to autotools is desired, see the commit
message of the previous patch in this series.

"make install" copies the "build", "common" dirs, as well as the "*.xsl"
files to $(prefix)/share/osmo-gsm-manuals. Prefix is typically
/usr/local. Also a pkg-config file gets installed, so the path of the
shared files can be looked up by autoconf scripts of the project
repositories. The check-depends script is installed to
$(prefix)/bin/osmo-gsm-manuals-check-depends and will be used by
project specific autoconf scripts, too.

All existing make targets ("make", "make check", "make upload") are
still working, users only need to run "autoreconf -fi" and
"./configure" beforehand.

Makefile.am uses custom install-data-hook and uninstall-local targets,
so we don't need to specify each file of the relevant subdirs in a
_DATA variable (no extra maintenance effort).

(moving manuals to project repositories 5/19)

Related: OS#3385
Change-Id: I8e7036fae062ee783cb132b14608827a82c5e7c7
2018-11-21 14:29:05 +01:00
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
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
Harald Welte 904e792fa4 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-03-17 14:30:49 +01:00
Neels Hofmeyr c481a988e3 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
2017-10-25 16:51:55 +00:00
Neels Hofmeyr 1b1b176e68 OsmoNITB: update vty reference
Change node IDs to use the names derived from the node prompt,
in the process fix the node references to not place the vty_additions in the
wrong places.

Related: I8fa555570268b231c5e01727c661da92fad265de (libosmocore)
Change-Id: I48edb65be94be56c4b57293d8edc1b30271acc12
2017-10-24 15:32:00 +00:00
Neels Hofmeyr 1310fa82e9 move smpp.adoc to common chapters, generalize
OsmoMSC will need the same SMPP chapter as OsmoNITB.

In smpp.adoc, replace program name with parameter, add parameter to
OsmoNITB's main adoc and move smpp.adoc to common/chapters.

Change-Id: I15febdea6569316dad3eed5f9dc7158adb5b078c
2017-10-02 14:27:04 +00:00
Neels Hofmeyr 40abc7a217 tweak common/mncc.adoc: use variable for program name
Change-Id: I993a3c3bf617b9823f49898364b5f728a4549330
2017-09-28 18:09:07 +02:00
Neels Hofmeyr f56996aa41 move mncc.adoc to common chapters
Upcoming OsmoMSC will reference the same, hence MNCC becomes a common chapter.

Move the file and adjust various wording to include OsmoMSC.

Change-Id: I404758ff7f1372e841ffe33c75455f513fff3caf
2017-09-25 16:42:01 +02:00
Pau Espin b1503f04bf 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
2017-09-01 09:43:23 +02:00
Harald Welte bbfb0c33ef SMPP: Document Osmocom extensions
Change-Id: I4cedd07a33633bdd2350d2bda0a22cc0c631c0a9
2017-07-10 18:12:46 +02:00
Pau Espin e10b5d6718 smpp.adoc: describe VTY cmd 'local-tcp-ip' instead of 'local-tcp-port'
Change-Id: I594b89094413758146bb25f5262902e263f8f3d1
2017-07-05 11:12:36 +00:00
Philipp Maier d2db10c45c osmo-nitb: Update VTY command reference
Change-Id: Ia4c2d71eeca853ef277e802e9e8e200eb3414bca
2017-06-09 08:51:46 +00:00
Harald Welte 8e23a8e3ab Add chapter on Cell Broadcast Support in Osmocom (to BSC+NITB manual)
Change-Id: I2c621def499dc0564d31eb9440e22e79948a5466
2017-05-29 20:52:02 +02:00
Philipp Maier c122abf12d Describe how to run multiple instances of osmo-nitb and osmo-bts
Change-Id: I69adeef85adda6f08b31b7d176f51e16968c1435
2017-01-10 15:06:19 +01:00
Neels Hofmeyr 722c2fd579 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
2016-10-21 02:22:02 +02:00
Neels Hofmeyr 129875ddb7 OsmoNITB: include abis.adoc from common/chapters/
Change-Id: If3d92fe19d402d77b0db0eb9d00efef0a8d02122
2016-10-21 02:22:02 +02:00
Neels Hofmeyr fe9dca3a09 OsmoBSC+NITB/running: fix title levels, one too deep
Change-Id: If81e44c9a0774e5de39cc536989cef5cb214a224
2016-10-21 02:22:02 +02:00
Neels Hofmeyr b156e76469 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
2016-10-18 17:11:21 +02:00
Neels Hofmeyr 4dba500ed5 make clean: also remove generated image files
Change-Id: I80798e79b4ccee64f26f58f9754de02b2958e33e
2016-10-18 17:10:51 +02:00
Ivaylo Kostov a9b0620119 Typo in Chapter 14.2 2016-10-13 18:02:11 +02:00
Max 964ccee117 Add OsmoNITB control interface description 2016-06-07 23:16:01 +02:00
Jonathan Brielmaier 56cdbf359c fix various typos across all manuals 2016-05-25 15:01:28 +02:00
Harald Welte 5bf336cbc2 OsmoNITB HLR: expand on how to create subscribers 2016-02-20 19:15:59 +01:00
Harald Welte 2fd66e4a99 Add link to Asciidoc source code of manual 2016-02-20 18:28:46 +01:00
Harald Welte 37ba7a9825 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.
2016-02-20 15:01:50 +01:00