diff options
author | Oliver Smith <osmith@sysmocom.de> | 2018-11-14 10:47:01 +0100 |
---|---|---|
committer | Neels Hofmeyr <neels@hofmeyr.de> | 2018-11-27 18:36:41 +0100 |
commit | be8a83f681368307ca1c2d8726d27f5b98973231 (patch) | |
tree | c1a68071510dd724cc02adf1e00d52ee1ec56024 /doc | |
parent | d9a460dce97da62ec1a48757dec4999d14685c67 (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: I2762171af0bf719a34ba12a0c2e4dcc206098beb
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 1 | ||||
-rw-r--r-- | doc/manuals/Makefile | 10 | ||||
-rw-r--r-- | doc/manuals/Makefile.am | 16 | ||||
-rw-r--r-- | doc/manuals/osmotrx-usermanual.adoc | 36 | ||||
-rw-r--r-- | doc/manuals/osmotrx-vty-reference.xml | 2 |
5 files changed, 36 insertions, 29 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 1d42b0a..2f30815 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 81aec9a..0000000 --- a/doc/manuals/Makefile +++ /dev/null @@ -1,10 +0,0 @@ -TOPDIR = .. - -ASCIIDOC = osmotrx-usermanual.adoc -ASCIIDOC_DEPS = chapters/*.adoc -include $(TOPDIR)/build/Makefile.asciidoc.inc - -VTY_REFERENCE = osmotrx-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..a1f3bfb --- /dev/null +++ b/doc/manuals/Makefile.am @@ -0,0 +1,16 @@ +EXTRA_DIST = osmotrx-usermanual.adoc \ + osmotrx-usermanual-docinfo.xml \ + osmotrx-vty-reference.xml \ + chapters \ + vty + +if BUILD_MANUALS + ASCIIDOC = osmotrx-usermanual.adoc + ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc + include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc + + VTY_REFERENCE = osmotrx-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/osmotrx-usermanual.adoc b/doc/manuals/osmotrx-usermanual.adoc index 14f5514..a17a899 100644 --- a/doc/manuals/osmotrx-usermanual.adoc +++ b/doc/manuals/osmotrx-usermanual.adoc @@ -5,38 +5,38 @@ OsmoTRX User Manual Pau Espin Pedrol <pespin@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::../common/chapters/control_if.adoc[] +include::./common/chapters/control_if.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/counters.adoc[] +include::{srcdir}/chapters/counters.adoc[] -include::chapters/configuration.adoc[] +include::{srcdir}/chapters/configuration.adoc[] -include::chapters/trx-architectures.adoc[] +include::{srcdir}/chapters/trx-architectures.adoc[] -include::chapters/trx-devices.adoc[] +include::{srcdir}/chapters/trx-devices.adoc[] -include::chapters/trx-backends.adoc[] +include::{srcdir}/chapters/trx-backends.adoc[] -include::chapters/code-architecture.adoc[] +include::{srcdir}/chapters/code-architecture.adoc[] -include::../common/chapters/trx_if.adoc[] +include::./common/chapters/trx_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/osmotrx-vty-reference.xml b/doc/manuals/osmotrx-vty-reference.xml index ae0afbf..4291929 100644 --- a/doc/manuals/osmotrx-vty-reference.xml +++ b/doc/manuals/osmotrx-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" > ]> |