[master] bdf0c9f56 changes.rst: name vmod function / constructor / method RST xref like VCL
Nils Goroll
nils.goroll at uplex.de
Fri Sep 13 10:23:06 UTC 2019
commit bdf0c9f563179e487fbdd0d185ff4d05c91e2e19
Author: Nils Goroll <nils.goroll at uplex.de>
Date: Fri Sep 13 12:21:57 2019 +0200
changes.rst: name vmod function / constructor / method RST xref like VCL
Ref 904ceabf07c294983efcebfe1d614c2d2fd5cdda
diff --git a/doc/changes.rst b/doc/changes.rst
index b3923dce8..5a12b171e 100644
--- a/doc/changes.rst
+++ b/doc/changes.rst
@@ -46,8 +46,8 @@ NEXT (2019-09-15)
* Retired the ``BackendStart`` log tag - ``BackendOpen`` contains all
the information from it
-C APIs (for vmod and utility authors)
--------------------------------------
+APIs / VMODs
+------------
* ``WS_Reserve()`` is now deprecated and any use should trigger a
compiler warning. It is to be replaced by
@@ -66,6 +66,26 @@ C APIs (for vmod and utility authors)
We provide a script to help automate this change in the
``tools/coccinelle`` subdirectory of the source tree.
+* The RST references generated by ``vmodtool.py`` have been changed to
+ match better the VCL syntax to avoid overhead where references are
+ used. The new scheme for a vmod called *name* is:
+
+ * ``$Function``: *name*\ .\ *function*\ ()
+ * ``$Object`` constructor: *name*\ .\ *object*\ ()
+ * ``$Method``: x\ *object*\ .\ *method*\ ()
+
+ To illustrate, the old references::
+
+ :ref:`vmod_name.function`
+ :ref:`vmod_name.obj`
+ :ref:`vmod_name.obj.method`
+
+ now are renamed to::
+
+ :ref:`name.function()`
+ :ref:`name.obj()`
+ :ref:`xobj.method()`
+
================================
Varnish Cache 6.2.0 (2019-03-15)
================================
More information about the varnish-commit
mailing list