[experimental-ims] e574fbc Fix docs for req.esi

Geoff Simmons geoff at varnish-cache.org
Mon Jan 9 21:52:03 CET 2012


commit e574fbcf96ef5e6668c439fb4527e0752041c088
Author: Andreas Plesner Jacobsen <apj at mutt.dk>
Date:   Wed Oct 5 18:57:49 2011 +0200

    Fix docs for req.esi

diff --git a/doc/sphinx/reference/vcl.rst b/doc/sphinx/reference/vcl.rst
index 9fd526c..aaca549 100644
--- a/doc/sphinx/reference/vcl.rst
+++ b/doc/sphinx/reference/vcl.rst
@@ -740,7 +740,9 @@ req.restarts
   A count of how many times this request has been restarted.
 
 req.esi
-  True if the request is an ESI request.
+  Boolean. Set to false to disable ESI processing regardless of any
+  value in beresp.do_esi. Defaults to true. This variable is subject
+  to change in future versions, you should avoid using it.
 
 req.esi_level
   A count of how many levels of ESI requests we're currently at.
@@ -788,8 +790,9 @@ beresp.do_stream
   as it is delivered so only client can access the object.
 
 beresp.do_esi
-  Boolean. ESI-process the object after fetching it. Defaults to false. Set it
-  to true to parse the object for ESI directives.
+  Boolean. ESI-process the object after fetching it. Defaults to
+  false. Set it to true to parse the object for ESI directives. Will
+  only be honored if req.esi is true.
 
 beresp.do_gzip
   Boolean. Gzip the object before storing it. Defaults to false.



More information about the varnish-commit mailing list