<p>roh has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmo-pcap/+/23691">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">add --vty-ref-* support in osmo-pcap-client and -server<br><br>Change-Id: I28353f51de798535a3bb6efdc6c2da443d96ddfb<br>---<br>M .gitignore<br>M configure.ac<br>M src/osmo_client_main.c<br>M src/osmo_server_main.c<br>4 files changed, 138 insertions(+), 14 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmo-pcap refs/changes/91/23691/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/.gitignore b/.gitignore</span><br><span>index dd48c7d..19c1a47 100644</span><br><span>--- a/.gitignore</span><br><span>+++ b/.gitignore</span><br><span>@@ -37,3 +37,16 @@</span><br><span> tests/testsuite.log</span><br><span> </span><br><span> contrib/osmo-pcap.spec</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/osmo-pcap-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 style="color: hsl(120, 100%, 40%);">+doc/manuals/vty/osmo-pcap_vty_reference.xml</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>diff --git a/configure.ac b/configure.ac</span><br><span>index 8ec9c88..90dbc3d 100644</span><br><span>--- a/configure.ac</span><br><span>+++ b/configure.ac</span><br><span>@@ -5,6 +5,46 @@</span><br><span> </span><br><span> AM_INIT_AUTOMAKE([dist-bzip2])</span><br><span> AC_CONFIG_TESTDIR(tests)</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> </span><br><span> CFLAGS="$CFLAGS -std=gnu11"</span><br><span> </span><br><span>@@ -61,6 +101,8 @@</span><br><span>   CPPFLAGS="$CPPFLAGS $WERROR_FLAGS"</span><br><span> fi</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+</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>@@ -150,5 +192,6 @@</span><br><span>     contrib/osmo-pcap.spec</span><br><span>     doc/Makefile</span><br><span>     doc/examples/Makefile</span><br><span style="color: hsl(120, 100%, 40%);">+    doc/manuals/Makefile</span><br><span>     tests/Makefile</span><br><span>     Makefile)</span><br><span>diff --git a/src/osmo_client_main.c b/src/osmo_client_main.c</span><br><span>index c7d68d4..b0727d6 100644</span><br><span>--- a/src/osmo_client_main.c</span><br><span>+++ b/src/osmo_client_main.c</span><br><span>@@ -98,20 +98,51 @@</span><br><span>    printf("  -T --timestamp. Print a timestamp in the debug output.\n");</span><br><span>      printf("  -e --log-level number. Set a global loglevel.\n");</span><br><span>       printf("  -c --config-file filename The config file to use.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+  printf("\nVTY reference generation:\n");</span><br><span style="color: hsl(120, 100%, 40%);">+    printf("     --vty-ref-mode MODE     VTY reference generation mode (e.g. 'expert').\n");</span><br><span style="color: hsl(120, 100%, 40%);">+    printf("     --vty-ref-xml           Generate the VTY reference XML output and exit.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void handle_long_options(const char *prog_name, const int long_option)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+    static int vty_ref_mode = VTY_REF_GEN_MODE_DEFAULT;</span><br><span style="color: hsl(120, 100%, 40%);">+   switch (long_option) {</span><br><span style="color: hsl(120, 100%, 40%);">+        case 1:</span><br><span style="color: hsl(120, 100%, 40%);">+               vty_ref_mode = get_string_value(vty_ref_gen_mode_names, optarg);</span><br><span style="color: hsl(120, 100%, 40%);">+              if (vty_ref_mode < 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+                    fprintf(stderr, "%s: Unknown VTY reference generation "</span><br><span style="color: hsl(120, 100%, 40%);">+                             "mode '%s'\n", prog_name, optarg);</span><br><span style="color: hsl(120, 100%, 40%);">+                  exit(2);</span><br><span style="color: hsl(120, 100%, 40%);">+              }</span><br><span style="color: hsl(120, 100%, 40%);">+             break;</span><br><span style="color: hsl(120, 100%, 40%);">+        case 2:</span><br><span style="color: hsl(120, 100%, 40%);">+               fprintf(stderr, "Generating the VTY reference in mode '%s' (%s)\n",</span><br><span style="color: hsl(120, 100%, 40%);">+                 get_value_string(vty_ref_gen_mode_names, vty_ref_mode),</span><br><span style="color: hsl(120, 100%, 40%);">+                       get_value_string(vty_ref_gen_mode_desc, vty_ref_mode));</span><br><span style="color: hsl(120, 100%, 40%);">+               vty_dump_xml_ref_mode(stdout, (enum vty_ref_gen_mode) vty_ref_mode);</span><br><span style="color: hsl(120, 100%, 40%);">+          exit(0);</span><br><span style="color: hsl(120, 100%, 40%);">+      default:</span><br><span style="color: hsl(120, 100%, 40%);">+              fprintf(stderr, "%s: error parsing cmdline options\n", prog_name);</span><br><span style="color: hsl(120, 100%, 40%);">+          exit(2);</span><br><span style="color: hsl(120, 100%, 40%);">+      }</span><br><span> }</span><br><span> </span><br><span> static void handle_options(int argc, char **argv)</span><br><span> {</span><br><span>         while (1) {</span><br><span>          int option_index = 0, c;</span><br><span style="color: hsl(120, 100%, 40%);">+              static int long_option = 0;</span><br><span>          static struct option long_options[] = {</span><br><span style="color: hsl(0, 100%, 40%);">-                 {"help", 0, 0, 'h'},</span><br><span style="color: hsl(0, 100%, 40%);">-                  {"daemonize", 0, 0, 'D'},</span><br><span style="color: hsl(0, 100%, 40%);">-                     {"debug", 1, 0, 'd'},</span><br><span style="color: hsl(0, 100%, 40%);">-                 {"disable-color", 0, 0, 's'},</span><br><span style="color: hsl(0, 100%, 40%);">-                 {"timestamp", 0, 0, 'T'},</span><br><span style="color: hsl(0, 100%, 40%);">-                     {"log-level", 1, 0, 'e'},</span><br><span style="color: hsl(0, 100%, 40%);">-                     {"config-file", 1, 0, 'c'},</span><br><span style="color: hsl(120, 100%, 40%);">+                 { "help", 0, 0, 'h'},</span><br><span style="color: hsl(120, 100%, 40%);">+                       { "daemonize", 0, 0, 'D'},</span><br><span style="color: hsl(120, 100%, 40%);">+                  { "debug", 1, 0, 'd'},</span><br><span style="color: hsl(120, 100%, 40%);">+                      { "disable-color", 0, 0, 's'},</span><br><span style="color: hsl(120, 100%, 40%);">+                      { "timestamp", 0, 0, 'T'},</span><br><span style="color: hsl(120, 100%, 40%);">+                  { "log-level", 1, 0, 'e'},</span><br><span style="color: hsl(120, 100%, 40%);">+                  { "config-file", 1, 0, 'c'},</span><br><span style="color: hsl(120, 100%, 40%);">+                        { "vty-ref-mode", 1, &long_option, 1},</span><br><span style="color: hsl(120, 100%, 40%);">+                  { "vty-ref-xml", 0, &long_option, 2},</span><br><span>                  {0, 0, 0, 0}</span><br><span>                 };</span><br><span> </span><br><span>@@ -125,6 +156,9 @@</span><br><span>                         print_usage();</span><br><span>                       print_help();</span><br><span>                        exit(0);</span><br><span style="color: hsl(120, 100%, 40%);">+              case 0:</span><br><span style="color: hsl(120, 100%, 40%);">+                       handle_long_options(argv[0], long_option);</span><br><span style="color: hsl(120, 100%, 40%);">+                    break;</span><br><span>               case 'D':</span><br><span>                    daemonize = 1;</span><br><span>                       break;</span><br><span>diff --git a/src/osmo_server_main.c b/src/osmo_server_main.c</span><br><span>index 51441a7..ad6260c 100644</span><br><span>--- a/src/osmo_server_main.c</span><br><span>+++ b/src/osmo_server_main.c</span><br><span>@@ -108,20 +108,51 @@</span><br><span>  printf("  -T --timestamp. Print a timestamp in the debug output.\n");</span><br><span>      printf("  -e --log-level number. Set a global loglevel.\n");</span><br><span>       printf("  -c --config-file filename The config file to use.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+  printf("\nVTY reference generation:\n");</span><br><span style="color: hsl(120, 100%, 40%);">+    printf("     --vty-ref-mode MODE     VTY reference generation mode (e.g. 'expert').\n");</span><br><span style="color: hsl(120, 100%, 40%);">+    printf("     --vty-ref-xml           Generate the VTY reference XML output and exit.\n");</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void handle_long_options(const char *prog_name, const int long_option)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+    static int vty_ref_mode = VTY_REF_GEN_MODE_DEFAULT;</span><br><span style="color: hsl(120, 100%, 40%);">+   switch (long_option) {</span><br><span style="color: hsl(120, 100%, 40%);">+        case 1:</span><br><span style="color: hsl(120, 100%, 40%);">+               vty_ref_mode = get_string_value(vty_ref_gen_mode_names, optarg);</span><br><span style="color: hsl(120, 100%, 40%);">+              if (vty_ref_mode < 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+                    fprintf(stderr, "%s: Unknown VTY reference generation "</span><br><span style="color: hsl(120, 100%, 40%);">+                             "mode '%s'\n", prog_name, optarg);</span><br><span style="color: hsl(120, 100%, 40%);">+                  exit(2);</span><br><span style="color: hsl(120, 100%, 40%);">+              }</span><br><span style="color: hsl(120, 100%, 40%);">+             break;</span><br><span style="color: hsl(120, 100%, 40%);">+        case 2:</span><br><span style="color: hsl(120, 100%, 40%);">+               fprintf(stderr, "Generating the VTY reference in mode '%s' (%s)\n",</span><br><span style="color: hsl(120, 100%, 40%);">+                 get_value_string(vty_ref_gen_mode_names, vty_ref_mode),</span><br><span style="color: hsl(120, 100%, 40%);">+                       get_value_string(vty_ref_gen_mode_desc, vty_ref_mode));</span><br><span style="color: hsl(120, 100%, 40%);">+               vty_dump_xml_ref_mode(stdout, (enum vty_ref_gen_mode) vty_ref_mode);</span><br><span style="color: hsl(120, 100%, 40%);">+          exit(0);</span><br><span style="color: hsl(120, 100%, 40%);">+      default:</span><br><span style="color: hsl(120, 100%, 40%);">+              fprintf(stderr, "%s: error parsing cmdline options\n", prog_name);</span><br><span style="color: hsl(120, 100%, 40%);">+          exit(2);</span><br><span style="color: hsl(120, 100%, 40%);">+      }</span><br><span> }</span><br><span> </span><br><span> static void handle_options(int argc, char **argv)</span><br><span> {</span><br><span>         while (1) {</span><br><span>          int option_index = 0, c;</span><br><span style="color: hsl(120, 100%, 40%);">+              static int long_option = 0;</span><br><span>          static struct option long_options[] = {</span><br><span style="color: hsl(0, 100%, 40%);">-                 {"help", 0, 0, 'h'},</span><br><span style="color: hsl(0, 100%, 40%);">-                  {"daemonize", 0, 0, 'D'},</span><br><span style="color: hsl(0, 100%, 40%);">-                     {"debug", 1, 0, 'd'},</span><br><span style="color: hsl(0, 100%, 40%);">-                 {"disable-color", 0, 0, 's'},</span><br><span style="color: hsl(0, 100%, 40%);">-                 {"timestamp", 0, 0, 'T'},</span><br><span style="color: hsl(0, 100%, 40%);">-                     {"log-level", 1, 0, 'e'},</span><br><span style="color: hsl(0, 100%, 40%);">-                     {"config-file", 1, 0, 'c'},</span><br><span style="color: hsl(120, 100%, 40%);">+                 { "help", 0, 0, 'h'},</span><br><span style="color: hsl(120, 100%, 40%);">+                       { "daemonize", 0, 0, 'D'},</span><br><span style="color: hsl(120, 100%, 40%);">+                  { "debug", 1, 0, 'd'},</span><br><span style="color: hsl(120, 100%, 40%);">+                      { "disable-color", 0, 0, 's'},</span><br><span style="color: hsl(120, 100%, 40%);">+                      { "timestamp", 0, 0, 'T'},</span><br><span style="color: hsl(120, 100%, 40%);">+                  { "log-level", 1, 0, 'e'},</span><br><span style="color: hsl(120, 100%, 40%);">+                  { "config-file", 1, 0, 'c'},</span><br><span style="color: hsl(120, 100%, 40%);">+                        { "vty-ref-mode", 1, &long_option, 1},</span><br><span style="color: hsl(120, 100%, 40%);">+                  { "vty-ref-xml", 0, &long_option, 2},</span><br><span>                  {0, 0, 0, 0}</span><br><span>                 };</span><br><span> </span><br><span>@@ -135,6 +166,9 @@</span><br><span>                         print_usage();</span><br><span>                       print_help();</span><br><span>                        exit(0);</span><br><span style="color: hsl(120, 100%, 40%);">+              case 0:</span><br><span style="color: hsl(120, 100%, 40%);">+                       handle_long_options(argv[0], long_option);</span><br><span style="color: hsl(120, 100%, 40%);">+                    break;</span><br><span>               case 'D':</span><br><span>                    daemonize = 1;</span><br><span>                       break;</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-pcap/+/23691">change 23691</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/c/osmo-pcap/+/23691"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-pcap </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I28353f51de798535a3bb6efdc6c2da443d96ddfb </div>
<div style="display:none"> Gerrit-Change-Number: 23691 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: roh <jsteiger@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>