[6.0] 270706a7b improve documentation on backend timeout defaults
Dridi Boukelmoune
dridi.boukelmoune at gmail.com
Wed Oct 31 13:08:08 UTC 2018
commit 270706a7baf34e06b31483f5d04cad71374152d6
Author: Nils Goroll <nils.goroll at uplex.de>
Date: Mon Aug 27 15:06:27 2018 +0200
improve documentation on backend timeout defaults
diff --git a/doc/sphinx/reference/vcl.rst b/doc/sphinx/reference/vcl.rst
index 913775778..d720dbc95 100644
--- a/doc/sphinx/reference/vcl.rst
+++ b/doc/sphinx/reference/vcl.rst
@@ -201,6 +201,8 @@ Example::
}
+.. _ref_backend_def:
+
Backend definition
------------------
@@ -239,12 +241,18 @@ parameters. The following attributes are available:
``.connect_timeout``
Timeout for connections.
+ Default: :ref:`ref_param_connect_timeout` parameter.
+
``.first_byte_timeout``
Timeout for first byte.
+ Default: :ref:`ref_param_first_byte_timeout` parameter.
+
``.between_bytes_timeout``
Timeout between bytes.
+ Default: :ref:`ref_param_between_bytes_timeout` parameter.
+
``.probe``
Attach a probe to the backend. See `Probes`_
diff --git a/doc/sphinx/reference/vcl_var.rst b/doc/sphinx/reference/vcl_var.rst
index 2bb40b214..1d629ae91 100644
--- a/doc/sphinx/reference/vcl_var.rst
+++ b/doc/sphinx/reference/vcl_var.rst
@@ -585,6 +585,12 @@ bereq.connect_timeout
Writable from: vcl_pipe, backend
+ Default:
+
+ * :ref:`ref_backend_def` ``.connect_timeout`` attribute, which
+ defaults to
+ * :ref:`ref_param_connect_timeout` parameter.
+
The time in seconds to wait for a backend connection to be
established.
@@ -597,6 +603,12 @@ bereq.first_byte_timeout
Writable from: backend
+ Default:
+
+ * :ref:`ref_backend_def` ``.first_byte_timeout`` attribute,
+ which defaults to
+ * :ref:`ref_param_first_byte_timeout` parameter.
+
The time in seconds to wait getting the first byte back
from the backend. Not available in pipe mode.
@@ -609,6 +621,12 @@ bereq.between_bytes_timeout
Writable from: backend
+ Default:
+
+ * :ref:`ref_backend_def` ``.between_bytes_timeout`` backend
+ attribute, which defaults to
+ * :ref:`ref_param_between_bytes_timeout` parameter.
+
The time in seconds to wait between each received byte from the
backend. Not available in pipe mode.
More information about the varnish-commit
mailing list