summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOliver Smith <osmith@sysmocom.de>2018-11-29 10:28:10 +0100
committerOliver Smith <osmith@sysmocom.de>2018-11-29 16:19:08 +0100
commiteaa61bff5d06588f4c97f43b4a85f3a9a05b50c4 (patch)
treea0f8b186aace52b6dee4225091697293927b08d7
parent751f410a056725ea05294ee51e8f15fb0cdf4cb8 (diff)
manuals/OsmoNITB: integrate into this repository
Move from doc/manuals to manuals/OsmoNITB as we have two more manuals (OsmoMGCP and OsmoNAT) that need to be moved to manuals/. Make the manuals build without a toplevel configure.ac file from autotools: $ cd manuals/OsmoNITB $ make openbsc/configure.ac is not used to integrate the manuals, as it would be extra effort to integrate all three of the manuals there. This is not worth it for the legacy codebase. Related: OS#3385 Change-Id: I0036ad8dbecd23695305ac491c7ee87caa44c7f9
-rw-r--r--manuals/.gitignore8
-rw-r--r--manuals/OsmoNITB/Makefile (renamed from doc/manuals/Makefile.am)8
-rw-r--r--manuals/OsmoNITB/chapters/bts-examples.adoc (renamed from doc/manuals/chapters/bts-examples.adoc)0
-rw-r--r--manuals/OsmoNITB/chapters/control.adoc (renamed from doc/manuals/chapters/control.adoc)0
-rw-r--r--manuals/OsmoNITB/chapters/hlr.adoc (renamed from doc/manuals/chapters/hlr.adoc)0
-rw-r--r--manuals/OsmoNITB/chapters/net.adoc (renamed from doc/manuals/chapters/net.adoc)0
-rw-r--r--manuals/OsmoNITB/chapters/overview.adoc (renamed from doc/manuals/chapters/overview.adoc)0
-rw-r--r--manuals/OsmoNITB/chapters/running.adoc (renamed from doc/manuals/chapters/running.adoc)0
-rw-r--r--manuals/OsmoNITB/osmonitb-usermanual-docinfo.xml (renamed from doc/manuals/osmonitb-usermanual-docinfo.xml)0
-rw-r--r--manuals/OsmoNITB/osmonitb-usermanual.adoc (renamed from doc/manuals/osmonitb-usermanual.adoc)0
-rw-r--r--manuals/OsmoNITB/osmonitb-vty-reference.xml (renamed from doc/manuals/osmonitb-vty-reference.xml)0
-rw-r--r--manuals/OsmoNITB/vty/bsc_vty_additions.xml (renamed from doc/manuals/vty/bsc_vty_additions.xml)0
-rw-r--r--manuals/OsmoNITB/vty/nitb_vty_additions.xml (renamed from doc/manuals/vty/nitb_vty_additions.xml)0
-rw-r--r--manuals/OsmoNITB/vty/nitb_vty_reference.xml (renamed from doc/manuals/vty/nitb_vty_reference.xml)0
-rwxr-xr-xmanuals/osmo-gsm-manuals-dir.sh26
15 files changed, 36 insertions, 6 deletions
diff --git a/manuals/.gitignore b/manuals/.gitignore
new file mode 100644
index 000000000..565590fda
--- /dev/null
+++ b/manuals/.gitignore
@@ -0,0 +1,8 @@
+*.html
+*.svg
+*.pdf
+*__*.png
+*.check
+generated
+common
+build
diff --git a/doc/manuals/Makefile.am b/manuals/OsmoNITB/Makefile
index 3735c5be9..9f28305d8 100644
--- a/doc/manuals/Makefile.am
+++ b/manuals/OsmoNITB/Makefile
@@ -1,9 +1,5 @@
-OSMO_GSM_MANUALS_DIR = $(top_srcdir)
-EXTRA_DIST = osmonitb-usermanual.adoc \
- osmonitb-usermanual-docinfo.xml \
- osmonitb-vty-reference.xml \
- chapters \
- vty
+OSMO_GSM_MANUALS_DIR := $(shell ../osmo-gsm-manuals-dir.sh)
+srcdir=$(CURDIR)
ASCIIDOC = osmonitb-usermanual.adoc
ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc
diff --git a/doc/manuals/chapters/bts-examples.adoc b/manuals/OsmoNITB/chapters/bts-examples.adoc
index b15fb9921..b15fb9921 100644
--- a/doc/manuals/chapters/bts-examples.adoc
+++ b/manuals/OsmoNITB/chapters/bts-examples.adoc
diff --git a/doc/manuals/chapters/control.adoc b/manuals/OsmoNITB/chapters/control.adoc
index db12bbb68..db12bbb68 100644
--- a/doc/manuals/chapters/control.adoc
+++ b/manuals/OsmoNITB/chapters/control.adoc
diff --git a/doc/manuals/chapters/hlr.adoc b/manuals/OsmoNITB/chapters/hlr.adoc
index 8f2840a6e..8f2840a6e 100644
--- a/doc/manuals/chapters/hlr.adoc
+++ b/manuals/OsmoNITB/chapters/hlr.adoc
diff --git a/doc/manuals/chapters/net.adoc b/manuals/OsmoNITB/chapters/net.adoc
index 455e1a6ab..455e1a6ab 100644
--- a/doc/manuals/chapters/net.adoc
+++ b/manuals/OsmoNITB/chapters/net.adoc
diff --git a/doc/manuals/chapters/overview.adoc b/manuals/OsmoNITB/chapters/overview.adoc
index d161af3f9..d161af3f9 100644
--- a/doc/manuals/chapters/overview.adoc
+++ b/manuals/OsmoNITB/chapters/overview.adoc
diff --git a/doc/manuals/chapters/running.adoc b/manuals/OsmoNITB/chapters/running.adoc
index 406c41c19..406c41c19 100644
--- a/doc/manuals/chapters/running.adoc
+++ b/manuals/OsmoNITB/chapters/running.adoc
diff --git a/doc/manuals/osmonitb-usermanual-docinfo.xml b/manuals/OsmoNITB/osmonitb-usermanual-docinfo.xml
index 87d72da7e..87d72da7e 100644
--- a/doc/manuals/osmonitb-usermanual-docinfo.xml
+++ b/manuals/OsmoNITB/osmonitb-usermanual-docinfo.xml
diff --git a/doc/manuals/osmonitb-usermanual.adoc b/manuals/OsmoNITB/osmonitb-usermanual.adoc
index 42afe89de..42afe89de 100644
--- a/doc/manuals/osmonitb-usermanual.adoc
+++ b/manuals/OsmoNITB/osmonitb-usermanual.adoc
diff --git a/doc/manuals/osmonitb-vty-reference.xml b/manuals/OsmoNITB/osmonitb-vty-reference.xml
index da0e358a2..da0e358a2 100644
--- a/doc/manuals/osmonitb-vty-reference.xml
+++ b/manuals/OsmoNITB/osmonitb-vty-reference.xml
diff --git a/doc/manuals/vty/bsc_vty_additions.xml b/manuals/OsmoNITB/vty/bsc_vty_additions.xml
index f62f8b1c0..f62f8b1c0 100644
--- a/doc/manuals/vty/bsc_vty_additions.xml
+++ b/manuals/OsmoNITB/vty/bsc_vty_additions.xml
diff --git a/doc/manuals/vty/nitb_vty_additions.xml b/manuals/OsmoNITB/vty/nitb_vty_additions.xml
index 7ea60dce5..7ea60dce5 100644
--- a/doc/manuals/vty/nitb_vty_additions.xml
+++ b/manuals/OsmoNITB/vty/nitb_vty_additions.xml
diff --git a/doc/manuals/vty/nitb_vty_reference.xml b/manuals/OsmoNITB/vty/nitb_vty_reference.xml
index 2e30dd6ec..2e30dd6ec 100644
--- a/doc/manuals/vty/nitb_vty_reference.xml
+++ b/manuals/OsmoNITB/vty/nitb_vty_reference.xml
diff --git a/manuals/osmo-gsm-manuals-dir.sh b/manuals/osmo-gsm-manuals-dir.sh
new file mode 100755
index 000000000..d080bc72d
--- /dev/null
+++ b/manuals/osmo-gsm-manuals-dir.sh
@@ -0,0 +1,26 @@
+#!/bin/sh -e
+# Find OSMO_GSM_MANUALS_DIR and print it to stdout. Print where it was taken from to stderr.
+
+# Find it in env, pkg-conf and ../../osmo-gsm-manuals
+RET="$OSMO_GSM_MANUALS_DIR"
+if [ -n "$RET" ]; then
+ RET="$(realpath $RET)"
+ echo "OSMO_GSM_MANUALS_DIR: $RET (from env)" >&2
+else
+ RET="$(pkg-config osmo-gsm-manuals --variable=osmogsmmanualsdir 2>/dev/null || true)"
+ if [ -n "$RET" ]; then
+ echo "OSMO_GSM_MANUALS_DIR: $RET (from pkg-conf)" >&2
+ else
+ RET="$(realpath $(realpath $(dirname $0))/../../osmo-gsm-manuals)"
+ echo "OSMO_GSM_MANUALS_DIR: $RET (fallback)" >&2
+ fi
+fi
+
+# Print the result or error message
+if [ -d "$RET" ]; then
+ echo "$RET"
+else
+ echo "ERROR: OSMO_GSM_MANUALS_DIR does not exist!" >&2
+ echo "Install osmo-gsm-manuals or set OSMO_GSM_MANUALS_DIR." >&2
+ exit 1
+fi