[master] aadf302 Document the storage.<name>.* VCL variables.

Martin Blix Grydeland martin at varnish-software.com
Mon Jun 2 16:02:24 CEST 2014


commit aadf302e4b7d856070dbf92ab1e7a6571003812d
Author: Martin Blix Grydeland <martin at varnish-software.com>
Date:   Mon Jun 2 16:01:03 2014 +0200

    Document the storage.<name>.* VCL variables.
    
    Fixes: #1514

diff --git a/lib/libvcc/generate.py b/lib/libvcc/generate.py
index 75649db..a1fd2d7 100755
--- a/lib/libvcc/generate.py
+++ b/lib/libvcc/generate.py
@@ -596,9 +596,18 @@ aliases = [
 ]
 
 stv_variables = (
-	('free_space',	'BYTES',	"0."),
-	('used_space',	'BYTES',	"0."),
-	('happy',	'BOOL',		"0"),
+	('free_space',	'BYTES',	"0.", 'storage.<name>.free_space', """
+        Free space available in the named stevedore. Only available for
+        the malloc stevedore.
+        """),
+	('used_space',	'BYTES',	"0.", 'storage.<name>.used_space', """
+        Used space in the named stevedore. Only available for the malloc
+        stevedore.
+        """),
+	('happy',	'BOOL',		"0", 'storage.<name>.happy', """
+        Health status for the named stevedore. Not available in any of the
+        current stevedores.
+        """),
 )
 
 #######################################################################
@@ -1175,4 +1184,15 @@ for i in l:
 	for j in i[4].split("\n"):
 		fp_vclvar.write("\t%s\n" % j.strip())
 
+hdr="storage"
+fp_vclvar.write("\n" + hdr + "\n");
+fp_vclvar.write("~" * len(hdr) + "\n");
+for i in stv_variables:
+        fp_vclvar.write("\n" + i[3] + "\n\n")
+        fp_vclvar.write("\tType: " + i[1] + "\n\n")
+        fp_vclvar.write("\tReadable from: client, backend\n\n")
+        for j in i[4].split("\n"):
+                fp_vclvar.write("\t%s\n" % j.strip())
+
+
 fp_vclvar.close()



More information about the varnish-commit mailing list