Change in libosmocore[master]: osmo-config-merge: Add manual page

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/.

daniel gerrit-no-reply at lists.osmocom.org
Thu Sep 27 16:57:45 UTC 2018


daniel has uploaded this change for review. ( https://gerrit.osmocom.org/11133


Change subject: osmo-config-merge: Add manual page
......................................................................

osmo-config-merge: Add manual page

Change-Id: Ifaa5afe28779a805764caf76a89efb0a3169942e
---
M Makefile.am
M configure.ac
A man/Makefile.am
A man/osmo-config-merge.txt
4 files changed, 94 insertions(+), 1 deletion(-)



  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/33/11133/1

diff --git a/Makefile.am b/Makefile.am
index de5eb35..745d482 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,7 +1,7 @@
 ACLOCAL_AMFLAGS = -I m4
 
 AM_CPPFLAGS = $(all_includes) -I$(top_srcdir)/include
-SUBDIRS = include src src/vty src/codec src/gsm src/coding src/gb src/ctrl src/sim src/pseudotalloc utils tests
+SUBDIRS = include src src/vty src/codec src/gsm src/coding src/gb src/ctrl src/sim src/pseudotalloc utils tests man
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = libosmocore.pc libosmocodec.pc libosmovty.pc libosmogsm.pc \
diff --git a/configure.ac b/configure.ac
index bc3358a..c011fea 100644
--- a/configure.ac
+++ b/configure.ac
@@ -77,6 +77,21 @@
 AC_PATH_PROG(DOXYGEN,doxygen,false)
 AM_CONDITIONAL(HAVE_DOXYGEN, test $DOXYGEN != false && test "x$doxygen" = "xyes")
 
+AC_ARG_ENABLE([man-doc],
+	      AS_HELP_STRING([--disable-man-doc], [Disable man page documentation]),
+	      AS_IF([test "x$enable_man_doc" = "xno"], [enable_man_doc=no],
+		    [enable_man_doc=yes]), [enable_man_doc=yes])
+AM_CONDITIONAL([BUILD_MAN], [test "x$enable_man_doc" == "xyes"])
+
+AC_CHECK_PROG(A2X, [a2x], [a2x])
+AM_CONDITIONAL([BUILD_MAN], [test -n "$A2X"])
+
+AS_IF([test "$need_a2x" = "yes"], [
+      AC_CHECK_PROG(A2X, [a2x], [found], [no])
+      AS_IF([test "$A2X" != "found"],
+	    [AC_MSG_ERROR([a2x not found, please install asciidoc])])
+])
+
 # check for syscal fallback on glibc < 2.25 - can be removed once glibc version requirement is bumped
 AC_CHECK_DECLS([SYS_getrandom], [], [], [[#include <sys/syscall.h>]])
 
@@ -370,6 +385,7 @@
 	libosmoctrl.pc
 	libosmosim.pc
 	include/Makefile
+	man/Makefile
 	src/Makefile
 	src/vty/Makefile
 	src/codec/Makefile
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..043c965
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,15 @@
+if BUILD_MAN
+man_MANS =  osmo-config-merge.8
+endif
+
+A2X_OPTS_MANPAGE = --doctype manpage --format manpage -D ${builddir}
+
+ASCIIDOCS = osmo-config-merge.txt
+
+osmo-config-merge.8 : ${ASCIIDOCS}
+		${A2X} ${A2X_OPTS_MANPAGE} osmo-config-merge.txt
+
+EXTRA_DIST = ${ASCIIDOCS}
+
+CLEANFILES = \
+	     osmo-config-merge.8
diff --git a/man/osmo-config-merge.txt b/man/osmo-config-merge.txt
new file mode 100644
index 0000000..45c765b
--- /dev/null
+++ b/man/osmo-config-merge.txt
@@ -0,0 +1,62 @@
+osmo-config-merge(8)
+=====================
+
+NAME
+----
+osmo-config-merge - Merge osmocom config snippets into an existing config
+
+SYNOPSIS
+--------
+[verse]
+*osmo-config-merge* <config-file> <config-patch> [--debug]
+
+DESCRIPTION
+-----------
+This utility allows you to merge an incremental config "patch"
+into an osmocom-style config file.
+
+The patch file follows the same syntax as the original config file.
+
+It works by appending the leaf nodes of the patch file to the respective
+nodes of the input config file.
+
+This process allows configuration file changes/updates to be performed
+in a more stable/reliable way than by means of (unified) diff files,
+as they break every time the context lines break.
+
+osmo-config-merge doesn't suffer from this problem, as it understands
+the tree-like nature of VTY config files.
+
+The resulting config is printed to stdout.
+
+NOTE: This only works with configuration files that have proper
+indenting, i.e. every level in the hierarchy must be indented excatly
+one character, not multiple.
+
+OPTIONS
+-------
+*--debug*::
+	Show debugging output when parsing the config tree. Needs to be the last argument.
+
+EXAMPLE USAGE
+-------------
+[verse]
+$ osmo-config-merge osmo-msc.cfg.base osmo-msc_change_network.cfg > osmo-msc.cfg
+
+EXIT STATUS
+-----------
+Exit status is 0 if the command was successful, and 1 in case of a
+wrong/missing argument. If the tool detects an error in the patch file the
+exit status is 2.
+
+SEE ALSO
+--------
+[verse]
+The official Osmocom documentation including the VTY config refernce can be
+found at: http://ftp.osmocom.org/docs/latest/
+The Osmocom wiki is located at: http://projects.osmocom.org/
+
+
+AUTHOR
+------
+osmo-config-merge was written by Harald Welte

-- 
To view, visit https://gerrit.osmocom.org/11133
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ifaa5afe28779a805764caf76a89efb0a3169942e
Gerrit-Change-Number: 11133
Gerrit-PatchSet: 1
Gerrit-Owner: daniel <dwillmann at sysmocom.de>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20180927/b071522b/attachment.htm>


More information about the gerrit-log mailing list