[master] 4356e2bf3 Sync VSC documentation with reality in varnish.m4

Dridi Boukelmoune dridi.boukelmoune at gmail.com
Thu Feb 27 08:39:07 UTC 2020


commit 4356e2bf3b687f14af73840958e1d0c29c4b6729
Author: Dridi Boukelmoune <dridi.boukelmoune at gmail.com>
Date:   Thu Feb 27 09:36:38 2020 +0100

    Sync VSC documentation with reality in varnish.m4
    
    This was documented following the naming convention in tree, but
    implemented differently. In order not to change the behavior, only
    the documentation is updated.
    
    Closes #3232

diff --git a/varnish.m4 b/varnish.m4
index 36e24188d..1c10e7659 100644
--- a/varnish.m4
+++ b/varnish.m4
@@ -437,8 +437,8 @@ clean-vsc-$1:
 #     @BUILD_VSC_FOO@
 #     @BUILD_VSC_BAR@
 #
-# They take care of turning VSC_foo.vsc and VCS_bar.vsc into C code and
-# RST documentation.
+# They take care of turning foo.vsc and bar.vsc into C code and RST
+# documentation.
 #
 # Just like the vcc_*_if.[ch] files, you need to manually add the generated
 # sources to the appropriate VMODs:
@@ -454,6 +454,11 @@ clean-vsc-$1:
 #
 #     .. include:: VSC_foo.rst
 #
+# Doing so, you can add the generated RST as a dependency of the manual in
+# Makefile.am:
+#
+#     vmod_baz.3: VSC_foo.rst
+#
 # That should be all you need to do to start implementing custom counters.
 #
 AC_DEFUN([VARNISH_COUNTERS], [


More information about the varnish-commit mailing list