Commit 4d6ca8c5 authored by Dridi Boukelmoune's avatar Dridi Boukelmoune

doc: A word on VSC_Arg()

And a quick note on the workspace API plus homework for later.
parent 377bb58d
......@@ -152,6 +152,9 @@ disruption.
Changes for developers and VMOD authors
=======================================
VMODs
~~~~~
The workspace API saw a number of changes in anticipation of a future
inclusion in VRT. The deprecated ``WS_Reserve()`` function was finally
removed, the functions ``WS_ReserveSize()`` and ``WS_ReserveAll()`` were
......@@ -169,10 +172,31 @@ new ``WS_ReservationSize()`` function.
The return value for ``WS_Printf()`` is now a constant string.
In general, accessing any field of ``struct ws`` is strongly discouraged
and if the workspace API doesn't satisfy all your needs please bring
that to our attention.
VMOD authors who would like to generate VCC files can now use the
``VARNISH_VMODS_GENERATED()`` macro from ``varnish.m4`` for autotools
builds.
libvarnishapi
~~~~~~~~~~~~~
There are three new VSC arguments that can be set with the ``VSC_Arg()``
function:
- ``'I'`` to include counters matching a glob pattern
- ``'X'`` to exclude counters matching a glob pattern
- ``'R'`` to include required counters regardless of ``'I'`` and ``'X'``
The ``'f'`` argument is now deprecated and emulated with ``'I'`` and ``'X'``.
Filtering with ``'f'`` used to check exclusions first and then inclusions,
they are all tested in order and the first to match determines the outcome.
The ``'R'`` argument takes precedence over regular filtering and can be used
to ensure that some counters are present regardless of user configuration.
**XXX changes concerning VRT, the public APIs, source code organization,
builds etc.**
......
......@@ -61,6 +61,9 @@ After::
}
}
TODO: a word on ``varnishstat -f`` being deprecated and ``-{I,X}`` being
order-sensitive.
VSL
===
......@@ -73,4 +76,9 @@ The new query would be::
varnishlog -q 'BackendClose[2] ~ www and BackendClose[3] eq recycle'
libvarnishapi
=============
TODO: a similar note as ``varnishstat -f`` for ``VSC_Arg('f')``.
*eof*
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment