From 4a1d8054315211becf9eac7707ac9b6986acbcc6 Mon Sep 17 00:00:00 2001 From: Oliver Smith Date: Wed, 14 Nov 2018 10:47:01 +0100 Subject: [PATCH] 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: I0477d7c871413bd90b365d3064bac3cba23a0883 --- .gitignore | 11 +++++++ configure.ac | 43 ++++++++++++++++++++++++++ doc/Makefile.am | 1 + doc/manuals/Makefile | 10 ------ doc/manuals/Makefile.am | 16 ++++++++++ doc/manuals/osmosgsn-usermanual.adoc | 32 +++++++++---------- doc/manuals/osmosgsn-vty-reference.xml | 2 +- 7 files changed, 88 insertions(+), 27 deletions(-) delete mode 100644 doc/manuals/Makefile create mode 100644 doc/manuals/Makefile.am diff --git a/.gitignore b/.gitignore index 78790884..3480380d 100644 --- a/.gitignore +++ b/.gitignore @@ -57,3 +57,14 @@ tests/testsuite.log gsn_restart writtenconfig/ gtphub_restart_count + +# manuals +doc/manuals/*.html +doc/manuals/*.svg +doc/manuals/*.pdf +doc/manuals/*__*.png +doc/manuals/*.check +doc/manuals/generated/ +doc/manuals/osmomsc-usermanual.xml +doc/manuals/common +doc/manuals/build diff --git a/configure.ac b/configure.ac index 0e4ff94c..f0bef528 100644 --- a/configure.ac +++ b/configure.ac @@ -177,6 +177,48 @@ AC_MSG_CHECKING([whether to enable VTY/CTRL tests]) AC_MSG_RESULT([$enable_ext_tests]) AM_CONDITIONAL(ENABLE_EXT_TESTS, test "x$enable_ext_tests" = "xyes") +# Generate manuals +AC_ARG_ENABLE(manuals, + [AS_HELP_STRING( + [--enable-manuals], + [Generate manual PDFs [default=no]], + )], + [osmo_ac_build_manuals=$enableval], [osmo_ac_build_manuals="no"]) +AM_CONDITIONAL([BUILD_MANUALS], [test x"$osmo_ac_build_manuals" = x"yes"]) +AC_ARG_VAR(OSMO_GSM_MANUALS_DIR, [path to common osmo-gsm-manuals files, overriding pkg-config and "../osmo-gsm-manuals" + fallback]) +if test x"$osmo_ac_build_manuals" = x"yes" +then + # Find OSMO_GSM_MANUALS_DIR (env, pkg-conf, fallback) + if test -n "$OSMO_GSM_MANUALS_DIR"; then + echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (from env)" + else + OSMO_GSM_MANUALS_DIR="$($PKG_CONFIG osmo-gsm-manuals --variable=osmogsmmanualsdir 2>/dev/null)" + if test -n "$OSMO_GSM_MANUALS_DIR"; then + echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (from pkg-conf)" + else + OSMO_GSM_MANUALS_DIR="../osmo-gsm-manuals" + echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (fallback)" + fi + fi + if ! test -d "$OSMO_GSM_MANUALS_DIR"; then + AC_MSG_ERROR("OSMO_GSM_MANUALS_DIR does not exist! Install osmo-gsm-manuals or set OSMO_GSM_MANUALS_DIR.") + fi + + # Find and run check-depends + CHECK_DEPENDS="$OSMO_GSM_MANUALS_DIR/check-depends.sh" + if ! test -x "$CHECK_DEPENDS"; then + CHECK_DEPENDS="osmo-gsm-manuals-check-depends" + fi + if ! $CHECK_DEPENDS; then + AC_MSG_ERROR("missing dependencies for --enable-manuals") + fi + + # Put in Makefile with absolute path + OSMO_GSM_MANUALS_DIR="$(realpath "$OSMO_GSM_MANUALS_DIR")" + AC_SUBST([OSMO_GSM_MANUALS_DIR]) +fi + # https://www.freedesktop.org/software/systemd/man/daemon.html AC_ARG_WITH([systemdsystemunitdir], [AS_HELP_STRING([--with-systemdsystemunitdir=DIR], [Directory for systemd service files])],, @@ -218,6 +260,7 @@ AC_OUTPUT( tests/v42bis/Makefile doc/Makefile doc/examples/Makefile + doc/manuals/Makefile contrib/Makefile contrib/systemd/Makefile Makefile) diff --git a/doc/Makefile.am b/doc/Makefile.am index 5a231074..15f36b7e 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 baa1a49f..00000000 --- a/doc/manuals/Makefile +++ /dev/null @@ -1,10 +0,0 @@ -TOPDIR = .. - -ASCIIDOC = osmosgsn-usermanual.adoc -ASCIIDOC_DEPS = chapters/*.adoc -include $(TOPDIR)/build/Makefile.asciidoc.inc - -VTY_REFERENCE = osmosgsn-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..00a08c8c --- /dev/null +++ b/doc/manuals/Makefile.am @@ -0,0 +1,16 @@ +EXTRA_DIST = osmosgsn-usermanual.adoc \ + osmosgsn-usermanual-docinfo.xml \ + osmosgsn-vty-reference.xml \ + chapters \ + vty + +if BUILD_MANUALS + ASCIIDOC = osmosgsn-usermanual.adoc + ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc + include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc + + VTY_REFERENCE = osmosgsn-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/osmosgsn-usermanual.adoc b/doc/manuals/osmosgsn-usermanual.adoc index 079e8117..dea91a90 100644 --- a/doc/manuals/osmosgsn-usermanual.adoc +++ b/doc/manuals/osmosgsn-usermanual.adoc @@ -5,34 +5,34 @@ OsmoSGSN User Manual Harald Welte -include::../common/chapters/preface.adoc[] +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/vty.adoc[] -include::../common/chapters/logging.adoc[] +include::./common/chapters/logging.adoc[] -include::chapters/configuration.adoc[] +include::{srcdir}/chapters/configuration.adoc[] -include::../common/chapters/gb.adoc[] +include::./common/chapters/gb.adoc[] -include::../common/chapters/control_if.adoc[] +include::./common/chapters/control_if.adoc[] -include::../common/chapters/oap.adoc[] +include::./common/chapters/oap.adoc[] -include::../common/chapters/gsup.adoc[] +include::./common/chapters/gsup.adoc[] -include::chapters/counters.adoc[] +include::{srcdir}/chapters/counters.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/osmosgsn-vty-reference.xml b/doc/manuals/osmosgsn-vty-reference.xml index 9a8b8d9b..82b666a0 100644 --- a/doc/manuals/osmosgsn-vty-reference.xml +++ b/doc/manuals/osmosgsn-vty-reference.xml @@ -5,7 +5,7 @@ --> + ]>