[master] f3d4cad64 Polish the docs about VMOD std in the user release notes for March 2019.

Geoff Simmons geoff at uplex.de
Mon Mar 11 10:22:07 UTC 2019


commit f3d4cad64b20ed3c0ce0839a0e39b201b0222055
Author: Geoff Simmons <geoff at uplex.de>
Date:   Mon Mar 11 11:19:11 2019 +0100

    Polish the docs about VMOD std in the user release notes for March 2019.
    
    Lists of formatted function names in HTML are easier to read in
    bullet lists.
    
    Moved the part about std conversion functions to "Upgrading", since
    the old versions are deprecated. "Changes" links to it.

diff --git a/doc/sphinx/whats-new/changes-trunk.rst b/doc/sphinx/whats-new/changes-trunk.rst
index 3c43b22ad..4dbfd5f49 100644
--- a/doc/sphinx/whats-new/changes-trunk.rst
+++ b/doc/sphinx/whats-new/changes-trunk.rst
@@ -85,34 +85,13 @@ changed the ``builtin.vcl``.
 VMODs
 =====
 
-Added the function :ref:`vmod_directors.lookup`, only for use in
-``vcl_init`` or ``vcl_fini``.
+New type-conversion functions have been added to :ref:`vmod_std(3)`,
+and the previous conversion functions are now deprecated. See
+:ref:`whatsnew_upgrading_std_conversion_2019_03`.
 
-The type-conversion functions in :ref:`vmod_std(3)` have been reworked
-to make them more flexible and easier to use:
-:ref:`vmod_std.duration`, :ref:`vmod_std.bytes`,
-:ref:`vmod_std.integer`, :ref:`vmod_std.real` and :ref:`vmod_std.time`
-now also accept suitable numeral or quantitative arguments.
-
-These type-conversion functions should be fully backwards compatible,
-but the following differences should be noted:
-
-* The *fallback* is not required and more. A conversion failure in the
-  absense of a *fallback* argument will now trigger a VCL failure.
-
-* A VCL failure will also be triggered if no or more than one argument
-  (plus optional *fallback*) is given.
-
-* Conversion functions now only ever truncate if necessary (instead of
-  rounding).
-
-* :ref:`vmod_std.round` has been added for explicit rounding.
-
-The functions :ref:`vmod_std.real2integer`, :ref:`vmod_std.real2time`,
-:ref:`vmod_std.time2integer` and :ref:`vmod_std.time2real` are
-superseded by these changed and should thus be replaced by the above
-mentioned conversion functions. They will be removed in a future
-version of Varnish.
+The function :ref:`vmod_directors.lookup` has been added to
+:ref:`vmod_directors(3)`, only for use in ``vcl_init`` or
+``vcl_fini``.
 
 varnishlog(1), varnishncsa(1) and vsl(7)
 ========================================
diff --git a/doc/sphinx/whats-new/upgrading-trunk.rst b/doc/sphinx/whats-new/upgrading-trunk.rst
index 9eaa3b662..335b7f210 100644
--- a/doc/sphinx/whats-new/upgrading-trunk.rst
+++ b/doc/sphinx/whats-new/upgrading-trunk.rst
@@ -66,6 +66,45 @@ now.  These are:
 
 * ``vmod_dir`` -- use :ref:`ref_param_vmod_path` instead
 
+.. _whatsnew_upgrading_std_conversion_2019_03:
+
+Type conversion functions in VMOD std
+=====================================
+
+The type-conversion functions in :ref:`vmod_std(3)` have been reworked
+to make them more flexible and easier to use. These new functions now
+also accept suitable numeral or quantitative arguments.
+
+* :ref:`vmod_std.duration`
+* :ref:`vmod_std.bytes`
+* :ref:`vmod_std.integer`
+* :ref:`vmod_std.real`
+* :ref:`vmod_std.time`
+
+These type-conversion functions should be fully backwards compatible,
+but the following differences should be noted:
+
+* The *fallback* is not required any more. A conversion failure in the
+  absence of a *fallback* argument will now trigger a VCL failure.
+
+* A VCL failure will also be triggered if no or more than one argument
+  (plus optional *fallback*) is given.
+
+* Conversion functions now only ever truncate if necessary (instead of
+  rounding).
+
+* :ref:`vmod_std.round` has been added for explicit rounding.
+
+These functions are deprecated and should be replaced by the new
+conversion functions:
+
+* :ref:`vmod_std.real2integer`
+* :ref:`vmod_std.real2time`
+* :ref:`vmod_std.time2integer`
+* :ref:`vmod_std.time2real`
+
+They will be removed in a future version of Varnish.
+
 varnishadm and the CLI
 ======================
 


More information about the varnish-commit mailing list