[master] 817176c Issue a warning that $Event documentation isn't emitted in .RST

Poul-Henning Kamp phk at FreeBSD.org
Wed Dec 7 09:49:05 CET 2016


commit 817176c744a0fd355b1cc61579dadd1f2ea274e2
Author: Poul-Henning Kamp <phk at FreeBSD.org>
Date:   Wed Dec 7 08:45:28 2016 +0000

    Issue a warning that $Event documentation isn't emitted in .RST
    
    Closes #2155

diff --git a/lib/libvcc/vmodtool.py b/lib/libvcc/vmodtool.py
index 60415f2..8966c0a 100755
--- a/lib/libvcc/vmodtool.py
+++ b/lib/libvcc/vmodtool.py
@@ -465,6 +465,11 @@ class s_event(stanza):
 		self.vcc.contents.append(self)
 
 	def rstfile(self, fo, man):
+		if len(self.doc) != 0:
+			sys.stderr.write(
+				"NB: Not emitting .RST for $Event %s\n" %
+				self.event_func
+			)
 		return
 
 	def hfile(self, fo):
diff --git a/lib/libvmod_debug/vmod.vcc b/lib/libvmod_debug/vmod.vcc
index 204affd..ca61e45 100644
--- a/lib/libvmod_debug/vmod.vcc
+++ b/lib/libvmod_debug/vmod.vcc
@@ -35,6 +35,9 @@ of VMOD handling in Varnish.
 
 
 $Event event_function
+
+You are not supposed to be able to see this text in the .RST
+
 $Function VOID panic(STRING_LIST)
 
 Don't.



More information about the varnish-commit mailing list