From eaa61bff5d06588f4c97f43b4a85f3a9a05b50c4 Mon Sep 17 00:00:00 2001 From: Oliver Smith Date: Thu, 29 Nov 2018 10:28:10 +0100 Subject: [PATCH] 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 --- manuals/.gitignore | 8 ++++++ .../Makefile.am => manuals/OsmoNITB/Makefile | 8 ++---- .../OsmoNITB}/chapters/bts-examples.adoc | 0 .../OsmoNITB}/chapters/control.adoc | 0 .../OsmoNITB}/chapters/hlr.adoc | 0 .../OsmoNITB}/chapters/net.adoc | 0 .../OsmoNITB}/chapters/overview.adoc | 0 .../OsmoNITB}/chapters/running.adoc | 0 .../OsmoNITB}/osmonitb-usermanual-docinfo.xml | 0 .../OsmoNITB}/osmonitb-usermanual.adoc | 0 .../OsmoNITB}/osmonitb-vty-reference.xml | 0 .../OsmoNITB}/vty/bsc_vty_additions.xml | 0 .../OsmoNITB}/vty/nitb_vty_additions.xml | 0 .../OsmoNITB}/vty/nitb_vty_reference.xml | 0 manuals/osmo-gsm-manuals-dir.sh | 26 +++++++++++++++++++ 15 files changed, 36 insertions(+), 6 deletions(-) create mode 100644 manuals/.gitignore rename doc/manuals/Makefile.am => manuals/OsmoNITB/Makefile (65%) rename {doc/manuals => manuals/OsmoNITB}/chapters/bts-examples.adoc (100%) rename {doc/manuals => manuals/OsmoNITB}/chapters/control.adoc (100%) rename {doc/manuals => manuals/OsmoNITB}/chapters/hlr.adoc (100%) rename {doc/manuals => manuals/OsmoNITB}/chapters/net.adoc (100%) rename {doc/manuals => manuals/OsmoNITB}/chapters/overview.adoc (100%) rename {doc/manuals => manuals/OsmoNITB}/chapters/running.adoc (100%) rename {doc/manuals => manuals/OsmoNITB}/osmonitb-usermanual-docinfo.xml (100%) rename {doc/manuals => manuals/OsmoNITB}/osmonitb-usermanual.adoc (100%) rename {doc/manuals => manuals/OsmoNITB}/osmonitb-vty-reference.xml (100%) rename {doc/manuals => manuals/OsmoNITB}/vty/bsc_vty_additions.xml (100%) rename {doc/manuals => manuals/OsmoNITB}/vty/nitb_vty_additions.xml (100%) rename {doc/manuals => manuals/OsmoNITB}/vty/nitb_vty_reference.xml (100%) create mode 100755 manuals/osmo-gsm-manuals-dir.sh 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 similarity index 65% rename from doc/manuals/Makefile.am rename to 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 similarity index 100% rename from doc/manuals/chapters/bts-examples.adoc rename to manuals/OsmoNITB/chapters/bts-examples.adoc diff --git a/doc/manuals/chapters/control.adoc b/manuals/OsmoNITB/chapters/control.adoc similarity index 100% rename from doc/manuals/chapters/control.adoc rename to manuals/OsmoNITB/chapters/control.adoc diff --git a/doc/manuals/chapters/hlr.adoc b/manuals/OsmoNITB/chapters/hlr.adoc similarity index 100% rename from doc/manuals/chapters/hlr.adoc rename to manuals/OsmoNITB/chapters/hlr.adoc diff --git a/doc/manuals/chapters/net.adoc b/manuals/OsmoNITB/chapters/net.adoc similarity index 100% rename from doc/manuals/chapters/net.adoc rename to manuals/OsmoNITB/chapters/net.adoc diff --git a/doc/manuals/chapters/overview.adoc b/manuals/OsmoNITB/chapters/overview.adoc similarity index 100% rename from doc/manuals/chapters/overview.adoc rename to manuals/OsmoNITB/chapters/overview.adoc diff --git a/doc/manuals/chapters/running.adoc b/manuals/OsmoNITB/chapters/running.adoc similarity index 100% rename from doc/manuals/chapters/running.adoc rename to manuals/OsmoNITB/chapters/running.adoc diff --git a/doc/manuals/osmonitb-usermanual-docinfo.xml b/manuals/OsmoNITB/osmonitb-usermanual-docinfo.xml similarity index 100% rename from doc/manuals/osmonitb-usermanual-docinfo.xml rename to manuals/OsmoNITB/osmonitb-usermanual-docinfo.xml diff --git a/doc/manuals/osmonitb-usermanual.adoc b/manuals/OsmoNITB/osmonitb-usermanual.adoc similarity index 100% rename from doc/manuals/osmonitb-usermanual.adoc rename to manuals/OsmoNITB/osmonitb-usermanual.adoc diff --git a/doc/manuals/osmonitb-vty-reference.xml b/manuals/OsmoNITB/osmonitb-vty-reference.xml similarity index 100% rename from doc/manuals/osmonitb-vty-reference.xml rename to manuals/OsmoNITB/osmonitb-vty-reference.xml diff --git a/doc/manuals/vty/bsc_vty_additions.xml b/manuals/OsmoNITB/vty/bsc_vty_additions.xml similarity index 100% rename from doc/manuals/vty/bsc_vty_additions.xml rename to 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 similarity index 100% rename from doc/manuals/vty/nitb_vty_additions.xml rename to 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 similarity index 100% rename from doc/manuals/vty/nitb_vty_reference.xml rename to 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