[master] 25f38bd54 document vcl.list output change

Nils Goroll nils.goroll at uplex.de
Wed Feb 20 08:41:07 UTC 2019


commit 25f38bd54f59868d41af53a5ae5388544c892aba
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Wed Feb 20 09:29:19 2019 +0100

    document vcl.list output change
    
    Ref 45239c2413098201a9c32e9fad597e352d694205

diff --git a/doc/changes.rst b/doc/changes.rst
index ce2bd46ae..6a88d45d2 100644
--- a/doc/changes.rst
+++ b/doc/changes.rst
@@ -67,6 +67,18 @@ Varnish Cache trunk (ongoing)
 * The undocumented ``-v`` option to the ``backend.list`` cli command
   has been removed
 
+* Changed the formatting of the ``vcl.list`` command from::
+
+    status	state/temperature	busy	name	[labelinfo]
+
+  to::
+
+    status	state	temperature	busy	name	[<-|->]	[info]
+
+  Column width is now dynamic.
+
+  See varnish-cli(7) for details on the field values (which remain unchanged).
+
 * The ban facility has been extended by bans access to obj.ttl,
   obj.age, obj.grace and obj.keep and additional inequality operators.
 
diff --git a/include/tbl/cli_cmds.h b/include/tbl/cli_cmds.h
index 0492aa714..5350a7194 100644
--- a/include/tbl/cli_cmds.h
+++ b/include/tbl/cli_cmds.h
@@ -107,7 +107,17 @@ CLI_CMD(VCL_LIST,
 	"vcl.list",
 	"vcl.list [-j]",
 	"List all loaded configuration.",
-	"  ``-j`` specifies JSON output.",
+	"  Unless ``-j`` is specified for JSON output, "
+	" the output format is five or seven columns of dynamic width, "
+	" separated by white space with the fields:\n\n"
+	"  * status: active, available or discarded\n\n"
+	"  * state: label, cold, warm, or auto\n\n"
+	"  * temperature: init, cold, warm, busy or cooling\n\n"
+	"  * busy: number of references to this vcl (integer)\n\n"
+	"  * name: the name given to this vcl or label\n\n"
+	"  * [ ``<-`` | ``->`` ] and label info last two fields)\n\n"
+	"    * ``->`` <vcl> : label \"points to\" the named <vcl>\n\n"
+	"    * ``<-`` (<n> label[s]): the vcl has <n> label(s)\n\n",
 	0, 0
 )
 


More information about the varnish-commit mailing list