summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOliver Smith <osmith@sysmocom.de>2018-11-15 11:00:01 +0100
committerOliver Smith <osmith@sysmocom.de>2018-11-21 14:37:49 +0100
commit99b7cd177539146babe0db6c627a5166989f9fb2 (patch)
tree7a1c8ca3ca7ad4d66891a48a2159ba5ca8766747
parent2682f146118757a724765ebe9ea31f3c88b4b3fa (diff)
*.adoc: use {srcdir} for out-of-tree builds
Define a new {srcdir} variable in Makefile.asciidoc.inc, that can be used in all adoc files. The value is the same as the Makefile variable $(srcdir). Use {srcdir} in the "include::" lines of all adoc files. (moving manuals to project repositories 13/19) Related: OS#3385 Change-Id: I823e3d534cbc9ffceb68d3ab14c9f6710ff2eb2a
-rw-r--r--OsmoBSC/aoip-mgw-options.adoc8
-rw-r--r--OsmoBSC/osmobsc-usermanual.adoc10
-rw-r--r--OsmoBTS/osmobts-abis.adoc10
-rw-r--r--OsmoBTS/osmobts-usermanual.adoc14
-rw-r--r--OsmoBTS/rtp-amr.adoc2
-rw-r--r--OsmoGGSN/osmoggsn-usermanual.adoc8
-rw-r--r--OsmoGSMTester/osmo-gsm-tester-manual.adoc12
-rw-r--r--OsmoHLR/osmohlr-usermanual.adoc10
-rw-r--r--OsmoMGW/osmomgw-usermanual.adoc10
-rw-r--r--OsmoMSC/osmomsc-usermanual.adoc10
-rw-r--r--OsmoNITB/osmonitb-usermanual.adoc12
-rw-r--r--OsmoPCU/osmopcu-gb.adoc6
-rw-r--r--OsmoPCU/osmopcu-usermanual.adoc8
-rw-r--r--OsmoSGSN/osmosgsn-usermanual.adoc10
-rw-r--r--OsmoSIPConnector/osmosipconnector-usermanual.adoc6
-rw-r--r--OsmoSTP/osmostp-usermanual.adoc6
-rw-r--r--OsmoTRX/osmotrx-usermanual.adoc18
-rw-r--r--OsmocomBB/osmocombb-usermanual.adoc2
-rw-r--r--build/Makefile.asciidoc.inc2
19 files changed, 82 insertions, 82 deletions
diff --git a/OsmoBSC/aoip-mgw-options.adoc b/OsmoBSC/aoip-mgw-options.adoc
index 8ce3b91..f693093 100644
--- a/OsmoBSC/aoip-mgw-options.adoc
+++ b/OsmoBSC/aoip-mgw-options.adoc
@@ -29,7 +29,7 @@ support was so far for NITB only, but not for OsmoBSC.
[mscgen]
----
-include::mgw/classic-bsc.msc[]
+include::{srcdir}/mgw/classic-bsc.msc[]
----
=== OsmoBSC 2010-2017: IPA-style A over SCCPlite
@@ -43,7 +43,7 @@ classic TDM transport.
[mscgen]
----
-include::mgw/osmo-bsc-old-sccplite.msc[]
+include::{srcdir}/mgw/osmo-bsc-old-sccplite.msc[]
----
@@ -61,7 +61,7 @@ support shall be kept, if possible with reasonable effort.
[mscgen]
----
-include::mgw/osmo-bsc-new-mgw.msc[]
+include::{srcdir}/mgw/osmo-bsc-new-mgw.msc[]
----
@@ -73,5 +73,5 @@ based BTSs from OsmoBSC.
[mscgen]
----
-include::mgw/osmo-bsc-new-mgw-e1.msc[]
+include::{srcdir}/mgw/osmo-bsc-new-mgw-e1.msc[]
----
diff --git a/OsmoBSC/osmobsc-usermanual.adoc b/OsmoBSC/osmobsc-usermanual.adoc
index c3954bb..7f7f450 100644
--- a/OsmoBSC/osmobsc-usermanual.adoc
+++ b/OsmoBSC/osmobsc-usermanual.adoc
@@ -7,15 +7,15 @@ Harald Welte <hwelte@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::chapters/running.adoc[]
+include::{srcdir}/chapters/running.adoc[]
-include::chapters/control.adoc[]
+include::{srcdir}/chapters/control.adoc[]
-include::chapters/counters.adoc[]
+include::{srcdir}/chapters/counters.adoc[]
-include::chapters/handover.adoc[]
+include::{srcdir}/chapters/handover.adoc[]
include::./common/chapters/vty.adoc[]
diff --git a/OsmoBTS/osmobts-abis.adoc b/OsmoBTS/osmobts-abis.adoc
index 20e56e0..857b4bf 100644
--- a/OsmoBTS/osmobts-abis.adoc
+++ b/OsmoBTS/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,13 +77,13 @@ 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[]
diff --git a/OsmoBTS/osmobts-usermanual.adoc b/OsmoBTS/osmobts-usermanual.adoc
index ee3e37f..40db72b 100644
--- a/OsmoBTS/osmobts-usermanual.adoc
+++ b/OsmoBTS/osmobts-usermanual.adoc
@@ -6,25 +6,25 @@ Harald Welte <hwelte@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.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/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[]
diff --git a/OsmoBTS/rtp-amr.adoc b/OsmoBTS/rtp-amr.adoc
index 4da2e1b..5a36aea 100644
--- a/OsmoBTS/rtp-amr.adoc
+++ b/OsmoBTS/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:
diff --git a/OsmoGGSN/osmoggsn-usermanual.adoc b/OsmoGGSN/osmoggsn-usermanual.adoc
index 3394121..9bc3885 100644
--- a/OsmoGGSN/osmoggsn-usermanual.adoc
+++ b/OsmoGGSN/osmoggsn-usermanual.adoc
@@ -5,18 +5,18 @@ Harald Welte <hwelte@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::chapters/running.adoc[]
+include::{srcdir}/chapters/running.adoc[]
-//include::chapters/control.adoc[]
+//include::{srcdir}/chapters/control.adoc[]
include::./common/chapters/vty.adoc[]
include::./common/chapters/logging.adoc[]
-include::chapters/configuration.adoc[]
+include::{srcdir}/chapters/configuration.adoc[]
include::./common/chapters/control_if.adoc[]
diff --git a/OsmoGSMTester/osmo-gsm-tester-manual.adoc b/OsmoGSMTester/osmo-gsm-tester-manual.adoc
index b728384..6f0edf7 100644
--- a/OsmoGSMTester/osmo-gsm-tester-manual.adoc
+++ b/OsmoGSMTester/osmo-gsm-tester-manual.adoc
@@ -7,14 +7,14 @@ Neels Hofmeyr <nhofmeyr@sysmocom.de>
*NOTE: The osmo-gsm-tester is still in pre-alpha stage: some parts are still
incomplete, and details will still change and move around.*
-include::chapters/intro.adoc[]
+include::{srcdir}/chapters/intro.adoc[]
-include::chapters/install.adoc[]
+include::{srcdir}/chapters/install.adoc[]
-include::chapters/config.adoc[]
+include::{srcdir}/chapters/config.adoc[]
-include::chapters/trial.adoc[]
+include::{srcdir}/chapters/trial.adoc[]
-include::chapters/test_api.adoc[]
+include::{srcdir}/chapters/test_api.adoc[]
-include::chapters/debugging.adoc[]
+include::{srcdir}/chapters/debugging.adoc[]
diff --git a/OsmoHLR/osmohlr-usermanual.adoc b/OsmoHLR/osmohlr-usermanual.adoc
index bc2a614..7e709bd 100644
--- a/OsmoHLR/osmohlr-usermanual.adoc
+++ b/OsmoHLR/osmohlr-usermanual.adoc
@@ -8,19 +8,19 @@ Neels Hofmeyr <nhofmeyr@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::chapters/running.adoc[]
+include::{srcdir}/chapters/running.adoc[]
-include::chapters/subscribers.adoc[]
+include::{srcdir}/chapters/subscribers.adoc[]
-include::chapters/ussd.adoc[]
+include::{srcdir}/chapters/ussd.adoc[]
include::./common/chapters/vty.adoc[]
include::./common/chapters/logging.adoc[]
-include::chapters/control.adoc[]
+include::{srcdir}/chapters/control.adoc[]
include::./common/chapters/control_if.adoc[]
diff --git a/OsmoMGW/osmomgw-usermanual.adoc b/OsmoMGW/osmomgw-usermanual.adoc
index 55e9090..b0bc83d 100644
--- a/OsmoMGW/osmomgw-usermanual.adoc
+++ b/OsmoMGW/osmomgw-usermanual.adoc
@@ -8,19 +8,19 @@ Daniel Willmann <dwillmann@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::chapters/running.adoc[]
+include::{srcdir}/chapters/running.adoc[]
include::./common/chapters/vty.adoc[]
include::./common/chapters/logging.adoc[]
-include::chapters/configuration.adoc[]
+include::{srcdir}/chapters/configuration.adoc[]
-include::chapters/mgcp_extensions.adoc[]
+include::{srcdir}/chapters/mgcp_extensions.adoc[]
-//include::chapters/counters.adoc[]
+//include::{srcdir}/chapters/counters.adoc[]
include::./common/chapters/port_numbers.adoc[]
diff --git a/OsmoMSC/osmomsc-usermanual.adoc b/OsmoMSC/osmomsc-usermanual.adoc
index 1b48435..4fd0cc7 100644
--- a/OsmoMSC/osmomsc-usermanual.adoc
+++ b/OsmoMSC/osmomsc-usermanual.adoc
@@ -8,19 +8,19 @@ Neels Hofmeyr <nhofmeyr@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::chapters/running.adoc[]
+include::{srcdir}/chapters/running.adoc[]
-include::chapters/control.adoc[]
+include::{srcdir}/chapters/control.adoc[]
-include::chapters/counters.adoc[]
+include::{srcdir}/chapters/counters.adoc[]
include::./common/chapters/vty.adoc[]
include::./common/chapters/logging.adoc[]
-include::chapters/net.adoc[]
+include::{srcdir}/chapters/net.adoc[]
include::./common/chapters/smpp.adoc[]
diff --git a/OsmoNITB/osmonitb-usermanual.adoc b/OsmoNITB/osmonitb-usermanual.adoc
index d836f7b..42afe89 100644
--- a/OsmoNITB/osmonitb-usermanual.adoc
+++ b/OsmoNITB/osmonitb-usermanual.adoc
@@ -8,25 +8,25 @@ Harald Welte <hwelte@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::chapters/running.adoc[]
+include::{srcdir}/chapters/running.adoc[]
-include::chapters/control.adoc[]
+include::{srcdir}/chapters/control.adoc[]
include::./common/chapters/vty.adoc[]
include::./common/chapters/logging.adoc[]
-include::chapters/net.adoc[]
+include::{srcdir}/chapters/net.adoc[]
include::./common/chapters/bsc.adoc[]
include::./common/chapters/bts.adoc[]
-include::chapters/bts-examples.adoc[]
+include::{srcdir}/chapters/bts-examples.adoc[]
-include::chapters/hlr.adoc[]
+include::{srcdir}/chapters/hlr.adoc[]
include::./common/chapters/smpp.adoc[]
diff --git a/OsmoPCU/osmopcu-gb.adoc b/OsmoPCU/osmopcu-gb.adoc
index af5ea27..00576c9 100644
--- a/OsmoPCU/osmopcu-gb.adoc
+++ b/OsmoPCU/osmopcu-gb.adoc
@@ -60,7 +60,7 @@ OsmoBSC or the BSC component inside OsmoNITB.
.Overview of Gb link establishment
["mscgen"]
----
-include::gb/gb-startup.msc[]
+include::{srcdir}/gb/gb-startup.msc[]
----
[[ident]]
@@ -84,9 +84,9 @@ they connect to.
This means that typically each OsmoPCU has one unique set of NSEI,
NSVCI and BVCI in your network.
-include::gb/ns.adoc[]
+include::{srcdir}/gb/ns.adoc[]
-include::gb/bssgp.adoc[]
+include::{srcdir}/gb/bssgp.adoc[]
include::./common/chapters/port_numbers.adoc[]
diff --git a/OsmoPCU/osmopcu-usermanual.adoc b/OsmoPCU/osmopcu-usermanual.adoc
index 810772e..bf25cfd 100644
--- a/OsmoPCU/osmopcu-usermanual.adoc
+++ b/OsmoPCU/osmopcu-usermanual.adoc
@@ -7,17 +7,17 @@ Harald Welte <hwelte@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::chapters/running.adoc[]
+include::{srcdir}/chapters/running.adoc[]
include::./common/chapters/vty.adoc[]
include::./common/chapters/logging.adoc[]
-include::chapters/configuration.adoc[]
+include::{srcdir}/chapters/configuration.adoc[]
-include::chapters/counters.adoc[]
+include::{srcdir}/chapters/counters.adoc[]
include::./common/chapters/gb.adoc[]
diff --git a/OsmoSGSN/osmosgsn-usermanual.adoc b/OsmoSGSN/osmosgsn-usermanual.adoc
index c85fc6e..dea91a9 100644
--- a/OsmoSGSN/osmosgsn-usermanual.adoc
+++ b/OsmoSGSN/osmosgsn-usermanual.adoc
@@ -7,17 +7,17 @@ Harald Welte <hwelte@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::chapters/running.adoc[]
+include::{srcdir}/chapters/running.adoc[]
-include::chapters/control.adoc[]
+include::{srcdir}/chapters/control.adoc[]
include::./common/chapters/vty.adoc[]
include::./common/chapters/logging.adoc[]
-include::chapters/configuration.adoc[]
+include::{srcdir}/chapters/configuration.adoc[]
include::./common/chapters/gb.adoc[]
@@ -27,7 +27,7 @@ include::./common/chapters/oap.adoc[]
include::./common/chapters/gsup.adoc[]
-include::chapters/counters.adoc[]
+include::{srcdir}/chapters/counters.adoc[]
include::./common/chapters/port_numbers.adoc[]
diff --git a/OsmoSIPConnector/osmosipconnector-usermanual.adoc b/OsmoSIPConnector/osmosipconnector-usermanual.adoc
index 67a0e52..72d7127 100644
--- a/OsmoSIPConnector/osmosipconnector-usermanual.adoc
+++ b/OsmoSIPConnector/osmosipconnector-usermanual.adoc
@@ -8,15 +8,15 @@ Daniel Willmann <dwillmann@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::chapters/running.adoc[]
+include::{srcdir}/chapters/running.adoc[]
include::./common/chapters/vty.adoc[]
include::./common/chapters/logging.adoc[]
-include::chapters/configuration.adoc[]
+include::{srcdir}/chapters/configuration.adoc[]
include::./common/chapters/port_numbers.adoc[]
diff --git a/OsmoSTP/osmostp-usermanual.adoc b/OsmoSTP/osmostp-usermanual.adoc
index 5c919b9..9f41e5d 100644
--- a/OsmoSTP/osmostp-usermanual.adoc
+++ b/OsmoSTP/osmostp-usermanual.adoc
@@ -5,14 +5,14 @@ Harald Welte <hwelte@sysmocom.de>
include::./common/chapters/preface.adoc[]
-// include::chapters/overview.adoc[]
+// include::{srcdir}/chapters/overview.adoc[]
include::./common/chapters/sigtran.adoc[]
include::./common/chapters/sigtran-osmocom.adoc[]
-//include::chapters/running.adoc[]
-// include::chapters/control.adoc[]
+//include::{srcdir}/chapters/running.adoc[]
+// include::{srcdir}/chapters/control.adoc[]
include::./common/chapters/vty.adoc[]
diff --git a/OsmoTRX/osmotrx-usermanual.adoc b/OsmoTRX/osmotrx-usermanual.adoc
index fdd9c8a..a17a899 100644
--- a/OsmoTRX/osmotrx-usermanual.adoc
+++ b/OsmoTRX/osmotrx-usermanual.adoc
@@ -7,29 +7,29 @@ Pau Espin Pedrol <pespin@sysmocom.de>
include::./common/chapters/preface.adoc[]
-include::chapters/overview.adoc[]
+include::{srcdir}/chapters/overview.adoc[]
-include::chapters/running.adoc[]
+include::{srcdir}/chapters/running.adoc[]
include::./common/chapters/control_if.adoc[]
-include::chapters/control.adoc[]
+include::{srcdir}/chapters/control.adoc[]
include::./common/chapters/vty.adoc[]
include::./common/chapters/logging.adoc[]
-include::chapters/counters.adoc[]
+include::{srcdir}/chapters/counters.adoc[]
-include::chapters/configuration.adoc[]
+include::{srcdir}/chapters/configuration.adoc[]
-include::chapters/trx-architectures.adoc[]
+include::{srcdir}/chapters/trx-architectures.adoc[]
-include::chapters/trx-devices.adoc[]
+include::{srcdir}/chapters/trx-devices.adoc[]
-include::chapters/trx-backends.adoc[]
+include::{srcdir}/chapters/trx-backends.adoc[]
-include::chapters/code-architecture.adoc[]
+include::{srcdir}/chapters/code-architecture.adoc[]
include::./common/chapters/trx_if.adoc[]
diff --git a/OsmocomBB/osmocombb-usermanual.adoc b/OsmocomBB/osmocombb-usermanual.adoc
index c055577..024fc79 100644
--- a/OsmocomBB/osmocombb-usermanual.adoc
+++ b/OsmocomBB/osmocombb-usermanual.adoc
@@ -5,7 +5,7 @@ Holger Hans Peter Freyther <holger@moiji-mobile.com>
include::./common/chapters/preface.adoc[]
-include::chapters/scripting.adoc[]
+include::{srcdir}/chapters/scripting.adoc[]
include::./common/chapters/vty.adoc[]
diff --git a/build/Makefile.asciidoc.inc b/build/Makefile.asciidoc.inc
index 2e3db86..fb44a63 100644
--- a/build/Makefile.asciidoc.inc
+++ b/build/Makefile.asciidoc.inc
@@ -36,7 +36,7 @@ CLEAN_FILES += $(ASCIIDOC_NAME:%=%__*.png) $(ASCIIDOC_NAME:%=%__*.svg) $(ASCIIDO
CLEAN_FILES += $(ASCIIDOC_PDF) $(ASCIIDOC_NAME:%=%.html)
UPLOAD_FILES += $(ASCIIDOC_PDF)
-ASCIIDOC_OPTS := -f $(BUILDDIR)/mscgen-filter.conf -f $(BUILDDIR)/diag-filter.conf -f $(BUILDDIR)/docinfo-releaseinfo.conf -f $(BUILDDIR)/python2-filter.conf
+ASCIIDOC_OPTS := -f $(BUILDDIR)/mscgen-filter.conf -f $(BUILDDIR)/diag-filter.conf -f $(BUILDDIR)/docinfo-releaseinfo.conf -f $(BUILDDIR)/python2-filter.conf -a srcdir='$(srcdir)'
DBLATEX_OPTS := -s $(ASCIIDOCSTYLE) -P draft.mode=yes -P draft.watermark=0
ifeq (,$(BUILD_RELEASE))