Commit 62755779 by Geoff Simmons

Move the INSTALLATION section of the docs into a separate file.

parent bee2cff8
INSTALLATION
============
Building from source
~~~~~~~~~~~~~~~~~~~~
The VMOD is built on a system where an instance of Varnish is
installed, and the auto-tools will attempt to locate the Varnish
instance, and then pull in libraries and other support files from
there.
Quick start
-----------
This sequence should be enough in typical setups:
1. ``./autogen.sh`` (for git-installation)
2. ``./configure``
3. ``make``
4. ``make check`` (regression tests)
5. ``make install`` (may require root: sudo make install)
Alternative configs
-------------------
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
For developers
--------------
As with Varnish, you can use these ``configure`` options for stricter
compiling:
* ``--enable-developer-warnings``
* ``--enable-extra-developer-warnings`` (for GCC 4)
* ``--enable-werror``
The VMOD must always build successfully with these options enabled.
Also as with Varnish, you can add ``--enable-debugging-symbols``, so
that the VMOD's symbols are available to debuggers, in core dumps and
so forth.
......@@ -107,8 +107,8 @@ CONTENTS
========
* regex(STRING)
* BOOL match_dyn(PRIV_TASK, STRING, STRING)
* STRING backref_dyn(PRIV_TASK, INT, STRING)
* BOOL match_dyn(STRING, STRING)
* STRING backref_dyn(INT, STRING)
* STRING version()
.. _obj_regex:
......@@ -189,7 +189,7 @@ match_dyn
::
BOOL match_dyn(PRIV_TASK, STRING, STRING)
BOOL match_dyn(STRING, STRING)
Description
Compiles the regular expression given in the first argument,
......@@ -211,7 +211,7 @@ backref_dyn
::
STRING backref_dyn(PRIV_TASK, INT, STRING fallback="**BACKREF FUNCTION FAILED**")
STRING backref_dyn(INT, STRING fallback="**BACKREF FUNCTION FAILED**")
Description
Similar to the ``backref`` method, this function extracts the
......@@ -252,49 +252,7 @@ versions of Varnish.
INSTALLATION
============
The VMOD is built on a system where an instance of Varnish is
installed, and the auto-tools will attempt to locate the Varnish
instance, and then pull in libraries and other support files from
there.
Quick start
-----------
This sequence should be enough in typical setups:
1. ``./autogen.sh`` (for git-installation)
2. ``./configure``
3. ``make``
4. ``make check`` (regression tests)
5. ``make install`` (may require root: sudo make install)
Alternative configs
-------------------
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
For developers
--------------
As with Varnish, you can use these ``configure`` options for stricter
compiling:
* ``--enable-developer-warnings``
* ``--enable-extra-developer-warnings`` (for GCC 4)
* ``--enable-werror``
The VMOD must always build successfully with these options enabled.
Also as with Varnish, you can add ``--enable-debugging-symbols``, so
that the VMOD's symbols are available to debuggers, in core dumps and
so forth.
See `INSTALL.rst <INSTALL.rst>`_ in the project source repository.
AUTHORS
=======
......@@ -362,7 +320,7 @@ SEE ALSO
* varnishd(1)
* vcl(7)
* pcre(3)
* http://lassekarstensen.wordpress.com/2013/12/19/converting-a-varnish-3-0-vmod-to-4-0/
* source repository: https://code.uplex.de/uplex-varnish/libvmod-re
COPYRIGHT
=========
......
......@@ -188,49 +188,7 @@ versions of Varnish.
INSTALLATION
============
The VMOD is built on a system where an instance of Varnish is
installed, and the auto-tools will attempt to locate the Varnish
instance, and then pull in libraries and other support files from
there.
Quick start
-----------
This sequence should be enough in typical setups:
1. ``./autogen.sh`` (for git-installation)
2. ``./configure``
3. ``make``
4. ``make check`` (regression tests)
5. ``make install`` (may require root: sudo make install)
Alternative configs
-------------------
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
For developers
--------------
As with Varnish, you can use these ``configure`` options for stricter
compiling:
* ``--enable-developer-warnings``
* ``--enable-extra-developer-warnings`` (for GCC 4)
* ``--enable-werror``
The VMOD must always build successfully with these options enabled.
Also as with Varnish, you can add ``--enable-debugging-symbols``, so
that the VMOD's symbols are available to debuggers, in core dumps and
so forth.
See `INSTALL.rst <INSTALL.rst>`_ in the project source repository.
AUTHORS
=======
......@@ -298,4 +256,4 @@ SEE ALSO
* varnishd(1)
* vcl(7)
* pcre(3)
* http://lassekarstensen.wordpress.com/2013/12/19/converting-a-varnish-3-0-vmod-to-4-0/
* source repository: https://code.uplex.de/uplex-varnish/libvmod-re
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