[master] 593cc0156 consolidate return keyword documentation

Nils Goroll nils.goroll at uplex.de
Sun Mar 17 10:38:06 UTC 2019


commit 593cc01563a810c9cfb0900c7b026076b06e62c8
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Sun Mar 17 11:34:46 2019 +0100

    consolidate return keyword documentation

diff --git a/doc/sphinx/users-guide/vcl-built-in-subs.rst b/doc/sphinx/users-guide/vcl-built-in-subs.rst
index 95c9885a9..3b749c835 100644
--- a/doc/sphinx/users-guide/vcl-built-in-subs.rst
+++ b/doc/sphinx/users-guide/vcl-built-in-subs.rst
@@ -17,8 +17,8 @@ The behaviour for ``return()`` keywords is identical or at least
 similar across subroutines, so differences are only documented where
 relevant.
 
-common return keywords
-----------------------
+common return keywords for the client and backend side
+------------------------------------------------------
 
 .. _fail:
 
@@ -31,6 +31,11 @@ common return keywords
     Intended for fatal errors, for which only minimal error handling is
     possible.
 
+client side
+-----------
+
+common return keywords for the client side
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. _synth:
 
   ``synth(status code, reason)``
@@ -62,9 +67,6 @@ common return keywords
     preserved except for ``req.restarts`` and ``req.xid``, which need
     to change by design.
 
-client side
------------
-
 .. _vcl_recv:
 
 vcl_recv
@@ -323,6 +325,17 @@ following keywords:
 Backend Side
 ------------
 
+
+common return keywords for the backend side
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. _abandon:
+
+  ``abandon``
+    Abandon the backend request. Unless the backend request was a
+    background fetch, control is passed to :ref:`vcl_synth` on the
+    client side with ``resp.status`` preset to 503.
+
 .. _vcl_backend_fetch:
 
 vcl_backend_fetch
@@ -337,14 +350,12 @@ The `vcl_backend_fetch` subroutine may terminate with calling
   ``fail``
     see  `fail`_
 
+  ``abandon``
+    see  `abandon`_
+
   ``fetch``
     Fetch the object from the backend.
 
-  ``abandon``
-    Abandon the backend request. Unless the backend request was a
-    background fetch, control is passed to :ref:`vcl_synth` on the
-    client side with ``resp.status`` preset to 503.
-
 Before calling `vcl_backend_fetch`, Varnish core prepares the `bereq`
 backend request as follows:
 
@@ -387,6 +398,9 @@ The `vcl_backend_response` subroutine may terminate with calling
   ``fail``
     see  `fail`_
 
+  ``abandon``
+    see  `abandon`_
+
   ``deliver``
     For a 304 response, create an updated cache object.
     Otherwise, fetch the object body from the backend and initiate
@@ -398,11 +412,6 @@ The `vcl_backend_response` subroutine may terminate with calling
     If the number of retries is higher than *max_retries*,
     control will be passed to :ref:`vcl_backend_error`.
 
-  ``abandon``
-    Abandon the backend request. Unless the backend request was a
-    background fetch, control is passed to :ref:`vcl_synth` on the
-    client side with ``resp.status`` preset to 503.
-
   ``pass(duration)``
     Mark the object as a hit-for-pass for the given duration. Subsequent
     lookups hitting this object will be turned into passed transactions,


More information about the varnish-commit mailing list