[master] 8143d06 Always test-compile your RST changes...

Poul-Henning Kamp phk at varnish-cache.org
Wed Nov 13 11:45:15 CET 2013

commit 8143d06c8c7182d9a85f7067fecad75b494f7ee0
Author: Poul-Henning Kamp <phk at FreeBSD.org>
Date:   Wed Nov 13 10:45:03 2013 +0000

    Always test-compile your RST changes...

diff --git a/doc/sphinx/reference/vmod.rst b/doc/sphinx/reference/vmod.rst
index 62803e5..88a511d 100644
--- a/doc/sphinx/reference/vmod.rst
+++ b/doc/sphinx/reference/vmod.rst
@@ -35,7 +35,7 @@ VMOD Directory
 The VMOD directory is an up-to-date compilation of maintained
 extensions written for Varnish Cache:
- https://www.varnish-cache.org/vmods
 The vmod.vcc file
@@ -196,20 +196,25 @@ VOID
-	C-type: ``const struct gethdr_s *''
+	C-type: ``const struct gethdr_s *``
 	These are VCL compiler generated constants referencing
 	a particular header in a particular HTTP entity, for instance
-	``req.http.cookie'' or ``beresp.http.last-modified''
+	``req.http.cookie`` or ``beresp.http.last-modified``.
+	By passing a reference to the header, the VMOD code can
+	both read and write the header in question.
+	If the header was passed as STRING, the VMOD code only sees
+	the value, but not where it came from.
-	C-type: ``const struct suckaddr *''
+	C-type: ``const struct suckaddr *``
 	This is an opaque type, see the ``include/vsa.h`` file for
 	which primitives we support on this type.
-	C-type: ``unsigned''
+	C-type: ``unsigned``
 	Zero means false, anything else means true.

More information about the varnish-commit mailing list