[master] 6286ddd document vcc optional arguments in changelog

Nils Goroll nils.goroll at uplex.de
Thu Mar 15 09:54:07 UTC 2018

commit 6286ddd28fc729a7349875832a7e66525c57e582
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Thu Mar 15 10:53:07 2018 +0100

    document vcc optional arguments in changelog

diff --git a/doc/sphinx/whats-new/upgrading-6.0.rst b/doc/sphinx/whats-new/upgrading-6.0.rst
index 4dbc4ae..cf2af34 100644
--- a/doc/sphinx/whats-new/upgrading-6.0.rst
+++ b/doc/sphinx/whats-new/upgrading-6.0.rst
@@ -866,4 +866,22 @@ Other changes
     the generated docs altogether; so you can write the ``SYNOPSIS``
     section yourself, if you prefer.
+  * Support for a new declaration of optional arguments in vcc files
+    has been added: ``[ argname ]`` can be used to mark *argname* as
+    optional.
+    If this declaration is used for any argument, _all_ user arguments
+    and ``PRIV_*`` pointers (no object pointers) to the respective
+    function/method will be passed in a ``struct`` *funcname*\
+    ``_arg`` specific to this function which contains the arguments by
+    their name (or the name ``arg``\ *n* for unnamed arguments, *n*
+    being the argument position starting with 1) plus ``valid_``\
+    *argname* members for optional arguments which are being set to
+    non-zero iff the respective *argname* was provided.
+    Argument presence is determined at VCC time, so it is not possible
+    to pass an unset argument from another function call.

More information about the varnish-commit mailing list