Fixed some things. Lots more to do on this one

doc/sphinx/users-guide/vcl-built-in-subs.rst

 
 .. _vcl-built-in-subs:
 
-Built in subroutines
---------------------
-
-
-vcl_init
-~~~~~~~~
+.. XXX This document needs substational review.
 
- Called when VCL is loaded, before any requests pass through it.
- Typically used to initialize VMODs.
 
-  return() values:
+Built in subroutines
+--------------------
 
-  ok
-    Normal return, VCL continues loading.
 
 vcl_recv
 ~~~~~~~~
 
- Called at the beginning of a request, after the complete request has
- 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.
+Called at the beginning of a request, after the complete request has
+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:
+It is also used to modify the request, something you'll probably find
+yourself doing frequently. 
+
+The vcl_recv subroutine may terminate with calling ``return()`` on one
+of the following keywords:
 
   error code [reason]
     Return the specified error code to the client and abandon the request.
@@ -43,71 +38,22 @@ vcl_recv
     to ``GET`` regardless of the value of ``req.method``.
 
 
-vcl_pipe
-~~~~~~~~
 
- Called upon entering pipe mode.  In this mode, the request is passed
- on to the backend, and any further data from either client or
- backend is passed on unaltered until either end closes the
- connection.
+vcl_backend_fetch
+~~~~~~~~~~~~~~~~~
 
- The vcl_pipe subroutine may terminate with calling return() with one of
- the following keywords:
+Called before sending the backend request. In this subroutine you
+typically alter the request before it gets to the backend.
 
-  error code [reason]
-    Return the specified error code to the client and abandon the request.
+.. XXX Return statements?
 
-  pipe
-    Proceed with pipe mode.
 
-vcl_pass
-~~~~~~~~
-
- Called upon entering pass mode.  In this mode, the request is passed
- on to the backend, and the backend's response is passed on to the
- client, but is not entered into the cache.  Subsequent requests
- submitted over the same client connection are handled normally.
-
- The vcl_pass 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.
-
-  pass
-    Proceed with pass mode.
-
-  restart
-    Restart the transaction. Increases the restart counter. If the number
-    of restarts is higher than *max_restarts* Varnish emits a guru meditation
-    error.
-
-vcl_miss
-~~~~~~~~
-
-Called after a cache lookup if the requested document was not found 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 calling return() with one
-of the following keywords:
-
-  error code [reason]
-    Return the specified error code to the client and abandon the request.
-
-  pass
-    Switch to pass mode.  Control will eventually pass to vcl_pass.
-
-  fetch
-    Retrieve the requested object from the backend.  Control will
-    eventually pass to vcl_fetch.
-
-vcl_fetch
-~~~~~~~~~
+vcl_backend_response
+~~~~~~~~~~~~~~~~~~~
 
 Called after a document has been successfully retrieved from the backend.
 
-The vcl_fetch subroutine may terminate with calling return() with one
+The vcl_backend_response subroutine may terminate with calling return() with one
 of the following keywords:
 
   deliver
@@ -151,13 +97,13 @@ keywords:
     of restarts is higher than *max_restarts* Varnish emits a guru meditation
     error.
 
-vcl_error
-~~~~~~~~~
+vcl_backend_error
+~~~~~~~~~~~~~~~~~
 
 Called when we hit an error, either explicitly or implicitly due to
 backend or internal errors.
 
-The vcl_error subroutine may terminate by calling return with one of
+The vcl_backend_error subroutine may terminate by calling return with one of
 the following keywords:
 
   deliver
@@ -168,11 +114,85 @@ the following keywords:
     of restarts is higher than *max_restarts* Varnish emits a guru meditation
     error.
 
+
+vcl_pipe
+~~~~~~~~
+
+Called upon entering pipe mode.  In this mode, the request is passed
+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:
+
+  error code [reason]
+    Return the specified error code to the client and abandon the request.
+
+  pipe
+    Proceed with pipe mode.
+
+vcl_pass
+~~~~~~~~
+
+Called upon entering pass mode.  In this mode, the request is passed
+on to the backend, and the backend's response is passed on to the
+client, but is not entered into the cache.  Subsequent requests
+submitted over the same client connection are handled normally.
+
+The vcl_pass 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.
+
+  pass
+    Proceed with pass mode.
+
+  restart
+    Restart the transaction. Increases the restart counter. If the number
+    of restarts is higher than *max_restarts* Varnish emits a guru meditation
+    error.
+
+vcl_miss
+~~~~~~~~
+
+Called after a cache lookup if the requested document was not found 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 calling return() with one
+of the following keywords:
+
+  error code [reason]
+    Return the specified error code to the client and abandon the request.
+
+  pass
+    Switch to pass mode.  Control will eventually pass to vcl_pass.
+
+  fetch
+    Retrieve the requested object from the backend.  Control will
+    eventually pass to vcl_fetch.
+
+
+
+vcl_init
+~~~~~~~~
+
+Called when VCL is loaded, before any requests pass through it.
+Typically used to initialize VMODs.
+
+  return() values:
+
+  ok
+    Normal return, VCL continues loading.
+
+
 vcl_fini
 ~~~~~~~~
 
-  Called when VCL is discarded only after all requests have exited the VCL.
-  Typically used to clean up VMODs.
+Called when VCL is discarded only after all requests have exited the VCL.
+Typically used to clean up VMODs.
 
   return() values: