Merge pull request #1000 from appneta/revert-991-autoopt-asciidoctor

Revert "migrate autoopts -> getopt + asciidoctor"

Author: fklassen

.codeclimate.yml

@@ -6,3 +6,6 @@ ratings:
   paths:
   - "**.c"
   - "**.h"
+
+exclude_paths:
+  - libopts/

.github/workflows/c-linter.yml

@@ -9,9 +9,9 @@ jobs:
       - uses: actions/checkout@v3
       - run: |
           echo "Build Application"
-          sudo apt-get -y install libpcap-dev
+          sudo apt-get -y install libpcap-dev autogen
           ./autogen.sh
-          ./configure
+          ./configure --disable-local-libopts
       - uses: cpp-linter/cpp-linter-action@v2
         id: linter
         env:

.github/workflows/codeql.yml

@@ -59,9 +59,9 @@ jobs:
 
     - run: |
        echo "Build Application"
-       sudo apt-get -y install libpcap-dev
+       sudo apt-get -y install libpcap-dev autogen
        ./autogen.sh
-       ./configure
+       ./configure --disable-local-libopts
        make
 
     - name: Perform CodeQL Analysis

.github/workflows/github-actions-ci.yml

@@ -12,13 +12,13 @@ jobs:
         uses: actions/checkout@v3
       - run: echo "The ${{ github.repository }} repository has been cloned to the runner."
       - name: Install prereqs
-        run: sudo apt -y install libpcap-dev automake autoconf libtool libxdp-dev asciidoctor
+        run: sudo apt -y install autogen libpcap-dev automake autoconf libtool libxdp-dev
       - name: Create a build directory
         run: mkdir -p build
       - name: Create configure script
         run: pushd build; ../autogen.sh; popd
       - name: configure
-        run: pushd build; ../configure --enable-debug --enable-test-hexdump; popd
+        run: pushd build; ../configure --disable-local-libopts --enable-debug --enable-test-hexdump; popd
       - name: make
         run: pushd build; make; popd
       - name: make dist

.travis.yml

@@ -16,20 +16,22 @@ matrix:
         apt:
           packages:
           - libpcap-dev
+          - autogen
     - os: linuxal
       env: CI_BUILD_PREFIX=scan-build-11
       addons:
         apt:
           packages:
           - libpcap-dev
+          - autogen
           - clang-tools-11
 
 before_script:
 - git pull --tags
 
 script:
   - autoreconf -iv > build.log 2>&1 || (cat build.log && exit 1)
-  - ${CI_BUILD_PREFIX} ./configure --enable-asan --with-testnic=$(ip l | grep ens | cut -d':' -f2 | xargs) > build.log 2>&1 || (cat build.log && exit 1)
+  - ${CI_BUILD_PREFIX} ./configure --disable-local-libopts --enable-asan --with-testnic=$(ip l | grep ens | cut -d':' -f2 | xargs) > build.log 2>&1 || (cat build.log && exit 1)
   - ${CI_BUILD_PREFIX} make > build.log 2>&1 || (cat build.log && exit 1)
   - make dist > build.log 2>&1 || (cat build.log && exit 1)
   - sudo make test || (cat test/test.log && exit 1)

Makefile.am

@@ -1,24 +1,18 @@
 # $Id$
-ACLOCAL_AMFLAGS = -I m4
+ACLOCAL_AMFLAGS = -I m4 -I libopts/m4
 
+if NEED_LIBOPTS
+SUBDIRS = scripts lib $(LIBOPTS_DIR) src
+else
 SUBDIRS = scripts lib src
+endif
 
-DIST_SUBDIRS = scripts lib src docs test
+DIST_SUBDIRS = scripts lib libopts src docs test
 .PHONY: manpages docs test man2html
 
 
-# Only (re)generate the man pages during `make dist` when asciidoctor is
-# available.  Without it there is no rule to build them, and any pre-built
-# *.1 pages (e.g. from a release tarball) are already distributed via the
-# BUILD_MANPAGES blocks in src/Makefile.am, so invoking the manpages target
-# here would only emit a spurious "asciidoctor required" warning.
-if HAVE_ASCIIDOCTOR
 dist-hook: version manpages
 	rm $(distdir)/src/defines.h
