modernise build infrastructure to current state libvmod-example

Makefile.am

-ACLOCAL_AMFLAGS = -I m4
+ACLOCAL_AMFLAGS = -I m4 -I ${LIBVARNISHAPI_DATAROOTDIR}/aclocal
 
 SUBDIRS = src
 
-EXTRA_DIST = README.rst
+DISTCHECK_CONFIGURE_FLAGS = \
+	VMOD_DIR='$${libdir}/varnish/vmods'
+
+EXTRA_DIST = README.rst LICENSE vmod-example.spec debian
+
+doc_DATA = README.rst LICENSE
 
 dist_man_MANS = vmod_vslp.3
 MAINTAINERCLEANFILES = $(dist_man_MANS)
 
 vmod_vslp.3: README.rst
+
+%.1 %.2 %.3 %.4 %.5 %.6 %.7 %.8 %.9:
 if HAVE_RST2MAN
-	${RST2MAN} README.rst $@
+	${RST2MAN} $< $@
 else
 	@echo "========================================"
 	@echo "You need rst2man installed to make dist"

README.rst

@@ -180,24 +180,30 @@ INSTALLATION
 
 The source tree is based on autotools to configure the building, and
 does also have the necessary bits in place to do functional unit tests
-using the varnishtest tool.
+using the ``varnishtest`` tool.
+
+Building requires the Varnish header files and uses pkg-config to find
+the necessary paths.
 
 Usage::
 
- ./configure VARNISHSRC=DIR [VMODDIR=DIR]
+ ./autogen.sh
+ ./configure
 
-`VARNISHSRC` is the directory of the Varnish source tree for which to
-compile your vmod.
+If you have installed Varnish to a non-standard directory, call
+``autogen.sh`` and ``configure`` with ``PKG_CONFIG_PATH`` pointing to
+the appropriate path. For example, when varnishd configure was called
+with ``--prefix=$PREFIX``, use
 
-Optionally you can also set the vmod install directory by adding
-`VMODDIR=DIR` (defaults to the pkg-config discovered directory from your
-Varnish installation).
+ PKG_CONFIG_PATH=${PREFIX}/lib/pkgconfig
+ export PKG_CONFIG_PATH
 
 Make targets:
 
