[master] 8c91e49d1 More documentation on automade VSCs
Dridi Boukelmoune
dridi.boukelmoune at gmail.com
Tue Mar 3 11:03:07 UTC 2020
commit 8c91e49d1a516d86a1b84ac990c83c8d8cb3aa77
Author: Dridi Boukelmoune <dridi.boukelmoune at gmail.com>
Date: Tue Mar 3 11:59:30 2020 +0100
More documentation on automade VSCs
diff --git a/varnish.m4 b/varnish.m4
index 1c10e7659..2ede52bfc 100644
--- a/varnish.m4
+++ b/varnish.m4
@@ -1,4 +1,4 @@
-# Copyright (c) 2016-2018 Varnish Software AS
+# Copyright (c) 2016-2020 Varnish Software AS
# All rights reserved.
#
# Author: Dridi Boukelmoune <dridi.boukelmoune at gmail.com>
@@ -438,7 +438,7 @@ clean-vsc-$1:
# @BUILD_VSC_BAR@
#
# They take care of turning foo.vsc and bar.vsc into C code and RST
-# documentation.
+# documentation. Now let's imagine a vmod_baz uses the counters foo.
#
# Just like the vcc_*_if.[ch] files, you need to manually add the generated
# sources to the appropriate VMODs:
@@ -449,9 +449,14 @@ clean-vsc-$1:
# VSC_foo.c \
# VSC_foo.h
#
+# Don't forget to add foo.vsc and bar.vsc to EXTRA_DIST.
+#
# You can then include the counters documentation somewhere in the VMOD's
# VCC descriptor:
#
+# COUNTERS
+# ========
+#
# .. include:: VSC_foo.rst
#
# Doing so, you can add the generated RST as a dependency of the manual in
More information about the varnish-commit
mailing list