Commit Graph

20 Commits

Author SHA1 Message Date
Neels Hofmeyr 68a9801c88 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-19 06:43:37 +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
Philipp Maier 2c19280104 configuration: fixing typos
configuration.adoc has some minor typos in it, this commit fixes
that.

Change-Id: Id84238b89e5deeac99c043b79b26c7e7b8b8534b
2017-01-23 12:11:20 +00: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 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
Jonathan Brielmaier 56cdbf359c fix various typos across all manuals 2016-05-25 15:01:28 +02:00
Harald Welte 82637df70d gb/NS: Clarify the language regarding the UDP port numbers / socket 2016-03-10 12:53:06 +07:00
Harald Welte bd41715e0b consistently use '3GPP TS' not sometimes 3GPP TS and sometimes TS. 2016-03-10 12:49:03 +07:00
Harald Welte a901d49521 gb: Some language improvements, formatting changes 2016-03-10 12:45:22 +07:00
Harald Welte 221db98ae6 Gb: Various spelling fixes 2016-03-10 12:35:09 +07:00
Harald Welte 0c917bb4c6 Gb message sequence chart: Add notion of PCU unix domain socket 2016-03-10 12:32:13 +07:00
Harald Welte 2069e39a12 Gb message sequence chart: flip sides (SGSN should be right)
... also, re-word some of th labels for more clarity
2016-03-10 12:29:18 +07:00
Max 5a6a69cb8a OsmoPCU: add MSC chart 2016-03-09 15:07:08 +01:00
Max 8791147dab OsmoPCU: expand BSSGP documentation 2016-03-09 14:07:58 +01:00
Max 19124f4e2e OsmoPCU: expand NS documentation
Add table with NS messages.
Add corresponding sections.
Clarify spec numbers.
2016-03-09 14:07:58 +01:00
Max dfb78ea482 OsmoPCU: fix Gb documentation front page
Add date and commit refs.
Add relevant standards.
Fix email typo.
2016-03-09 14:07:58 +01:00
Harald Welte d4d27c9259 Initial place-holder for the new Gb/IP interface documentation 2016-03-09 14:07:58 +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