Merge pull request #15 from nigoroll/master

Master: Fixes for #6 and #13

Makefile.am

-ACLOCAL_AMFLAGS = -I m4
+ACLOCAL_AMFLAGS = -I m4 -I ${LIBVARNISHAPI_DATAROOTDIR}/aclocal
 
 SUBDIRS = src
 

README.rst

@@ -51,14 +51,18 @@ using the ``varnishtest`` tool.
 Building requires the Varnish header files and uses pkg-config to find
 the necessary paths.
 
-If you have installed Varnish to a non-standard directory, you may need to
-override PKG_CONFIG_PATH so configure can find varnishapi.pc.
-
 Usage::
 
  ./autogen.sh
  ./configure
 
+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
+
+ PKG_CONFIG_PATH=${PREFIX}/lib/pkgconfig
+ export PKG_CONFIG_PATH
 
 Make targets:
 
@@ -68,7 +72,7 @@ Make targets:
 * make distcheck - run check and prepare a tarball of the vmod.
 
 In your VCL you could then use this vmod along the following lines::
-        
+
         import example;
 
         sub vcl_deliver {
@@ -76,3 +80,10 @@ In your VCL you could then use this vmod along the following lines::
                 set resp.http.hello = example.hello("World");
         }
 
+COMMON PROBLEMS
+===============
+
+* configure: error: Need varnish.m4 -- see README.rst
+
+  Check if ``PKG_CONFIG_PATH`` has been set correctly before calling
+  ``autogen.sh`` and ``configure``

autogen.sh

@@ -37,7 +37,9 @@ fi
 
 set -ex
 
-aclocal -I m4
+# check for varnishapi.m4 in custom paths
+dataroot=$(pkg-config --variable=datarootdir varnishapi)
+aclocal -I m4 -I ${dataroot}/aclocal
 $LIBTOOLIZE --copy --force
 autoheader
 automake --add-missing --copy --foreign

configure.ac

@@ -2,6 +2,7 @@ AC_PREREQ(2.64)
 AC_COPYRIGHT([Copyright (c) 2011-2015 Varnish Software AS])
 AC_INIT([libvmod-example], [trunk])
 AC_CONFIG_MACRO_DIR([m4])
+m4_ifndef([VARNISH_VMOD_INCLUDES], AC_MSG_ERROR([Need varnish.m4 -- see README.rst]))
 AC_CONFIG_SRCDIR(src/vmod_example.vcc)
 AM_CONFIG_HEADER(config.h)
 
@@ -33,17 +34,21 @@ AM_CONDITIONAL(HAVE_RST2MAN, [test "x$RST2MAN" != "xno"])
 AC_HEADER_STDC
 AC_CHECK_HEADERS([sys/stdlib.h])
 
-
 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])
+AC_PATH_PROG([VARNISHTEST], [varnishtest], [],
+    [$LIBVARNISHAPI_BINDIR:$LIBVARNISHAPI_SBINDIR:$PATH])
 AC_PATH_PROG([VARNISHD], [varnishd], [],
-    [$PATH:$PATH:`pkg-config varnishapi --variable=sbindir`])
+    [$LIBVARNISHAPI_SBINDIR:$LIBVARNISHAPI_BINDIR:$PATH])
 
 AC_CONFIG_FILES([
 	Makefile

src/vmod_example.vcc

@@ -8,7 +8,9 @@ You can even have links and lists in here:
 * https://github.com/varnish/libvmod-example/
 * https://www.varnish-cache.org/
 
+The init-function declared next does not have documentation.
 
+$Init init_function
 $Function STRING hello(STRING)
 
 The different functions provided by the VMOD should also have their own