From 686deafa487802c6a99ef099d17d2e963dc2876c Mon Sep 17 00:00:00 2001 From: Oliver Smith Date: Wed, 14 Nov 2018 10:47:01 +0100 Subject: build manuals included from osmo-gsm-manuals.git Moved to doc/manuals/, with full commit history, in preceding merge commit. Now incorporate in local 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: I92c0f771d4ffc2b0401d26e25cb0b3817e6f95ea --- doc/manuals/Makefile | 11 ----------- doc/manuals/Makefile.am | 24 ++++++++++++++++++++++++ doc/manuals/aoip-mgw-options.adoc | 8 ++++---- doc/manuals/osmobsc-usermanual.adoc | 34 +++++++++++++++++----------------- doc/manuals/osmobsc-vty-reference.xml | 2 +- 5 files changed, 46 insertions(+), 33 deletions(-) delete mode 100644 doc/manuals/Makefile create mode 100644 doc/manuals/Makefile.am (limited to 'doc/manuals') diff --git a/doc/manuals/Makefile b/doc/manuals/Makefile deleted file mode 100644 index b9f50d0d9..000000000 --- a/doc/manuals/Makefile +++ /dev/null @@ -1,11 +0,0 @@ -TOPDIR = .. - -ASCIIDOC = osmobsc-usermanual.adoc osmux-reference.adoc aoip-mgw-options.adoc -include $(TOPDIR)/build/Makefile.asciidoc.inc -osmobsc-usermanual.pdf: chapters/*.adoc chapters/*.dot -aoip-mgw-options.pdf: aoip-mgw-options.adoc mgw/*.msc - -VTY_REFERENCE = osmobsc-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 000000000..482c1ab32 --- /dev/null +++ b/doc/manuals/Makefile.am @@ -0,0 +1,24 @@ +EXTRA_DIST = aoip-mgw-options.adoc \ + aoip-mgw-options-docinfo.xml \ + osmobsc-usermanual.adoc \ + osmobsc-usermanual-docinfo.xml \ + osmobsc-vty-reference.xml \ + osmux-reference.adoc \ + osmux-reference-docinfo.xml \ + chapters \ + message-sequences \ + mgw \ + om2000 \ + vty + +if BUILD_MANUALS + ASCIIDOC = osmobsc-usermanual.adoc osmux-reference.adoc aoip-mgw-options.adoc + include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc + osmobsc-usermanual.pdf: $(srcdir)/chapters/*.adoc $(srcdir)/chapters/*.dot + aoip-mgw-options.pdf: $(srcdir)/aoip-mgw-options.adoc $(srcdir)/mgw/*.msc + + VTY_REFERENCE = osmobsc-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/aoip-mgw-options.adoc b/doc/manuals/aoip-mgw-options.adoc index 8ce3b91a5..f69309334 100644 --- a/doc/manuals/aoip-mgw-options.adoc +++ b/doc/manuals/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/doc/manuals/osmobsc-usermanual.adoc b/doc/manuals/osmobsc-usermanual.adoc index 19846785c..eec77d7e7 100644 --- a/doc/manuals/osmobsc-usermanual.adoc +++ b/doc/manuals/osmobsc-usermanual.adoc @@ -5,39 +5,39 @@ OsmoBSC 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::chapters/counters.adoc[] +include::{srcdir}/chapters/counters.adoc[] -include::chapters/handover.adoc[] +include::{srcdir}/chapters/handover.adoc[] -include::../common/chapters/vty.adoc[] +include::./common/chapters/vty.adoc[] -include::../common/chapters/logging.adoc[] +include::./common/chapters/logging.adoc[] -include::../common/chapters/bts.adoc[] +include::./common/chapters/bts.adoc[] include::{srcdir}/chapters/bts-examples.adoc[] -include::../common/chapters/bsc.adoc[] +include::./common/chapters/bsc.adoc[] -include::../common/chapters/abis.adoc[] +include::./common/chapters/abis.adoc[] -include::../common/chapters/control_if.adoc[] +include::./common/chapters/control_if.adoc[] -include::../common/chapters/cell-broadcast.adoc[] +include::./common/chapters/cell-broadcast.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/osmobsc-vty-reference.xml b/doc/manuals/osmobsc-vty-reference.xml index 6d993b458..f51e56eff 100644 --- a/doc/manuals/osmobsc-vty-reference.xml +++ b/doc/manuals/osmobsc-vty-reference.xml @@ -5,7 +5,7 @@ --> + ]> -- cgit v1.2.3