Commit 204a7e9f by Geoff Simmons

Update INSTALL.rst.

Mention autoconf-archive and C++ build requirements and setting
ACLOCAL_PATH.

Closes #2
parent bfe8b6ca
Pipeline #330 skipped
......@@ -12,23 +12,40 @@ resources for both Varnish and RE2. This sequence will install the VMOD::
> make distcheck # run check and prepare a distribution tarball
> sudo make install
See `CONTRIBUTING.rst <CONTRIBUTING.rst>`_ for notes about building
from source.
The ``autogen.sh`` and ``configure`` steps require m4 sources from the
Varnish installation and from the autoconf archive. If you encounter
errors in those steps (such as ``Need varnish.m4 -- see
INSTALL.rst``):
If you have installed Varnish and/or RE2 in non-standard directories,
call ``autogen.sh`` and ``configure`` with the ``PKG_CONFIG_PATH``
environment variable set to include the paths where the ``.pc`` files
can be located for ``varnishapi`` and ``re2``. For example, when
varnishd configure was called with ``--prefix=$PREFIX``, use::
* Make sure that you have a Varnish installation on the same host, and
that its ``$PREFIX/share/aclocal`` directory can be found by
``aclocal(1)``. If necessary, set the ``ACLOCAL_PATH`` environment
variable to include that path.
* If you have installed Varnish and/or RE2 in non-standard
directories, call ``autogen.sh`` and ``configure`` with the
``PKG_CONFIG_PATH`` environment variable set to include the paths
where the ``.pc`` files can be located for ``varnishapi`` and
``re2``. For example, when varnishd configure was called with
``--prefix=$PREFIX``, use::
> PKG_CONFIG_PATH=${PREFIX}/lib/pkgconfig
> export PKG_CONFIG_PATH
* Make sure that you have the autoconf archive installed (available as
the package ``autoconf-archive`` on most distributions).
The VMOD source code is in C and C++, since the RE2 API is C++. So you
will need both C and C++ compilers, such as gcc/g++ or clang/clang++.
See `CONTRIBUTING.rst <CONTRIBUTING.rst>`_ for more details about
building from source.
By default, the vmod ``configure`` script installs the vmod in
the same directory as Varnish, determined via ``pkg-config(1)``. The
vmod installation directory can be overridden by passing the
``VMOD_DIR`` variable to ``configure``.
Other files such as this man-page are installed in the locations
Other files such as the man-page are installed in the locations
determined by ``configure``, which inherits its default ``--prefix``
setting from Varnish.
......@@ -29,7 +29,7 @@ AC_ARG_WITH([rst2man],
[RST2MAN="$withval"],
AC_CHECK_PROGS(RST2MAN, [rst2man rst2man.py], []))
m4_ifndef([VARNISH_PREREQ], AC_MSG_ERROR([Need varnish.m4 -- see README.rst]))
m4_ifndef([VARNISH_PREREQ], AC_MSG_ERROR([Need varnish.m4 -- see INSTALL.rst]))
PKG_CHECK_MODULES([RE2], [re2])
if echo "$RE2_LIBS" | grep -- '-L' >/dev/null ; then
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment