Skip to content
This repository has been archived by the owner on Nov 18, 2020. It is now read-only.

Commit

Permalink
Move to RST-based README and merge with manfile
Browse files Browse the repository at this point in the history
  • Loading branch information
KristianLyng committed Sep 21, 2011
1 parent 1039dd3 commit bae5798
Show file tree
Hide file tree
Showing 6 changed files with 112 additions and 102 deletions.
17 changes: 16 additions & 1 deletion Makefile.am
@@ -1,3 +1,18 @@
ACLOCAL_AMFLAGS = -I m4

SUBDIRS = src man
SUBDIRS = src

EXTRA_DIST = README.rst

dist_man_MANS = vmod_example.3
MAINTAINERCLEANFILES = $(dist_man_MANS)

vmod_example.3: README.rst
if HAVE_RST2MAN
${RST2MAN} README.rst $@
else
@echo "========================================"
@echo "You need rst2man installed to make dist"
@echo "========================================"
@false
endif
33 changes: 0 additions & 33 deletions README

This file was deleted.

96 changes: 96 additions & 0 deletions README.rst
@@ -0,0 +1,96 @@
============
vmod_example
============

----------------------
Varnish Example Module
----------------------

:Author: Martin Blix Grydeland
:Date: 2011-05-26
:Version: 1.0
:Manual section: 3

SYNOPSIS
========

import example;

DESCRIPTION
===========

Example Varnish vmod demonstrating how to write an out-of-tree Varnish vmod.

Implements the traditional Hello World as a vmod.

FUNCTIONS
=========

hello
-----

Prototype
::

hello(STRING S)
Return value
STRING
Description
Returns "Hello, " prepended to S
Example
::

set resp.http.hello = example.hello("World");

INSTALLATION
============

This is an example skeleton for developing out-of-tree Varnish
vmods. It implements the "Hello, World!" as a vmod callback. Not
particularly useful in good hello world tradition, but demonstrates how
to get the glue around a vmod working.

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.

Usage::

./configure VARNISHSRC=DIR [VMODDIR=DIR]

`VARNISHSRC` is the directory of the Varnish source tree for which to
compile your vmod. Both the `VARNISHSRC` and `VARNISHSRC/include`
will be added to the include search paths for your module.

Optionally you can also set the vmod install directory by adding
`VMODDIR=DIR` (defaults to the pkg-config discovered directory from your
Varnish installation).

Make targets:

* make - builds the vmod
* make install - installs your vmod in `VMODDIR`
* make check - runs the unit tests in ``src/tests/*.vtc``

In your VCL you could then use this vmod along the following lines::
import example;

sub vcl_deliver {
# This sets resp.http.hello to "Hello, World"
set resp.http.hello = example.hello("World");
}

HISTORY
=======

This manual page was released as part of the libvmod-example package,
demonstrating how to create an out-of-tree Varnish vmod.

COPYRIGHT
=========

This document is licensed under the same license as the
libvmod-example project. See LICENSE for details.

* Copyright (c) 2011 Varnish Software
1 change: 0 additions & 1 deletion configure.ac
Expand Up @@ -68,6 +68,5 @@ fi
AC_CONFIG_FILES([
Makefile
src/Makefile
man/Makefile
])
AC_OUTPUT
14 changes: 0 additions & 14 deletions man/Makefile.am

This file was deleted.

53 changes: 0 additions & 53 deletions man/vmod_example.rst

This file was deleted.

0 comments on commit bae5798

Please sign in to comment.