[master] 37c13cd Write up the $Synopsis directive for vcc files in "Upgrading".

Geoff Simmons geoff at uplex.de
Mon Mar 12 18:31:08 UTC 2018

commit 37c13cde544b3f4ee2defc692713bf301286f77b
Author: Geoff Simmons <geoff at uplex.de>
Date:   Mon Mar 12 19:30:29 2018 +0100

    Write up the $Synopsis directive for vcc files in "Upgrading".

diff --git a/doc/sphinx/whats-new/upgrading-6.0.rst b/doc/sphinx/whats-new/upgrading-6.0.rst
index 685c184..3565eb0 100644
--- a/doc/sphinx/whats-new/upgrading-6.0.rst
+++ b/doc/sphinx/whats-new/upgrading-6.0.rst
@@ -538,7 +538,17 @@ Other changes
 * Changes for developers:
-  * XXX ...
+  * VMOD vcc sources may now include a directive ``$Synopsis`` whose
+    value may be ``auto`` or ``manual``, default ``auto``.
+    When ``$Synopsis`` is ``auto``, the vmodtool generates a more
+    comprehensive ``SYNOPSIS`` section in the documentation than in
+    previous versions -- an overview of the objects, methods and
+    functions in your VMOD, with their type signatures.
+    When ``$Synopsis`` is ``manual``, the ``SYNOPSIS`` is left out of
+    the generated docs altogether; so you can write the ``SYNOPSIS``
+    section yourself, if you prefer.
   * XXX ...

More information about the varnish-commit mailing list