[4.1] 21d7396 To keep the OCD at bay sort this the right way

Federico G. Schwindt fgsch at lodoss.net
Fri Sep 4 15:54:54 CEST 2015


commit 21d73961b69280895edb00dbd15116d0db7a1fe7
Author: Federico G. Schwindt <fgsch at lodoss.net>
Date:   Sat Aug 15 00:12:38 2015 +0100

    To keep the OCD at bay sort this the right way

diff --git a/doc/sphinx/reference/vmod.rst b/doc/sphinx/reference/vmod.rst
index 893a1c7..f6516a1 100644
--- a/doc/sphinx/reference/vmod.rst
+++ b/doc/sphinx/reference/vmod.rst
@@ -179,17 +179,22 @@ IP
 	This is an opaque type, see the ``include/vsa.h`` file for
 	which primitives we support on this type.
 
-REAL
-	C-type: ``double``
+PRIV_CALL
+	See :ref:`ref-vmod-private-pointers` below.
 
-	A floating point value.
+PRIV_TASK
+	See :ref:`ref-vmod-private-pointers` below.
 
-TIME
-	C-type: ``double``
+PRIV_TOP
+	See :ref:`ref-vmod-private-pointers` below.
 
-	Unit: seconds since UNIX epoch.
+PRIV_VCL
+	See :ref:`ref-vmod-private-pointers` below.
 
-	An absolute time, as in 1284401161.
+REAL
+	C-type: ``double``
+
+	A floating point value.
 
 STRING
 	C-type: ``const char *``
@@ -244,24 +249,19 @@ STRING_LIST
 	and make sure your workspace_client and workspace_backend params
 	are big enough.
 
+TIME
+	C-type: ``double``
+
+	Unit: seconds since UNIX epoch.
+
+	An absolute time, as in 1284401161.
+
 VOID
 	C-type: ``void``
 
 	Can only be used for return-value, which makes the function a VCL
 	procedure.
 
-PRIV_VCL
-	See :ref:`ref-vmod-private-pointers` below.
-
-PRIV_CALL
-	See :ref:`ref-vmod-private-pointers` below.
-
-PRIV_TASK
-	See :ref:`ref-vmod-private-pointers` below.
-
-PRIV_TOP
-	See :ref:`ref-vmod-private-pointers` below.
-
 
 .. _ref-vmod-private-pointers:
 
@@ -279,11 +279,6 @@ The VCL compiler supports the following private pointers:
   compiled regular expression specific to a regsub() statement or a
   simply caching the last output of some expensive lookup.
 
-* ``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.
-
 * ``PRIV_TASK`` "per task" private pointers are useful for state that
   applies to calls for either a specific request or a backend
   request. For instance this can be the result of a parsed cookie
@@ -297,6 +292,11 @@ The VCL compiler supports the following private pointers:
   defined for the client side. When used from backend VCL subs, a NULL
   pointer will be passed.
 
+* ``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.
+
 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
 specified.



More information about the varnish-commit mailing list