-else
-dist-hook: version
-	rm $(distdir)/src/defines.h
-endif
 
 DOCS_DIR = $(top_builddir)/docs
 
@@ -37,6 +31,9 @@ postweb: docs doxygen
 
 TEST_DIR = $(top_builddir)/test
 
+autoopts:
+	cd src && make autoopts
+
 test:
 	echo Making test in $(TEST_DIR)
 	cd $(TEST_DIR) && make test

autogen.sh

@@ -6,7 +6,7 @@ cd $(dirname $0)
 
 rm -f config/config.guess config/config.sub config/ltmain.sh 2>/dev/null
 rm -f aclocal.m4 2>/dev/null
-aclocal
+aclocal  -I libopts/m4/
 if test -x "$(which glibtoolize)" ; then
     # Necessary under OS X
     glibtoolize --copy --automake --force

configure.ac

@@ -11,6 +11,11 @@ AC_CONFIG_AUX_DIR(config)
 AM_MAINTAINER_MODE([enable])
 AM_WITH_DMALLOC
 
+dnl People building from GitHub need the same version of Autogen as I'm using
+dnl or specify --disable-local-libopts to force using the locally-installed
+dnl copy of libopts rather than the source in the `./libopts/` directory.
+MAINTAINER_AUTOGEN_VERSION=5.18.16
+
 AC_CONFIG_MACRO_DIR([m4])
 
 TCPREPLAY_VERSION=$PACKAGE_VERSION
@@ -176,20 +181,70 @@ AC_EXEEXT
 AC_PATH_PROG(PRINTF, printf)
 AC_PATH_PROG(ECHO, echo)
 AC_PATH_PROG(CUT, cut)
-AC_PATH_PROG(ASCIIDOCTOR, asciidoctor)
-
-dnl asciidoctor is used to render hand-written man pages (replacing AutoGen
-dnl for tools that have been migrated away from AutoOpts). The generated man
-dnl page is shipped in release tarballs, so asciidoctor is only required when
-dnl (re)building the man page from its .adoc source.
-AM_CONDITIONAL([HAVE_ASCIIDOCTOR], [test -n "$ASCIIDOCTOR"])
-
-AM_CONDITIONAL([BUILD_MANPAGES],
-    [test -n "$ASCIIDOCTOR" || test -f "$srcdir/src/tcpreplay.1"])
+AC_PATH_PROG(AUTOGEN, autogen)
+AC_PATH_PROG(GROFF, groff)
 AC_PATH_PROG(depmod, depmod, /sbin/depmod, $PATH:/sbin)
 AC_PATH_PROG(insmod, insmod, /sbin/insmod, $PATH:/sbin)
 AC_PATH_PROG(rmmod, rmmod, /sbin/rmmod, $PATH:/sbin)
 
