[master] b011633e9 release docs: better links and some more polishing
Nils Goroll
nils.goroll at uplex.de
Fri Mar 13 09:14:06 UTC 2020
commit b011633e98d0c16fc0c661fdef8d974ab95b8a25
Author: Nils Goroll <nils.goroll at uplex.de>
Date: Fri Mar 13 10:13:07 2020 +0100
release docs: better links and some more polishing
diff --git a/doc/sphinx/whats-new/changes-6.4.rst b/doc/sphinx/whats-new/changes-6.4.rst
index 11d9ee23e..afc45a4bf 100644
--- a/doc/sphinx/whats-new/changes-6.4.rst
+++ b/doc/sphinx/whats-new/changes-6.4.rst
@@ -51,7 +51,8 @@ the error message::
Parameters
~~~~~~~~~~
-* Raised the minimum for the ``vcl_cooldown`` parameter to 1 second.
+* Raised the minimum for the :ref:`ref_param_vcl_cooldown` parameter
+ to 1 second.
Changes in behavior
~~~~~~~~~~~~~~~~~~~
@@ -70,7 +71,8 @@ Changes to VCL
It can be used whenever a backend is needed for syntactical
reasons. The ``none`` backend will fail any attempt to use it.
-* ``std.rollback(bereq)`` is now safe to use
+* ``std.rollback(bereq)`` is now safe to use, see :ref:`vmod_std(3)`
+ for details.
* Deliberately closing backend requests through ``return(abandon)``,
``return(fail)`` or ``return(error)`` is no longer accounted as a
@@ -85,13 +87,14 @@ Changes to VCL
VCL variables
~~~~~~~~~~~~~
-* Add more vcl control over timeouts with ``sess.timeout_linger``,
- ``sess.send_timeout`` and ``sess.idle_send_timeout``
+* Add more vcl control over timeouts with the ``sess.timeout_linger``,
+ ``sess.send_timeout`` and ``sess.idle_send_timeout`` variables
+ corresponding the parameters by the same names.
VMODs
=====
-* Imported ``vmod_cookie`` from `varnish_modules`_
+* Imported :ref:`vmod_cookie(3)` from `varnish_modules`_
The previously deprecated function ``cookie.filter_except()`` has
been removed during import. It was replaced by ``cookie.keep()``
@@ -116,8 +119,11 @@ varnishstat
* The ``MAIN.sess_drop`` counter is gone.
* Added ``rx_close_idle`` counter for separate accounting when
- ``timeout_idle`` is reached. Also, ``send_timeout`` is no longer
- reported as "remote closed".
+ ``sess.timeout_idle`` / :ref:`ref_param_timeout_idle` is reached.
+
+* ``sess.send_timeout`` / :ref:`ref_param_send_timeout` being reached
+ is no longer reported as ``MAIN.sc_rem_close``, but as
+ ``MAIN.sc_tx_error``.
Changes for developers and VMOD authors
=======================================
diff --git a/doc/sphinx/whats-new/upgrading-6.4.rst b/doc/sphinx/whats-new/upgrading-6.4.rst
index 53ead0a4a..557f37697 100644
--- a/doc/sphinx/whats-new/upgrading-6.4.rst
+++ b/doc/sphinx/whats-new/upgrading-6.4.rst
@@ -21,12 +21,12 @@ varnishd
more stable backend selection through consistent hashing. See
:ref:`vmod_directors(3)` for details.
-* We fixed a case where ``send_timeout`` had no effect on HTTP/1
+* We fixed a case where :ref:`ref_param_send_timeout` had no effect on HTTP/1
connections when streaming from a backend fetch, in other words, a
- connection might not have got closed despite the ``send_timeout``
+ connection might not have got closed despite the :ref:`ref_param_send_timeout`
having been reached. HTTP/2 was not affected.
- When ``send_timeout`` is reached on HTTP/1, the ``MAIN.sc_tx_error``
+ When :ref:`ref_param_send_timeout` is reached on HTTP/1, the ``MAIN.sc_tx_error``
is increased and a ``Debug`` message ``Hit total send timeout, wrote
= x/y; not retrying`` is logged.
@@ -35,8 +35,8 @@ varnishd
Users with long running backend fetches and HTTP/1 clients should
watch out for an increase of the ``MAIN.sc_tx_error`` compared to
- before the deployment and consider increasing ``send_timeout``
- appropriately.
+ before the deployment and consider increasing
+ :ref:`ref_param_send_timeout` appropriately.
The timeout can also be set per connection from VCL as
``sess.send_timeout``.
@@ -47,13 +47,16 @@ Statistics
* The ``MAIN.sess_drop`` counter is gone. It should be removed from
any statistics gathering tools, if present
-* ``timeout_idle`` being reached on HTTP/1 used to be accounted to the
- ``MAIN.rx_timeout`` statistic. We have now added the
- ``MAIN.rx_close_idle`` counter for this case specifically.
+* ``sess.timeout_idle`` / :ref:`ref_param_timeout_idle` being reached
+ on HTTP/1 used to be accounted to the ``MAIN.rx_timeout``
+ statistic. We have now added the ``MAIN.rx_close_idle`` counter for
+ this case specifically.
-* ``send_timeout`` being reached on HTTP/1 used to be accounted to
- ``MAIN.sc_rem_close``. Such timeout events are now accounted towards
- ``MAIN.sc_tx_error``.
+* ``sess.send_timeout`` / :ref:`ref_param_send_timeout` being reached
+ on HTTP/1 used to be accounted to ``MAIN.sc_rem_close``. Such
+ timeout events are now accounted towards ``MAIN.sc_tx_error``.
+
+see :ref:`varnish-counters(7)` for details
vsl/logs
--------
More information about the varnish-commit
mailing list