minor symfony#3880 document the mysterious abc part of the header (greg0ire)

weaverryan · weaverryan · commit a41af7e0f4a1 · 2014-07-11T17:13:57.000-05:00
This PR was submitted for the master branch but it was merged into the 2.3 branch instead (closes symfony#3880). Discussion ---------- document the mysterious abc part of the header One can't help but wonder what it is about. Disclaimer: I'm far from being a specialist, I barely know varnish. This is what I understand after a cursory reading of [this document](http://www.w3.org/TR/edge-arch). Please check this carefully. | Q | A | ------------- | --- | Doc fix? | yes | New docs? | yes | Applies to | all | Fixed tickets | none Commits ------- 48f55e2 document the mysterious abc part of the header
diff --git a/cookbook/cache/varnish.rst b/cookbook/cache/varnish.rst
@@ -38,6 +38,11 @@ application:
         set req.http.Surrogate-Capability = "abc=ESI/1.0";
     }
 
+.. note::
+
+    The ``abc`` part of the header isn't important unless you have multiple "surrogates"
+    that need to advertise their capabilities. See `Surrogate-Capability Header`_ for details.
+
 Then, optimize Varnish so that it only parses the Response contents when there
 is at least one ESI tag by checking the ``Surrogate-Control`` header that
 Symfony2 adds automatically:
@@ -217,3 +222,4 @@ absolute URLs:
 .. _`Varnish`: https://www.varnish-cache.org
 .. _`Edge Architecture`: http://www.w3.org/TR/edge-arch
 .. _`GZIP and Varnish`: https://www.varnish-cache.org/docs/3.0/phk/gzip.html
+.. _`Surrogate-Capability Header`: http://www.w3.org/TR/edge-arch