-* make - builds the vmod
-* make install - installs your vmod in `VMODDIR`
+* make - builds the vmod.
+* make install - installs your vmod.
 * make check - runs the unit tests in ``src/tests/*.vtc``
+* make distcheck - run check and prepare a tarball of the vmod.
 
 
 MISSING
@@ -212,7 +218,8 @@ Version 1.0: Initial version.
 ACKNOWLEDGEMENTS
 ================
 
-Development of this module was partially sponsored by Deutsche Telekom AG – Products & Innovation
+Development of this module was partly sponsored by Deutsche Telekom AG
+– Products & Innovation
 
 
 COPYRIGHT
@@ -221,5 +228,5 @@ COPYRIGHT
 This document is licensed under the same license as the
 libvmod-vslp project. See LICENSE for details.
 
-Copyright (c) 2013 UPLEX Nils Goroll Systemoptimierung. All rights
+Copyright (c) 2013-2015 UPLEX Nils Goroll Systemoptimierung. All rights
 reserved.

autogen.sh

 #!/bin/sh
-#
-# $Id$
-#
 
 warn() {
 	echo "WARNING: $@" 1>&2
@@ -9,38 +6,47 @@ warn() {
 
 case `uname -s` in
 Darwin)
-    LIBTOOLIZE=glibtoolize
-    ;;
+	LIBTOOLIZE=glibtoolize
+	;;
 FreeBSD)
-    LIBTOOLIZE=libtoolize
-    ;;
+	LIBTOOLIZE=libtoolize
+	;;
 Linux)
-    LIBTOOLIZE=libtoolize
-    ;;
+	LIBTOOLIZE=libtoolize
+	;;
 SunOS)
-    LIBTOOLIZE=libtoolize
-    ;;
+	LIBTOOLIZE=libtoolize
+	;;
 *)
-    warn "unrecognized platform:" `uname -s`
-    LIBTOOLIZE=libtoolize
+	warn "unrecognized platform:" `uname -s`
+	LIBTOOLIZE=libtoolize
 esac
 
 automake_version=`automake --version | tr ' ' '\n' | egrep '^[0-9]\.[0-9a-z.-]+'`
 if [ -z "$automake_version" ] ; then
-    warn "unable to determine automake version"
+	warn "unable to determine automake version"
 else
-    case $automake_version in
-	0.*|1.[0-8]|1.[0-8][.-]*)
-	    warn "automake ($automake_version) detected; 1.9 or newer recommended"
-	    ;;
-	*)
-	    ;;
-    esac
+	case $automake_version in
+		0.*|1.[0-8]|1.[0-8][.-]*)
+			warn "automake ($automake_version) detected; 1.9 or newer recommended"
+			;;
+		*)
+			;;
+	esac
 fi
 
+# check for varnishapi.m4 in custom paths
+dataroot=$(pkg-config --variable=datarootdir varnishapi 2>/dev/null)
+if [ -z "$dataroot" ] ; then
+	cat >&2 <<'EOF'
+Package varnishapi was not found in the pkg-config search path.
+Perhaps you should add the directory containing `varnishapi.pc'
+to the PKG_CONFIG_PATH environment variable
+EOF
+	exit 1
+fi
 set -ex
-
-aclocal
+aclocal -I m4 -I ${dataroot}/aclocal
 $LIBTOOLIZE --copy --force
 autoheader
 automake --add-missing --copy --foreign

configure.ac

 AC_PREREQ(2.59)
-AC_COPYRIGHT([Copyright (c) 2013 UPLEX - Nils Goroll Systemoptimierung, 2011 Varnish Software AS])
+AC_COPYRIGHT([Copyright (c) 2013-2015 UPLEX - Nils Goroll Systemoptimierung])
 AC_INIT([libvmod-vslp], [master])
 AC_CONFIG_MACRO_DIR([m4])
+m4_ifndef([VARNISH_VMOD_INCLUDES], AC_MSG_ERROR([Need varnish.m4 -- see README.rst]))
 AC_CONFIG_SRCDIR(src/vmod_vslp.vcc)
 AM_CONFIG_HEADER(config.h)
 
@@ -29,41 +30,43 @@ if test "x$RST2MAN" = "xno"; then
 fi
 AM_CONDITIONAL(HAVE_RST2MAN, [test "x$RST2MAN" != "xno"])
 
-# Check for pkg-config
-PKG_PROG_PKG_CONFIG
-
 # Checks for header files.
 AC_HEADER_STDC
 AC_CHECK_HEADERS([sys/stdlib.h])
 
-# Check for python
-AC_CHECK_PROGS(PYTHON, [python3 python3.1 python3.2 python2.7 python2.6 python2.5 python2 python], [AC_MSG_ERROR([Python is needed to build this vmod, please install python.])])
-
-# Varnish source tree
-AC_ARG_VAR([VARNISHSRC], [path to Varnish source tree (mandatory)])
-if test "x$VARNISHSRC" = x; then
-	AC_MSG_ERROR([No Varnish source tree specified])
-fi
-VARNISHSRC=`cd $VARNISHSRC && pwd`
-AC_CHECK_FILE([$VARNISHSRC/include/vrt.h],
-	[],
-	[AC_MSG_FAILURE(["$VARNISHSRC" is not a Varnish source directory])]
-)
+# backwards compat with older pkg-config
+# - pull in AC_DEFUN from pkg.m4
+m4_ifndef([PKG_CHECK_VAR], [
+# PKG_CHECK_VAR(VARIABLE, MODULE, CONFIG-VARIABLE,
+# [ACTION-IF-FOUND], [ACTION-IF-NOT-FOUND])
+# -------------------------------------------
+# Retrieves the value of the pkg-config variable for the given module.
+AC_DEFUN([PKG_CHECK_VAR],
+[AC_REQUIRE([PKG_PROG_PKG_CONFIG])dnl
+AC_ARG_VAR([$1], [value of $3 for $2, overriding pkg-config])dnl
+
+_PKG_CONFIG([$1], [variable="][$3]["], [$2])
+AS_VAR_COPY([$1], [pkg_cv_][$1])
+
+AS_VAR_IF([$1], [""], [$5], [$4])dnl
+])# PKG_CHECK_VAR
+])
 
-# Check that varnishtest is built in the varnish source directory
-AC_CHECK_FILE([$VARNISHSRC/bin/varnishtest/varnishtest],
-	[],
-	[AC_MSG_FAILURE([Can't find "$VARNISHSRC/bin/varnishtest/varnishtest". Please build your varnish source directory])]
-)
-
-# vmod installation dir
-AC_ARG_VAR([VMODDIR], [vmod installation directory @<:@LIBDIR/varnish/vmods@:>@])
-if test "x$VMODDIR" = x; then
-	VMODDIR=`pkg-config --variable=vmoddir varnishapi`
-	if test "x$VMODDIR" = x; then
-		AC_MSG_FAILURE([Can't determine vmod installation directory])
-	fi
-fi
+PKG_CHECK_MODULES([libvarnishapi], [varnishapi])
+PKG_CHECK_VAR([LIBVARNISHAPI_DATAROOTDIR], [varnishapi], [datarootdir])
+PKG_CHECK_VAR([LIBVARNISHAPI_BINDIR], [varnishapi], [bindir])
+PKG_CHECK_VAR([LIBVARNISHAPI_SBINDIR], [varnishapi], [sbindir])
+AC_SUBST([LIBVARNISHAPI_DATAROOTDIR])
+
+# Varnish include files tree
+VARNISH_VMOD_INCLUDES
+VARNISH_VMOD_DIR
+VARNISH_VMODTOOL
+
+AC_PATH_PROG([VARNISHTEST], [varnishtest], [],
+    [$LIBVARNISHAPI_BINDIR:$LIBVARNISHAPI_SBINDIR:$PATH])
+AC_PATH_PROG([VARNISHD], [varnishd], [],
+    [$LIBVARNISHAPI_SBINDIR:$LIBVARNISHAPI_BINDIR:$PATH])
 
 # This corresponds to FreeBSD's WARNS level 6
 DEVELOPER_CFLAGS="-Wall -Wstrict-prototypes -Wmissing-prototypes -Wpointer-arith -Wreturn-type -Wcast-qual -Wwrite-strings -Wswitch -Wshadow -Wcast-align -Wunused-parameter -Wchar-subscripts -Winline -Wnested-externs -Wredundant-decls -Wformat"

src/Makefile.am

+AM_CPPFLAGS = @VMOD_INCLUDES@ -Wall -Werror
+#	-I$(VARNISHSRC)/include \
+#	-I$(VARNISHSRC)/bin/varnishd \
+#	-I$(VARNISHSRC)/lib/libvgz
 
-AM_CPPFLAGS = \
-	-I$(VARNISHSRC)/include \
-	-I$(VARNISHSRC)/bin/varnishd \
-	-I$(VARNISHSRC)/lib/libvgz
-
-AM_LDFLAGS  = $(AM_LT_LDFLAGS)
-
-vmoddir = $(VMODDIR)
+vmoddir = @VMOD_DIR@
 vmod_LTLIBRARIES = libvmod_vslp.la
-vmod_srcdir = $(top_srcdir)/src
-vmodtool = $(VARNISHSRC)/lib/libvcc/vmodtool.py
 
-libvmod_vslp_la_LDFLAGS = $(AM_LDFLAGS) -module -export-dynamic -avoid-version -shared
+libvmod_vslp_la_LDFLAGS = -module -export-dynamic -avoid-version -shared
 
 libvmod_vslp_la_SOURCES = \
 	vmod_vslp.c \
@@ -22,24 +17,27 @@ nodist_libvmod_vslp_la_SOURCES = \
 	vcc_if.c \
 	vcc_if.h
 
-# BUILT_SOURCES is only a hack and dependency tracking does not help for the first build
-vmod_vslp.lo: vcc_if.h
+vmod_vslp.lo: vcc_if.c vcc_if.h
 
-vcc_if.c vcc_if.h: $(vmodtool) $(vmod_srcdir)/vmod_vslp.vcc
-	@PYTHON@ $(vmodtool) $(vmod_srcdir)/vmod_vslp.vcc
+vcc_if.c: vcc_if.h
 
-VMOD_TESTS = tests/*.vtc
+vcc_if.h: @VMODTOOL@ $(top_srcdir)/src/vmod_vslp.vcc
+	@VMODTOOL@ $(top_srcdir)/src/vmod_vslp.vcc
 
+VMOD_TESTS = $(top_srcdir)/src/tests/*.vtc
+.PHONY: $(VMOD_TESTS)
 
-check: $(VARNISHSRC)/bin/varnishtest/varnishtest
-	$(VARNISHSRC)/bin/varnishtest/varnishtest \
-		-Dvarnishd=$(VARNISHSRC)/bin/varnishd/varnishd \
-		-Dvmod_topbuild=$(abs_top_builddir) \
-		tests/*.vtc
+$(top_srcdir)/src/tests/*.vtc: libvmod_vslp.la
+	@VARNISHTEST@ -Dvarnishd=@VARNISHD@ -Dvmod_topbuild=$(abs_top_builddir) $@
+
+check: $(VMOD_TESTS)
 
 EXTRA_DIST = \
 	vmod_vslp.vcc	\
 	$(VMOD_TESTS)
 
-CLEANFILES = $(builddir)/vcc_if.c $(builddir)/vcc_if.h
-
+CLEANFILES = \
+	$(builddir)/vcc_if.c \
+	$(builddir)/vcc_if.h \
+	$(builddir)/vmod_vslp.rst \
+	$(builddir)/vmod_vslp.man.rst