[master] 30c88b2 Update docs after recent changes

Federico G. Schwindt fgsch at lodoss.net
Tue Mar 10 13:26:42 CET 2015


commit 30c88b252fe31aa4125a2194b98f22fad81a4580
Author: Federico G. Schwindt <fgsch at lodoss.net>
Date:   Tue Mar 10 12:24:16 2015 +0000

    Update docs after recent changes
    
    A few things still remaining.

diff --git a/bin/varnishd/cache/cache_backend_cfg.c b/bin/varnishd/cache/cache_backend_cfg.c
index e612982..08b58d3 100644
--- a/bin/varnishd/cache/cache_backend_cfg.c
+++ b/bin/varnishd/cache/cache_backend_cfg.c
@@ -296,7 +296,7 @@ cli_backend_set_health(struct cli *cli, const char * const *av, void *priv)
 /*---------------------------------------------------------------------*/
 
 static struct cli_proto backend_cmds[] = {
-	{ "backend.list", "backend.list [<backend_expression>]",
+	{ "backend.list", "backend.list [-p] [<backend_expression>]",
 	    "\tList backends.",
 	    0, 2, "", cli_backend_list },
 	{ "backend.set_health",
diff --git a/doc/sphinx/reference/varnish-cli.rst b/doc/sphinx/reference/varnish-cli.rst
index d6df5e3..549f739 100644
--- a/doc/sphinx/reference/varnish-cli.rst
+++ b/doc/sphinx/reference/varnish-cli.rst
@@ -97,13 +97,13 @@ start
 stop
   Stop the Varnish cache process.
 
-vcl.load <configname> <filename>
+vcl.load <configname> <filename> [auto|cold|warm]
   Compile and load the VCL file under the name provided.
 
-vcl.inline <configname> <quoted_VCLstring>
+vcl.inline <configname> <quoted_VCLstring> [auto|cold|warm]
   Compile and load the VCL data under the name provided.
 
-vcl.use <configname>
+vcl.use <configname> [auto|cold|warm]
   Switch to the named configuration immediately.
 
 vcl.discard <configname>
@@ -130,7 +130,7 @@ panic.clear
 storage.list
   List storage devices.
 
-backend.list [<backend_expression>]
+backend.list [-p] [<backend_expression>]
   List backends.
 
 backend.set_health <backend_expression> <state>
@@ -138,7 +138,7 @@ backend.set_health <backend_expression> <state>
   State is any of auto, healthy or sick values.
 
 ban <field> <operator> <arg> [&& <field> <oper> <arg> ...]
-  All objects where the all the conditions match will be marked obsolete.
+  Mark obsolete all objects where all the conditions match.
 
 ban.list
   List the active bans.
diff --git a/include/vcli.h b/include/vcli.h
index bd5d726..32d3e70 100644
--- a/include/vcli.h
+++ b/include/vcli.h
@@ -47,9 +47,8 @@
 
 #define CLI_BAN								\
 	"ban",								\
-	"ban <field> <operator> <arg> [&& <field> <oper> <arg>]...",	\
-	"\tAll objects where the all the conditions match will be "	\
-	    "marked obsolete.",						\
+	"ban <field> <operator> <arg> [&& <field> <oper> <arg> ...]",	\
+	"\tMark obsolete all objects where all the conditions match.",	\
 	3, UINT_MAX
 
 #define CLI_BAN_LIST							\
@@ -60,19 +59,19 @@
 
 #define CLI_VCL_LOAD							\
 	"vcl.load",							\
-	"vcl.load <configname> <filename> [*auto,cold,warm]",		\
+	"vcl.load <configname> <filename> [auto|cold|warm]",		\
 	"\tCompile and load the VCL file under the name provided.",	\
 	2, 3
 
 #define CLI_VCL_INLINE							\
 	"vcl.inline",							\
-	"vcl.inline <configname> <quoted_VCLstring> [*auto,cold,warm]",	\
+	"vcl.inline <configname> <quoted_VCLstring> [auto|cold|warm]",	\
 	"\tCompile and load the VCL data under the name provided.",	\
 	2, 3
 
 #define CLI_VCL_STATE							\
 	"vcl.state",							\
-	"vcl.state <configname> [auto,cold,warm]",			\
+	"vcl.state <configname> [auto|cold|warm]",			\
 	"\tForce the state of the named configuration.",		\
 	2, 2
 



More information about the varnish-commit mailing list