aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorOliver Smith <osmith@sysmocom.de>2018-11-14 10:47:01 +0100
committerNeels Hofmeyr <neels@hofmeyr.de>2018-11-27 18:10:43 +0100
commitf164d895490acbc62358d0d4281d9a6ccd6c0e3d (patch)
tree092815aaac9b50ba7eb3426ead1c009af9ee0c5a /doc
parent1d2326d2cd43040278e7acebbbbd8387edbe39c2 (diff)
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
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/manuals/Makefile10
-rw-r--r--doc/manuals/Makefile.am16
-rw-r--r--doc/manuals/osmosgsn-usermanual.adoc32
-rw-r--r--doc/manuals/osmosgsn-vty-reference.xml2
5 files changed, 34 insertions, 27 deletions
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 <hwelte@sysmocom.de>
-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 @@
-->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML 5.0//EN"
"http://docbook.org/xml/5.0/dtd/docbook.dtd" [
-<!ENTITY chapter-vty SYSTEM "../common/chapters/vty.xml" >
+<!ENTITY chapter-vty SYSTEM "./common/chapters/vty.xml" >
<!ENTITY sections-vty SYSTEM "generated/docbook_vty.xml" >
]>