[master] 3714f9fa4 Fix beresp.do_esi docs

Nils Goroll nils.goroll at uplex.de
Wed Sep 8 07:53:08 UTC 2021


commit 3714f9fa4c4074a1a3794d4c15b668ad4480a756
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Wed Sep 8 09:44:58 2021 +0200

    Fix beresp.do_esi docs
    
    The variable is independent of req.esi / resp.do_esi:
    
    Whether or not the backend side prepares an object for ESI has nothing
    to do with whether or not the client side processes it.

diff --git a/doc/sphinx/reference/vcl_var.rst b/doc/sphinx/reference/vcl_var.rst
index cce173636..0aa911b82 100644
--- a/doc/sphinx/reference/vcl_var.rst
+++ b/doc/sphinx/reference/vcl_var.rst
@@ -759,8 +759,11 @@ beresp.do_esi
 
 	Default: ``false``.
 
-	Set it to true to parse the object for ESI directives.
-	Will only be honored if req.esi is true.
+	Set it to true to parse the object for ESI directives. This is
+	necessary for later ESI processing on the client side. If
+	beresp.do_esi is false when an object enters the cache, client
+	side ESI processing will not be possible (obj.can_esi will be
+	false).
 
 	It is a VCL error to use beresp.do_esi after setting beresp.filters.
 
@@ -1254,8 +1257,8 @@ resp.do_esi	``VCL >= 4.1``
 
 	Default: obj.can_esi
 
-	This can be used to selectively disable ESI processing,
-	even though ESI parsing happened during fetch.
+	This can be used to selectively disable ESI processing, even
+	though ESI parsing happened during fetch (see beresp.do_esi).
 	This is useful when Varnish caches peer with each other.
 
 	It is a VCL error to use resp.do_esi after setting resp.filters.


More information about the varnish-commit mailing list