Skip to content
Browse files

Move to RST-based README and merge with manfile

  • Loading branch information...
1 parent 1039dd3 commit bae579806c7d6de4f96d18d46e012ba6b6dca13f @KristianLyng KristianLyng committed Sep 21, 2011
Showing with 112 additions and 102 deletions.
  1. +16 −1 Makefile.am
  2. +0 −33 README
  3. +96 −0 README.rst
  4. +0 −1 configure.ac
  5. +0 −14 man/Makefile.am
  6. +0 −53 man/vmod_example.rst
View
17 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
View
33 README
@@ -1,33 +0,0 @@
-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");
-}
View
96 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
View
1 configure.ac
@@ -68,6 +68,5 @@ fi
AC_CONFIG_FILES([
Makefile
src/Makefile
- man/Makefile
])
AC_OUTPUT
View
14 man/Makefile.am
@@ -1,14 +0,0 @@
-#
-
-dist_man_MANS = vmod_example.3
-MAINTAINERCLEANFILES = $(dist_man_MANS)
-
-vmod_example.3: vmod_example.rst
-if HAVE_RST2MAN
- ${RST2MAN} vmod_example.rst $@
-else
- @echo "========================================"
- @echo "You need rst2man installed to make dist"
- @echo "========================================"
- @false
-endif
View
53 man/vmod_example.rst
@@ -1,53 +0,0 @@
-============
-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");
-
-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

0 comments on commit bae5798

Please sign in to comment.
Something went wrong with that request. Please try again.