<p>osmith has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/12073">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">add manuals from osmo-gsm-manuals.git<br><br>Move to doc/manuals/, with full commit history. Build with:<br><br>$ autoreconf -fi<br>$ ./configure --enable-manuals<br>$ make<br><br>Shared files from osmo-gsm-manuals.git are found automatically if the<br>repository is checked out in ../osmo-gsm-manuals, or if it was installed<br>with "make install". Otherwise OSMO_GSM_MANUALS_DIR needs to be set.<br><br>Related: OS#3385<br>Change-Id: I1317131ed6765fec996344fc6ed08350187b615b<br>---<br>M .gitignore<br>M configure.ac<br>M doc/Makefile.am<br>D doc/manuals/Makefile<br>A doc/manuals/Makefile.am<br>M doc/manuals/osmosipconnector-usermanual.adoc<br>M doc/manuals/osmosipconnector-vty-reference.xml<br>7 files changed, 85 insertions(+), 22 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-sip-connector refs/changes/73/12073/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/.gitignore b/.gitignore</span><br><span>index 87bed96..0fa1ce0 100644</span><br><span>--- a/.gitignore</span><br><span>+++ b/.gitignore</span><br><span>@@ -22,3 +22,14 @@</span><br><span> osmo-sip-connector</span><br><span> .tarball-version</span><br><span> .version</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+# manuals</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/*.html</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/*.svg</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/*.pdf</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/*__*.png</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/*.check</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/generated/</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/osmomsc-usermanual.xml</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/common</span><br><span style="color: hsl(120, 100%, 40%);">+doc/manuals/build</span><br><span>diff --git a/configure.ac b/configure.ac</span><br><span>index cdb42a5..407bd9e 100644</span><br><span>--- a/configure.ac</span><br><span>+++ b/configure.ac</span><br><span>@@ -77,6 +77,48 @@</span><br><span> AC_MSG_RESULT([$enable_ext_tests])</span><br><span> AM_CONDITIONAL(ENABLE_EXT_TESTS, test "x$enable_ext_tests" = "xyes")</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+# Generate manuals</span><br><span style="color: hsl(120, 100%, 40%);">+AC_ARG_ENABLE(manuals,</span><br><span style="color: hsl(120, 100%, 40%);">+ [AS_HELP_STRING(</span><br><span style="color: hsl(120, 100%, 40%);">+ [--enable-manuals],</span><br><span style="color: hsl(120, 100%, 40%);">+ [Generate manual PDFs [default=no]],</span><br><span style="color: hsl(120, 100%, 40%);">+ )],</span><br><span style="color: hsl(120, 100%, 40%);">+ [osmo_ac_build_manuals=$enableval], [osmo_ac_build_manuals="no"])</span><br><span style="color: hsl(120, 100%, 40%);">+AM_CONDITIONAL([BUILD_MANUALS], [test x"$osmo_ac_build_manuals" = x"yes"])</span><br><span style="color: hsl(120, 100%, 40%);">+AC_ARG_VAR(OSMO_GSM_MANUALS_DIR, [path to common osmo-gsm-manuals files, overriding pkg-config and "../osmo-gsm-manuals"</span><br><span style="color: hsl(120, 100%, 40%);">+ fallback])</span><br><span style="color: hsl(120, 100%, 40%);">+if test x"$osmo_ac_build_manuals" = x"yes"</span><br><span style="color: hsl(120, 100%, 40%);">+then</span><br><span style="color: hsl(120, 100%, 40%);">+ # Find OSMO_GSM_MANUALS_DIR (env, pkg-conf, fallback)</span><br><span style="color: hsl(120, 100%, 40%);">+ if test -n "$OSMO_GSM_MANUALS_DIR"; then</span><br><span style="color: hsl(120, 100%, 40%);">+ echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (from env)"</span><br><span style="color: hsl(120, 100%, 40%);">+ else</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_GSM_MANUALS_DIR="$($PKG_CONFIG osmo-gsm-manuals --variable=osmogsmmanualsdir 2>/dev/null)"</span><br><span style="color: hsl(120, 100%, 40%);">+ if test -n "$OSMO_GSM_MANUALS_DIR"; then</span><br><span style="color: hsl(120, 100%, 40%);">+ echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (from pkg-conf)"</span><br><span style="color: hsl(120, 100%, 40%);">+ else</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_GSM_MANUALS_DIR="../osmo-gsm-manuals"</span><br><span style="color: hsl(120, 100%, 40%);">+ echo "checking for OSMO_GSM_MANUALS_DIR... $OSMO_GSM_MANUALS_DIR (fallback)"</span><br><span style="color: hsl(120, 100%, 40%);">+ fi</span><br><span style="color: hsl(120, 100%, 40%);">+ fi</span><br><span style="color: hsl(120, 100%, 40%);">+ if ! test -d "$OSMO_GSM_MANUALS_DIR"; then</span><br><span style="color: hsl(120, 100%, 40%);">+ AC_MSG_ERROR("OSMO_GSM_MANUALS_DIR does not exist! Install osmo-gsm-manuals or set OSMO_GSM_MANUALS_DIR.")</span><br><span style="color: hsl(120, 100%, 40%);">+ fi</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Find and run check-depends</span><br><span style="color: hsl(120, 100%, 40%);">+ CHECK_DEPENDS="$OSMO_GSM_MANUALS_DIR/check-depends.sh"</span><br><span style="color: hsl(120, 100%, 40%);">+ if ! test -x "$CHECK_DEPENDS"; then</span><br><span style="color: hsl(120, 100%, 40%);">+ CHECK_DEPENDS="osmo-gsm-manuals-check-depends"</span><br><span style="color: hsl(120, 100%, 40%);">+ fi</span><br><span style="color: hsl(120, 100%, 40%);">+ if ! $CHECK_DEPENDS; then</span><br><span style="color: hsl(120, 100%, 40%);">+ AC_MSG_ERROR("missing dependencies for --enable-manuals")</span><br><span style="color: hsl(120, 100%, 40%);">+ fi</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Put in Makefile with absolute path</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_GSM_MANUALS_DIR="$(realpath "$OSMO_GSM_MANUALS_DIR")"</span><br><span style="color: hsl(120, 100%, 40%);">+ AC_SUBST([OSMO_GSM_MANUALS_DIR])</span><br><span style="color: hsl(120, 100%, 40%);">+fi</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> # https://www.freedesktop.org/software/systemd/man/daemon.html</span><br><span> AC_ARG_WITH([systemdsystemunitdir],</span><br><span> [AS_HELP_STRING([--with-systemdsystemunitdir=DIR], [Directory for systemd service files])],,</span><br><span>@@ -101,6 +143,7 @@</span><br><span> AC_OUTPUT(</span><br><span> src/Makefile</span><br><span> tests/Makefile</span><br><span style="color: hsl(120, 100%, 40%);">+ doc/manuals/Makefile</span><br><span> contrib/Makefile</span><br><span> contrib/systemd/Makefile</span><br><span> doc/Makefile</span><br><span>diff --git a/doc/Makefile.am b/doc/Makefile.am</span><br><span>index aee2d7b..15f36b7 100644</span><br><span>--- a/doc/Makefile.am</span><br><span>+++ b/doc/Makefile.am</span><br><span>@@ -1 +1,4 @@</span><br><span style="color: hsl(0, 100%, 40%);">-SUBDIRS = examples</span><br><span style="color: hsl(120, 100%, 40%);">+SUBDIRS = \</span><br><span style="color: hsl(120, 100%, 40%);">+ examples \</span><br><span style="color: hsl(120, 100%, 40%);">+ manuals \</span><br><span style="color: hsl(120, 100%, 40%);">+ $(NULL)</span><br><span>diff --git a/doc/manuals/Makefile b/doc/manuals/Makefile</span><br><span>deleted file mode 100644</span><br><span>index cd3bb89..0000000</span><br><span>--- a/doc/manuals/Makefile</span><br><span>+++ /dev/null</span><br><span>@@ -1,10 +0,0 @@</span><br><span style="color: hsl(0, 100%, 40%);">-TOPDIR = ..</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-ASCIIDOC = osmosipconnector-usermanual.adoc</span><br><span style="color: hsl(0, 100%, 40%);">-ASCIIDOC_DEPS = chapters/*.adoc</span><br><span style="color: hsl(0, 100%, 40%);">-include $(TOPDIR)/build/Makefile.asciidoc.inc</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-VTY_REFERENCE = osmosipconnector-vty-reference.xml</span><br><span style="color: hsl(0, 100%, 40%);">-include $(TOPDIR)/build/Makefile.vty-reference.inc</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-include $(TOPDIR)/build/Makefile.common.inc</span><br><span>diff --git a/doc/manuals/Makefile.am b/doc/manuals/Makefile.am</span><br><span>new file mode 100644</span><br><span>index 0000000..1a9b5b9</span><br><span>--- /dev/null</span><br><span>+++ b/doc/manuals/Makefile.am</span><br><span>@@ -0,0 +1,16 @@</span><br><span style="color: hsl(120, 100%, 40%);">+EXTRA_DIST = osmosipconnector-usermanual.adoc \</span><br><span style="color: hsl(120, 100%, 40%);">+ osmosipconnector-usermanual-docinfo.xml \</span><br><span style="color: hsl(120, 100%, 40%);">+ osmosipconnector-vty-reference.xml \</span><br><span style="color: hsl(120, 100%, 40%);">+ chapters \</span><br><span style="color: hsl(120, 100%, 40%);">+ vty</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+if BUILD_MANUALS</span><br><span style="color: hsl(120, 100%, 40%);">+ ASCIIDOC = osmosipconnector-usermanual.adoc</span><br><span style="color: hsl(120, 100%, 40%);">+ ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc</span><br><span style="color: hsl(120, 100%, 40%);">+ include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ VTY_REFERENCE = osmosipconnector-vty-reference.xml</span><br><span style="color: hsl(120, 100%, 40%);">+ include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.vty-reference.inc</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc</span><br><span style="color: hsl(120, 100%, 40%);">+endif</span><br><span>diff --git a/doc/manuals/osmosipconnector-usermanual.adoc b/doc/manuals/osmosipconnector-usermanual.adoc</span><br><span>index 72f6c1f..72d7127 100644</span><br><span>--- a/doc/manuals/osmosipconnector-usermanual.adoc</span><br><span>+++ b/doc/manuals/osmosipconnector-usermanual.adoc</span><br><span>@@ -6,23 +6,23 @@</span><br><span> Daniel Willmann <dwillmann@sysmocom.de></span><br><span> </span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::../common/chapters/preface.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/preface.adoc[]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::chapters/overview.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+include::{srcdir}/chapters/overview.adoc[]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::chapters/running.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+include::{srcdir}/chapters/running.adoc[]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::../common/chapters/vty.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/vty.adoc[]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::../common/chapters/logging.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/logging.adoc[]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::chapters/configuration.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+include::{srcdir}/chapters/configuration.adoc[]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::../common/chapters/port_numbers.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/port_numbers.adoc[]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::../common/chapters/bibliography.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/bibliography.adoc[]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::../common/chapters/glossary.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/glossary.adoc[]</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-include::../common/chapters/gfdl.adoc[]</span><br><span style="color: hsl(120, 100%, 40%);">+include::./common/chapters/gfdl.adoc[]</span><br><span> </span><br><span>diff --git a/doc/manuals/osmosipconnector-vty-reference.xml b/doc/manuals/osmosipconnector-vty-reference.xml</span><br><span>index fe22a99..0eeb952 100644</span><br><span>--- a/doc/manuals/osmosipconnector-vty-reference.xml</span><br><span>+++ b/doc/manuals/osmosipconnector-vty-reference.xml</span><br><span>@@ -5,7 +5,7 @@</span><br><span> --></span><br><span> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML 5.0//EN"</span><br><span> "http://docbook.org/xml/5.0/dtd/docbook.dtd" [</span><br><span style="color: hsl(0, 100%, 40%);">-<!ENTITY chapter-vty SYSTEM "../common/chapters/vty.xml" ></span><br><span style="color: hsl(120, 100%, 40%);">+<!ENTITY chapter-vty SYSTEM "./common/chapters/vty.xml" ></span><br><span> <!ENTITY sections-vty SYSTEM "generated/docbook_vty.xml" ></span><br><span> ]></span><br><span> </span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/12073">change 12073</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/12073"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-sip-connector </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I1317131ed6765fec996344fc6ed08350187b615b </div>
<div style="display:none"> Gerrit-Change-Number: 12073 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: osmith <osmith@sysmocom.de> </div>