[master] 6b283ff Add a note to clarify the event function's priv object.

[Dag Haavi Finstad]

commit 6b283ff1cbc3c3a2b01a7cef477003ccc9fe80a8
Author: Dag Haavi Finstad <daghf at varnish-software.com>
Date:   Sun Oct 25 20:22:05 2015 +0100

    Add a note to clarify the event function's priv object.

diff --git a/doc/sphinx/reference/vmod.rst b/doc/sphinx/reference/vmod.rst
index 697fc6a..91953b0 100644
--- a/doc/sphinx/reference/vmod.rst
+++ b/doc/sphinx/reference/vmod.rst
@@ -302,7 +302,8 @@ The VCL compiler supports the following private pointers:
 * ``PRIV_VCL`` "per vcl" private pointers are useful for such global
   state that applies to all calls in this VCL, for instance flags that
   determine if regular expressions are case-sensitive in this vmod or
-  similar.
+  similar. The ``PRIV_VCL`` object is the same object that is passed
+  to the VMOD's event function.
 
 The way it works in the vmod code, is that a ``struct vmod_priv *`` is
 passed to the functions where one of the ``PRIV_*`` argument types is