[master] 020df86 Fix up documentation for ESI syntax

Tollef Fog Heen tfheen at varnish-cache.org
Wed Apr 6 08:35:07 CEST 2011


commit 020df8664a41057ccc3e87cd8c4dc7b57be95274
Author: Tollef Fog Heen <tfheen at varnish-software.com>
Date:   Wed Apr 6 08:34:28 2011 +0200

    Fix up documentation for ESI syntax
    
    The syntax for enabling ESI has changed in trunk, update the
    documentation to match.

diff --git a/doc/sphinx/tutorial/advanced_topics.rst b/doc/sphinx/tutorial/advanced_topics.rst
index 4491c28..1045de9 100644
--- a/doc/sphinx/tutorial/advanced_topics.rst
+++ b/doc/sphinx/tutorial/advanced_topics.rst
@@ -54,10 +54,10 @@ your hit rate and reduce the load on your servers. ESI looks like this::
   </BODY>
   </HTML>
 
-ESI is processed in vcl_fetch by using the *esi* keyword.::
+ESI is processed in vcl_fetch by setting *do_esi* to true.::
 
   sub vcl_fetch {
       if (req.url == "/test.html") {
-	  esi;  /* Do ESI processing */
+	  set beresp.do_esi = true;  /* Do ESI processing */
       }
   }
diff --git a/doc/sphinx/tutorial/esi.rst b/doc/sphinx/tutorial/esi.rst
index e2002bd..ef79f3e 100644
--- a/doc/sphinx/tutorial/esi.rst
+++ b/doc/sphinx/tutorial/esi.rst
@@ -47,7 +47,7 @@ For ESI to work you need to activate ESI processing in VCL, like this:::
 
     sub vcl_fetch {
     	if (req.url == "/test.html") {
-           esi;        		     /* Do ESI processing		*/
+           set beresp.do_esi = true; /* Do ESI processing		*/
            set obj.ttl = 24 h; 	     /* Sets the TTL on the HTML above  */
     	} elseif (req.url == "/cgi-bin/date.cgi") {
            set obj.ttl = 1m;         /* Sets a one minute TTL on	*/
diff --git a/doc/sphinx/tutorial/vcl.rst b/doc/sphinx/tutorial/vcl.rst
index ccf43d2..39b1e92 100644
--- a/doc/sphinx/tutorial/vcl.rst
+++ b/doc/sphinx/tutorial/vcl.rst
@@ -77,9 +77,6 @@ The most common actions to call are these:
 *deliver*
  Deliver the cached object to the client.  Usually called in vcl_fetch. 
 
-*esi*
- ESI-process the fetched document.
-
 Requests, responses and objects
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 



More information about the varnish-commit mailing list