+
+dnl tcpreplay has (so far) been relying on leading-edge autogen.
+dnl Therefore, by default:
+dnl - use the version we ship with
+dnl - do not install it
+dnl - build a static copy (AC_DISABLE_SHARED - implicitly done earlier)
+case "${enable_local_libopts+set}" in
+ set) ;;
+ *) enable_local_libopts=yes ;;
+esac
+
+case "${enable_libopts_install+set}" in
+ set) ;;
+ *) enable_libopts_install=no ;;
+esac
+
+dnl check autogen version
+AUTOGEN_VERSION="unknown - man pages will not be built"
+if test -n "${AUTOGEN}" ; then
+    AC_MSG_CHECKING(for autogen version >= ${MAINTAINER_AUTOGEN_VERSION})
+    AUTOGEN_VERSION=$(${AUTOGEN} -v | ${CUT} -d' ' -f 4)
+    AUTOGEN_MAJOR=$(echo ${AUTOGEN_VERSION} | ${CUT} -d '.' -f 1)
+    AUTOGEN_MINOR=$(echo ${AUTOGEN_VERSION} | ${CUT} -d '.' -f 2)
+    AUTOGEN_BUILD=$(echo ${AUTOGEN_VERSION} | ${CUT} -d '.' -f 3)
+    if test -z "$AUTOGEN_BUILD"; then
+        AUTOGEN_BUILD=0
+    fi
+    if (test ${AUTOGEN_MAJOR} -eq 5 && test ${AUTOGEN_MINOR} -eq 18 && test ${AUTOGEN_BUILD} -lt 4) ||
+            (test ${AUTOGEN_MAJOR} -eq 5 && test ${AUTOGEN_MINOR} -lt 18) ||
+            test ${AUTOGEN_MAJOR} -lt 5 ; then
+        AC_MSG_RESULT(no)
+        if test ! "x$enable_local_libopts" = "xyes"; then
+            AC_MSG_ERROR([${AUTOGEN} is too old (${AUTOGEN_VERSION}) for building from source code. Upgrade to 5.18.4 or higher])
+        fi
+        AUTOGEN_VERSION="${AUTOGEN_VERSION} - downlevel"
+    else
+        AC_MSG_RESULT(yes)
+    fi
+
+    dnl Compare the installed version with the maintainer version if building from GitHub and not using system libopts
+    if test ! -f src/tcpreplay_opts.c && test "x$enable_local_libopts" = "xyes" ; then
+        if test $MAINTAINER_AUTOGEN_VERSION != $AUTOGEN_VERSION ; then
+            AC_MSG_ERROR([Your version of autogen ($AUTOGEN_VERSION) != libopts tear off ($MAINTAINER_AUTOGEN_VERSION)  Either install the correct version or specify --disable-local-libopts])
+        fi
+    fi
+else
+    if test ! -f src/tcpreplay_opts.c ; then
+        AC_MSG_ERROR([Please install GNU autogen $MAINTAINER_AUTOGEN_VERSION or higher if you are building from GitHub. To avoid this message download source from https://github.com/appneta/tcpreplay/releases/latest])
+    fi
+fi
+AC_DEFINE([AUTOGEN_VERSION], [${AUTOGEN_VERSION}], [What version of autogen is installed on this system])
+
+if test "x$enable_local_libopts" = "xyes" ; then
+    AC_MSG_NOTICE([Using included libopts tearoff])
+else
+    AC_MSG_NOTICE([Using system libopts])
+fi
+
 AC_PROG_EGREP
 AC_HEADER_MAJOR
 
@@ -224,7 +279,6 @@ AC_CHECK_TYPE(u_short, uint16_t)
 AC_CHECK_TYPE(u_int, uint32_t)
 AC_CHECK_TYPE(u_int32_t, uint32_t)
 AC_CHECK_TYPE(u_int64_t, uint64_t)
-AC_CHECK_SIZEOF([long])
 
 # required by C23 standard
 CFLAGS="-D_DEFAULT_SOURCE $CFLAGS"
@@ -1961,6 +2015,9 @@ else
     AC_MSG_RESULT(no)
 fi
 
+LIBOPTS_CHECK(libopts)
+
+
 AC_CONFIG_FILES([Makefile
            doxygen.cfg
            lib/Makefile
@@ -1984,6 +2041,8 @@ AC_MSG_RESULT([
 libpcap:                    ${foundpcap} (${libpcap_version})
 PF_RING libpcap             ${pf_ring_found}   ${pf_ring_lib}
 libdnet:                    ${founddnet}   ${libdnet_version}
+autogen:                    ${AUTOGEN} (${AUTOGEN_VERSION})
+Use libopts tearoff:        ${enable_local_libopts}
 64bit counter support:      ${use64bit_counters}
 tcpdump binary path:        ${tcpdump_path}
 fragroute support:          ${enable_fragroute}

docs/HACKING

@@ -29,6 +29,7 @@ The file layout is pretty simple:
 
 /                    - Base directory
 /lib                 - 3rd party libraries stolen verbatim
+/libopts             - GNU AutoOpts tearoff
 /src                 - Main code routines
 /src/common          - Common routines for all binaries
 /src/tcpedit         - libtcpedit

docs/Makefile.am

@@ -4,26 +4,26 @@ MAKEFLAGS=-s
 
 docs: clean-docs manpages
 
-web/tcpreplay.html: $(srcdir)/tcpreplay.1.adoc
-	mkdir -p web; @ASCIIDOCTOR@ --backend html5 --out-file web/tcpreplay.html $(srcdir)/tcpreplay.1.adoc
+web/tcpreplay.html:
+	mkdir -p web; @GROFF@ -Thtml -mman ../src/tcpreplay.1 > web/tcpreplay.html
 
-web/tcpprep.html: $(srcdir)/tcpprep.1.adoc
-	mkdir -p web; @ASCIIDOCTOR@ --backend html5 --out-file web/tcpprep.html $(srcdir)/tcpprep.1.adoc
+web/tcpprep.html:
+	@GROFF@ -Thtml -mman ../src/tcpprep.1 > web/tcpprep.html
 
-web/tcprewrite.html: $(srcdir)/tcprewrite.1.adoc $(srcdir)/tcpedit_options.adoc
-	mkdir -p web; @ASCIIDOCTOR@ --backend html5 --out-file web/tcprewrite.html $(srcdir)/tcprewrite.1.adoc
+web/tcprewrite.html:
+	@GROFF@ -Thtml -mman ../src/tcprewrite.1 > web/tcprewrite.html
 
-web/tcpbridge.html: $(srcdir)/tcpbridge.1.adoc $(srcdir)/tcpedit_options.adoc
-	mkdir -p web; @ASCIIDOCTOR@ --backend html5 --out-file web/tcpbridge.html $(srcdir)/tcpbridge.1.adoc
+web/tcpbridge.html:
+	@GROFF@ -Thtml -mman ../src/tcpbridge.1 > web/tcpbridge.html
 
-web/tcpreplay-edit.html: $(srcdir)/tcpreplay-edit.1.adoc $(srcdir)/tcpedit_options.adoc
-	mkdir -p web; @ASCIIDOCTOR@ --backend html5 --out-file web/tcpreplay-edit.html $(srcdir)/tcpreplay-edit.1.adoc
+web/tcpreplay-edit.html:
+	@GROFF@ -Thtml -mman ../src/tcpreplay-edit.1 > web/tcpreplay-edit.html
 
-web/tcpliveplay.html: $(srcdir)/tcpliveplay.1.adoc
-	mkdir -p web; @ASCIIDOCTOR@ --backend html5 --out-file web/tcpliveplay.html $(srcdir)/tcpliveplay.1.adoc
+web/tcpliveplay.html:
+	@GROFF@ -Thtml -mman ../src/tcpliveplay.1 > web/tcpliveplay.html
 
-web/tcpcapinfo.html: $(srcdir)/tcpcapinfo.1.adoc
-	mkdir -p web; @ASCIIDOCTOR@ --backend html5 --out-file web/tcpcapinfo.html $(srcdir)/tcpcapinfo.1.adoc
+web/tcpcapinfo.html:
+	@GROFF@ -Thtml -mman ../src/tcpcapinfo.1 > web/tcpcapinfo.html
 
 manpages: web/tcpreplay.html web/tcpprep.html web/tcprewrite.html \
     web/tcpbridge.html web/tcpreplay-edit.html web/tcpliveplay.html \
@@ -36,10 +36,7 @@ postweb: manpages
 	scp CHANGELOG TODO aturner@malbec.synfin.net:/var/vhosts/tcpreplay/
 
 
-EXTRA_DIST = CHANGELOG CREDIT HACKING INSTALL LICENSE Win32Readme.txt \
-    tcpcapinfo.1.adoc tcpliveplay.1.adoc tcpprep.1.adoc \
-    tcprewrite.1.adoc tcpbridge.1.adoc tcpedit_options.adoc \
-    tcpreplay.1.adoc tcpreplay-edit.1.adoc tcpreplay_options.adoc
+EXTRA_DIST = CHANGELOG CREDIT HACKING INSTALL LICENSE Win32Readme.txt
 
 clean-docs: clean
 	-rm -f web/*.html