r5168 - trunk/varnish-cache/doc/sphinx/reference

[perbu at varnish-cache.org]

Author: perbu
Date: 2010-09-06 14:15:08 +0200 (Mon, 06 Sep 2010)
New Revision: 5168

Modified:
   trunk/varnish-cache/doc/sphinx/reference/vcl.rst
Log:
cleanup + add return()

Modified: trunk/varnish-cache/doc/sphinx/reference/vcl.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/reference/vcl.rst	2010-09-06 12:03:43 UTC (rev 5167)
+++ trunk/varnish-cache/doc/sphinx/reference/vcl.rst	2010-09-06 12:15:08 UTC (rev 5168)
@@ -290,7 +290,7 @@
 workflow.  These subroutines may inspect and manipulate HTTP headers
 and various other aspects of each request, and to a certain extent
 decide how the request should be handled.  Each subroutine terminates
-by calling one of a small number of keywords which indi‐ cates the
+by calling one of a small number of keywords which indicates the
 desired outcome.
 
 vcl_recv
@@ -298,9 +298,10 @@
   been received and parsed.  Its purpose is to decide whether or not
   to serve the request, how to do it, and, if applicable, which backend
   to use.
+  
+  The vcl_recv subroutine may terminate with calling return() on one of
+  the following keywords:
 
-  The vcl_recv subroutine may terminate with one of the following keywords:
-
   error code [reason]
     Return the specified error code to the client and abandon the request.
 
@@ -320,9 +321,10 @@
   on to the backend, and any further data from either client or
   backend is passed on unaltered until either end closes the
   connection.
+  
+  The vcl_pipe subroutine may terminate with calling return() with one of
+  the following keywords:
 
-  The vcl_pipe subroutine may terminate with one of the following keywords:
-
   error code [reason]
     Return the specified error code to the client and abandon the request.
 
@@ -334,9 +336,10 @@
   on to the backend, and the backend's response is passed on to the
   client, but is not entered into the cache.  Subsequent requests sub‐
   mitted over the same client connection are handled normally.
-
-  The vcl_pass subroutine may terminate with one of the following keywords:
-
+  
+  The vcl_recv subroutine may terminate with calling return() with one of
+  the following keywords:
+ 
   error code [reason]
     Return the specified error code to the client and abandon the request.
 
@@ -345,8 +348,10 @@
 
 vcl_hash
   Use req.hash += req.http.Cookie or similar to include the Cookie HTTP
-  header in the hash string.  The vcl_hash subroutine may terminate with
-  one of the following keywords:
+  header in the hash string.  
+  
+  The vcl_hash subroutine may terminate with calling return() with one of
+  the following keywords:
 
   hash
     Proceed.
@@ -354,7 +359,8 @@
 vcl_hit
   Called after a cache lookup if the requested document was found in the cache.
 
-  The vcl_hit subroutine may terminate with one of the following keywords:
+  The vcl_hit subroutine may terminate with calling return() with one of
+  the following keywords:
 
   error code [reason]
     Return the specified error code to the client and abandon the request.
@@ -371,7 +377,8 @@
   in the cache.  Its purpose is to decide whether or not to attempt to
   retrieve the document from the backend, and which backend to use.
 
-  The vcl_miss subroutine may terminate with one of the following keywords:
+  The vcl_miss subroutine may terminate with calling return() with one of
+  the following keywords:
 
   error code [reason]
     Return the specified error code to the client and abandon the request.
@@ -385,9 +392,10 @@
 
 vcl_fetch
   Called after a document has been successfully retrieved from the backend.
+  
+  The vcl_fetch subroutine may terminate with calling return() with
+  one of the following keywords:
 
-  The vcl_fetch subroutine may terminate with one of the following keywords:
-
   error code [reason]
     Return the specified error code to the client and abandon the request.