[PATCH] osmo-gsm-manuals[master]: OsmoGGSN: Add VTY reference manual

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

Harald Welte gerrit-no-reply at lists.osmocom.org
Wed Sep 6 23:02:19 UTC 2017


Review at  https://gerrit.osmocom.org/3879

OsmoGGSN: Add VTY reference manual

Change-Id: Iddf6fe26689172d7db001198943c816eaaed7931
---
M OsmoGGSN/Makefile
A OsmoGGSN/osmoggsn-vty-reference.xml
A OsmoGGSN/vty/ggsn_vty_additions.xml
3 files changed, 95 insertions(+), 1 deletion(-)


  git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-manuals refs/changes/79/3879/1

diff --git a/OsmoGGSN/Makefile b/OsmoGGSN/Makefile
index daf3597..2dfedb2 100644
--- a/OsmoGGSN/Makefile
+++ b/OsmoGGSN/Makefile
@@ -1,6 +1,18 @@
 # XSL stylesheets downloaded from http://docbook.sourceforge.net/release/xsl/current/html/
 # Makefile from BitBake/OpenEmbedded manuals
 
+EXTRA_DEPS = gen-ggsn-vty-docbook
+
+topdir = .
+ggsn_reference = $(topdir)/osmoggsn-vty-reference.xml
+manuals = $(ggsn_reference)
+# types = pdf txt rtf ps xhtml html man tex texi dvi
+# types = pdf txt
+types = $(docbooktotypes)
+docbooktotypes = pdf
+# htmlcssfile =
+# htmlcss =
+
 TOPDIR := ..
 ASCIIDOCS := osmoggsn-usermanual
 
@@ -10,4 +22,18 @@
 osmoggsn-usermanual.pdf: chapters/*.adoc
 
 clean:
-	rm -rf $(cleanfiles)
+	-rm -rf $(cleanfiles)
+	-rm osmoggsn-usermanual__*.svg osmoggsn-usermanual__*.png
+	-rm osmoggsn-usermanual.check
+
+gen-ggsn-vty-docbook: FORCE
+	$(call command,xsltproc -o generated/combined1.xml \
+		--stringparam with $(PWD)/../common/vty_additions.xml \
+		$(MERGE_DOC) vty/ggsn_vty_reference.xml, \
+		XSLTPROC,Merging Common VTY)
+	$(call command,xsltproc -o generated/combined2.xml \
+		--stringparam with $(PWD)/vty/ggsn_vty_additions.xml \
+		$(MERGE_DOC) generated/combined1.xml, \
+		XSLTPROC,Merging GGSN VTY)
+	$(call command,xsltproc ../vty_reference.xsl generated/combined2.xml > generated/docbook_vty.xml, \
+		XSLTPROC,Converting GGSN VTY to DocBook)
diff --git a/OsmoGGSN/osmoggsn-vty-reference.xml b/OsmoGGSN/osmoggsn-vty-reference.xml
new file mode 100644
index 0000000..44e7bfc
--- /dev/null
+++ b/OsmoGGSN/osmoggsn-vty-reference.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ex:ts=2:sw=42sts=2:et
+  -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
+-->
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V5.0//EN"
+"http://www.docbook.org/xml/5.0/dtd/docbook.dtd" [
+<!ENTITY chapter-vty      SYSTEM      "../common/chapters/vty.xml" >
+<!ENTITY sections-vty     SYSTEM      "generated/docbook_vty.xml"  >
+]>
+
+<book>
+  <info>
+    <revhistory>
+        <revision>
+            <revnumber>v1</revnumber>
+            <date>06th September 2017</date>
+            <authorinitials>hw</authorinitials>
+            <revremark>Initial version as of OsmoGGSN v1.0.0</revremark>
+        </revision>
+    </revhistory>
+
+    <title>OsmoGGSN VTY Reference</title>
+
+    <copyright>
+      <year>2017</year>
+    </copyright>
+
+    <legalnotice>
+      <para>This work is copyright by <orgname>sysmocom - s.f.m.c. GmbH</orgname>. All rights reserved.
+      </para>
+    </legalnotice>
+  </info>
+
+  <!-- Main chapters-->
+  &chapter-vty;
+</book>
+
diff --git a/OsmoGGSN/vty/ggsn_vty_additions.xml b/OsmoGGSN/vty/ggsn_vty_additions.xml
new file mode 100644
index 0000000..1bbeb81
--- /dev/null
+++ b/OsmoGGSN/vty/ggsn_vty_additions.xml
@@ -0,0 +1,30 @@
+<vtydoc xmlns='urn:osmocom:xml:libosmocore:vty:doc:1.0'>
+	<node id="9">
+		<child_of nodeid='4' />
+		<name>Telnet/VTY Configuration Node</name>
+		<description>
+			Configure parameters of the Telnet/VTY Interface, such as to which IP address it should bind/listen to.
+		</description>
+	</node>
+	<node id="14">
+		<child_of nodeid='4' />
+		<name>CTRL Configuration Node</name>
+		<description>
+			Configure parameters of the CTRL Interface, such as to which IP address it should bind/listen to.
+		</description>
+	</node>
+	<node id="26">
+		<child_of nodeid='4' />
+		<name>GGSN Instance Configuration Node</name>
+		<description>
+			Configure an Instance of a (virtual) GGSN
+		</description>
+	</node>
+	<node id="27">
+		<child_of nodeid='26' />
+		<name>APN Configuration Node</name>
+		<description>
+			Configure an Access Point Name (APN) inside a GGSN Instance
+		</description>
+	</node>
+</vtydoc>

-- 
To view, visit https://gerrit.osmocom.org/3879
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Iddf6fe26689172d7db001198943c816eaaed7931
Gerrit-PatchSet: 1
Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-Owner: Harald Welte <laforge at gnumonks.org>



More information about the gerrit-log mailing list