[Varnish] #1122: Backwards example in ESI documentation

Varnish varnish-bugs at varnish-cache.org
Tue Apr 3 16:24:43 CEST 2012

#1122: Backwards example in ESI documentation
 Reporter:  MatthewWilkes  |        Type:  documentation
   Status:  new            |    Priority:  low          
Milestone:                 |   Component:  documentation
  Version:  trunk          |    Severity:  trivial      
 Keywords:                 |  
 From: https://www.varnish-cache.org/docs/trunk/tutorial/esi.html

 Example: <!--esi ... -->

 This is a special construct to allow HTML marked up with ESI to render
 without processing. ESI Processors will remove the start ("<!--esi")
 and end ("-->") when the page is processed, while still processing the
 contents. If the page is not processed, it will remain, becoming an
 HTML/XML comment tag. For example::

   <p>Warning: ESI Disabled!</p>
   </p>  -->

 This assures that the ESI markup will not interfere with the rendering
 of the final HTML if not processed.

 The example here says ESI Disabled, but will only be rendered when ESI is
 enabled. It seems to be an example for <esi:remove /> instead.  The text
 should be changed to a real world example, like hiding explanatory text:

     <p>Add a comment below:</p>
     <esi:include src="http://example.com/comment_form.html" />

Ticket URL: <https://www.varnish-cache.org/trac/ticket/1122>
Varnish <https://varnish-cache.org/>
The Varnish HTTP Accelerator

More information about the varnish-bugs mailing list