aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorOliver Smith <osmith@sysmocom.de>2018-11-14 10:47:01 +0100
committerNeels Hofmeyr <neels@hofmeyr.de>2018-11-27 17:56:09 +0100
commit26701bbe85b12a50a705351514f85c8db5c848bc (patch)
treea71008c5f76cc6ce9f6aa7ec569210699169f2d2 /doc
parent0133b65da1bcf788181b43030fde6b4975ea6be7 (diff)
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: I728ebb56ade6dda079a0744c4e592284e1bea4f6
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/manuals/Makefile12
-rw-r--r--doc/manuals/Makefile.am24
-rw-r--r--doc/manuals/osmobts-abis.adoc16
-rw-r--r--doc/manuals/osmobts-usermanual.adoc34
-rw-r--r--doc/manuals/osmobts-vty-reference.xml2
-rw-r--r--doc/manuals/rtp-amr.adoc2
7 files changed, 52 insertions, 39 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 1d42b0aa..2f308154 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,3 +1,4 @@
SUBDIRS = \
examples \
+ manuals \
$(NULL)
diff --git a/doc/manuals/Makefile b/doc/manuals/Makefile
deleted file mode 100644
index e1ff2147..00000000
--- a/doc/manuals/Makefile
+++ /dev/null
@@ -1,12 +0,0 @@
-TOPDIR = ..
-
-ASCIIDOC = osmobts-usermanual.adoc osmobts-abis.adoc rtp-amr.adoc
-include $(TOPDIR)/build/Makefile.asciidoc.inc
-osmobts-usermanual.pdf: chapters/*.adoc
-osmobts-abis.pdf: abis/*.adoc abis/*.msc
-rtp-amr.pdf: dtx.dot
-
-VTY_REFERENCE = osmobts-vty-reference.xml
-include $(TOPDIR)/build/Makefile.vty-reference.inc
-
-include $(TOPDIR)/build/Makefile.common.inc
diff --git a/doc/manuals/Makefile.am b/doc/manuals/Makefile.am
new file mode 100644
index 00000000..90fff57e
--- /dev/null
+++ b/doc/manuals/Makefile.am
@@ -0,0 +1,24 @@
+EXTRA_DIST = dtx.dot \
+ osmobts-abis.adoc \
+ osmobts-abis-docinfo.xml \
+ osmobts-usermanual.adoc \
+ osmobts-usermanual-docinfo.xml \
+ osmobts-vty-reference.xml \
+ rtp-amr.adoc \
+ rtp-amr-docinfo.xml \
+ abis \
+ chapters \
+ vty
+
+if BUILD_MANUALS
+ ASCIIDOC = osmobts-usermanual.adoc osmobts-abis.adoc rtp-amr.adoc
+ include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
+ osmobts-usermanual.pdf: $(srcdir)/chapters/*.adoc
+ osmobts-abis.pdf: $(srcdir)/abis/*.adoc $(srcdir)/abis/*.msc
+ rtp-amr.pdf: $(srcdir)/dtx.dot
+
+ VTY_REFERENCE = osmobts-vty-reference.xml
+ include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc
+
+ include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc
+endif
diff --git a/doc/manuals/osmobts-abis.adoc b/doc/manuals/osmobts-abis.adoc
index 1e02414d..857b4bfb 100644
--- a/doc/manuals/osmobts-abis.adoc
+++ b/doc/manuals/osmobts-abis.adoc
@@ -64,7 +64,7 @@ established.
.Overview of A-bis connection establishment
["mscgen"]
----
-include::abis/abis-startup.msc[]
+include::{srcdir}/abis/abis-startup.msc[]
----
=== Identities
@@ -77,16 +77,16 @@ parts:
* The BTS number at the site
* The TRX number within the BTS
-include::abis/ipa.adoc[]
+include::{srcdir}/abis/ipa.adoc[]
-include::abis/oml.adoc[]
+include::{srcdir}/abis/oml.adoc[]
-include::abis/rsl.adoc[]
+include::{srcdir}/abis/rsl.adoc[]
-include::abis/rtp.adoc[]
+include::{srcdir}/abis/rtp.adoc[]
-include::../common/chapters/port_numbers.adoc[]
+include::./common/chapters/port_numbers.adoc[]
-include::../common/chapters/glossary.adoc[]
+include::./common/chapters/glossary.adoc[]
-include::../common/chapters/gfdl.adoc[]
+include::./common/chapters/gfdl.adoc[]
diff --git a/doc/manuals/osmobts-usermanual.adoc b/doc/manuals/osmobts-usermanual.adoc
index 07f88e28..40db72b8 100644
--- a/doc/manuals/osmobts-usermanual.adoc
+++ b/doc/manuals/osmobts-usermanual.adoc
@@ -4,36 +4,36 @@ OsmoBTS User Manual
===================
Harald Welte <hwelte@sysmocom.de>
-include::../common/chapters/preface.adoc[]
+include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::../common/chapters/abis.adoc[]
+include::./common/chapters/abis.adoc[]
-include::chapters/interfaces.adoc[]
+include::{srcdir}/chapters/interfaces.adoc[]
-include::chapters/control.adoc[]
+include::{srcdir}/chapters/control.adoc[]
-include::../common/chapters/vty.adoc[]
+include::./common/chapters/vty.adoc[]
-include::../common/chapters/logging.adoc[]
+include::./common/chapters/logging.adoc[]
-include::chapters/configuration.adoc[]
+include::{srcdir}/chapters/configuration.adoc[]
-include::chapters/dynamic-timeslots.adoc[]
+include::{srcdir}/chapters/dynamic-timeslots.adoc[]
-include::chapters/bts-models.adoc[]
+include::{srcdir}/chapters/bts-models.adoc[]
-include::chapters/architecture.adoc[]
+include::{srcdir}/chapters/architecture.adoc[]
-include::../common/chapters/trx_if.adoc[]
+include::./common/chapters/trx_if.adoc[]
-include::../common/chapters/control_if.adoc[]
+include::./common/chapters/control_if.adoc[]
-include::../common/chapters/port_numbers.adoc[]
+include::./common/chapters/port_numbers.adoc[]
-include::../common/chapters/bibliography.adoc[]
+include::./common/chapters/bibliography.adoc[]
-include::../common/chapters/glossary.adoc[]
+include::./common/chapters/glossary.adoc[]
-include::../common/chapters/gfdl.adoc[]
+include::./common/chapters/gfdl.adoc[]
diff --git a/doc/manuals/osmobts-vty-reference.xml b/doc/manuals/osmobts-vty-reference.xml
index f4048434..b7c8a596 100644
--- a/doc/manuals/osmobts-vty-reference.xml
+++ b/doc/manuals/osmobts-vty-reference.xml
@@ -5,7 +5,7 @@
-->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML 5.0//EN"
"http://docbook.org/xml/5.0/dtd/docbook.dtd" [
-<!ENTITY chapter-vty SYSTEM "../common/chapters/vty.xml" >
+<!ENTITY chapter-vty SYSTEM "./common/chapters/vty.xml" >
<!ENTITY sections-vty SYSTEM "generated/docbook_vty.xml" >
]>
diff --git a/doc/manuals/rtp-amr.adoc b/doc/manuals/rtp-amr.adoc
index 4da2e1b3..5a36aeab 100644
--- a/doc/manuals/rtp-amr.adoc
+++ b/doc/manuals/rtp-amr.adoc
@@ -1335,7 +1335,7 @@ There is FSM implementing all the necessary states and transitions for DTX DL.
[[dtx_dl_fsm]]
[graphviz]
----
-include::dtx.dot[]
+include::{srcdir}/dtx.dot[]
----
The idea is that each state corresponds to the particular message type which have to be send to L1 next while state transition happens on incoming events like FACCH or Voice frames. There are 3 different classes of of events driving this FSM: