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:28:24 +0100
commitbf47f717854d0d460da156a565eae1141793ce58 (patch)
tree6be0e535cbb8c28ba1282bb8bdfe48b833763ef6 /doc
parent2b7a860ffb493aef75e7fc6f67574e1eb3663761 (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: I14533676d5774ee0d0ee5054ba77d7dac32cff43
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/osmoggsn-usermanual.adoc24
-rw-r--r--doc/manuals/osmoggsn-vty-reference.xml2
5 files changed, 30 insertions, 23 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 46c634e..5284eb5 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -4,4 +4,5 @@ EXTRA_DIST = $(man_MANS)
SUBDIRS = \
examples \
+ manuals \
$(NULL)
diff --git a/doc/manuals/Makefile b/doc/manuals/Makefile
deleted file mode 100644
index e809632..0000000
--- a/doc/manuals/Makefile
+++ /dev/null
@@ -1,10 +0,0 @@
-TOPDIR = ..
-
-ASCIIDOC = osmoggsn-usermanual.adoc
-ASCIIDOC_DEPS = chapters/*.adoc
-include $(TOPDIR)/build/Makefile.asciidoc.inc
-
-VTY_REFERENCE = osmoggsn-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 0000000..d41ca2c
--- /dev/null
+++ b/doc/manuals/Makefile.am
@@ -0,0 +1,16 @@
+EXTRA_DIST = osmoggsn-usermanual.adoc \
+ osmoggsn-usermanual-docinfo.xml \
+ osmoggsn-vty-reference.xml \
+ chapters \
+ vty
+
+if BUILD_MANUALS
+ ASCIIDOC = osmoggsn-usermanual.adoc
+ ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc
+ include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
+
+ VTY_REFERENCE = osmoggsn-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/osmoggsn-usermanual.adoc b/doc/manuals/osmoggsn-usermanual.adoc
index efa2c8f..9bc3885 100644
--- a/doc/manuals/osmoggsn-usermanual.adoc
+++ b/doc/manuals/osmoggsn-usermanual.adoc
@@ -3,27 +3,27 @@ OsmoGGSN 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/control_if.adoc[]
+include::./common/chapters/control_if.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/osmoggsn-vty-reference.xml b/doc/manuals/osmoggsn-vty-reference.xml
index c9aea03..3ad7e83 100644
--- a/doc/manuals/osmoggsn-vty-reference.xml
+++ b/doc/manuals/osmoggsn-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" >
]>