[master] 2a70f51 document probe window bits

Nils Goroll nils.goroll at uplex.de
Tue May 22 21:10:20 UTC 2018


commit 2a70f51ec14af3e62d6d61ec689011e83e5dd429
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Tue May 22 23:07:03 2018 +0200

    document probe window bits
    
    See comment on how we could auto-generate the documentation from the
    include - any less hackish ideas welcome

diff --git a/include/tbl/vsl_tags.h b/include/tbl/vsl_tags.h
index 88106bc..1bafbf1 100644
--- a/include/tbl/vsl_tags.h
+++ b/include/tbl/vsl_tags.h
@@ -370,6 +370,20 @@ SLTM(Hash, SLT_F_UNSAFE, "Value added to hash",
 	NODEF_NOTICE
 )
 
+/*
+ * Probe window bits:
+ *
+ * the documentation below could get auto-generated like so:
+ *
+ * ( echo '#define PROBE_BITS_DOC \' ; \
+ *   $CC -D 'BITMAP(n, c, t, b)="\t" #c ": " t "\n" \' \
+ *       -E ./include/tbl/backend_poll.h | grep -E '^"' ; \
+ *  echo '""' ) >./include/tbl/backend_poll_doc.h
+ *
+ * as this has a hackish feel to it, the documentation is included here as text
+ * until we find a better solution or the above is accepted
+ */
+
 SLTM(Backend_health, 0, "Backend health check",
 	"The result of a backend health probe.\n\n"
 	"The format is::\n\n"
@@ -385,6 +399,17 @@ SLTM(Backend_health, 0, "Backend health check",
 	"\t|  +---------------------- Status message\n"
 	"\t+------------------------- Backend name\n"
 	"\n"
+
+	"Probe window bits are::\n\n"
+	"\t" "'4'" ": " "Good IPv4" "\n"
+	"\t" "'6'" ": " "Good IPv6" "\n"
+	"\t" "'U'" ": " "Good UNIX" "\n"
+	"\t" "'x'" ": " "Error Xmit" "\n"
+	"\t" "'X'" ": " "Good Xmit" "\n"
+	"\t" "'r'" ": " "Error Recv" "\n"
+	"\t" "'R'" ": " "Good Recv" "\n"
+	"\t" "'H'" ": " "Happy" "\n"
+	"\n"
 )
 
 SLTM(VCL_Log, 0, "Log statement from VCL",


More information about the varnish-commit mailing list