Normalise help output

Remove extra newlines, add tabs and ending punctuation.

Conflicts:
	bin/varnishd/storage/storage_persistent.c

bin/varnishd/cache/cache_acceptor.c

@@ -460,9 +460,8 @@ ccf_listen_address(struct cli *cli, const char * const *av, void *priv)
 
 static struct cli_proto vca_cmds[] = {
 	{ CLI_SERVER_START,	"i", ccf_start },
-	{ "debug.listen_address",
-	    "debug.listen_address",
-	    "Report the actual listen address\n", 0, 0,
+	{ "debug.listen_address", "debug.listen_address",
+	    "\tReport the actual listen address.", 0, 0,
 	    "d", ccf_listen_address, NULL },
 	{ NULL }
 };

bin/varnishd/cache/cache_backend_poll.c

@@ -430,7 +430,7 @@ vbp_health(struct cli *cli, const char * const *av, void *priv)
 
 static struct cli_proto debug_cmds[] = {
 	{ "debug.health", "debug.health",
-		"\tDump backend health stuff\n",
+		"\tDump backend health information.",
 		0, 0, "d", vbp_health },
 	{ NULL }
 };

bin/varnishd/cache/cache_cli.c

@@ -223,10 +223,10 @@ static struct cli_proto master_cmds[] = {
 	{ CLI_PING,		"i", VCLS_func_ping },
 	{ CLI_HELP,             "i", VCLS_func_help },
 	{ "debug.sizeof", "debug.sizeof",
-		"\tDump sizeof various data structures\n",
+		"\tDump sizeof various data structures.",
 		0, 0, "d", cli_debug_sizeof },
 	{ "debug.panic.worker", "debug.panic.worker",
-		"\tPanic the worker process.\n",
+		"\tPanic the worker process.",
 		0, 0, "d", ccf_panic },
 	{ NULL }
 };

bin/varnishd/cache/cache_fetch_proc.c

@@ -286,7 +286,7 @@ debug_fragfetch(struct cli *cli, const char * const *av, void *priv)
 
 static struct cli_proto debug_cmds[] = {
 	{ "debug.fragfetch", "debug.fragfetch",
-		"\tEnable fetch fragmentation\n", 1, 1, "d", debug_fragfetch },
+		"\tEnable fetch fragmentation.", 1, 1, "d", debug_fragfetch },
 	{ NULL }
 };
 

bin/varnishd/cache/cache_main.c

@@ -170,9 +170,9 @@ cli_debug_srandom(struct cli *cli, const char * const *av, void *priv)
 
 static struct cli_proto debug_cmds[] = {
 	{ "debug.xid", "debug.xid",
-		"\tExamine or set XID\n", 0, 1, "d", cli_debug_xid },
+		"\tExamine or set XID.", 0, 1, "d", cli_debug_xid },
 	{ "debug.srandom", "debug.srandom",
-		"\tSeed the random(3) function\n", 0, 1, "d",
+		"\tSeed the random(3) function.", 0, 1, "d",
 		cli_debug_srandom },
 	{ NULL }
 };

bin/varnishd/cache/cache_vrt_vmod.c

@@ -179,7 +179,7 @@ ccf_debug_vmod(struct cli *cli, const char * const *av, void *priv)
 }
 
 static struct cli_proto vcl_cmds[] = {
-	{ "debug.vmod", "debug.vmod", "show loaded vmods", 0, 0,
+	{ "debug.vmod", "debug.vmod", "\tShow loaded vmods.", 0, 0,
 		"d", ccf_debug_vmod },
 	{ NULL }
 };

bin/varnishd/hash/hash_critbit.c

@@ -343,7 +343,7 @@ hcb_dump(struct cli *cli, const char * const *av, void *priv)
 }
 
 static struct cli_proto hcb_cmds[] = {
-	{ "hcb.dump", "hcb.dump", "dump HCB tree\n", 0, 0, "d", hcb_dump },
+	{ "hcb.dump", "hcb.dump", "\tDump HCB tree.", 0, 0, "d", hcb_dump },
 	{ NULL }
 };
 

bin/varnishd/mgt/mgt_cli.c

@@ -120,7 +120,7 @@ mcf_panic(struct cli *cli, const char * const *av, void *priv)
 
 static struct cli_proto cli_debug[] = {
 	{ "debug.panic.master", "debug.panic.master",
-		"\tPanic the master process.\n",
+		"\tPanic the master process.",
 		0, 0, "d", mcf_panic, NULL},
 	{ NULL }
 };

bin/varnishd/storage/stevedore_mgt.c

@@ -70,7 +70,7 @@ stv_cli_list(struct cli *cli, const char * const *av, void *priv)
 /*--------------------------------------------------------------------*/
 
 struct cli_proto cli_stv[] = {
-	{ "storage.list", "storage.list", "List storage devices\n",
+	{ "storage.list", "storage.list", "\tList storage devices.",
 	    0, 0, "", stv_cli_list },
 	{ NULL}
 };

bin/varnishd/storage/storage_persistent.c

@@ -670,14 +670,13 @@ debug_persistent(struct cli *cli, const char * const * av, void *priv)
 }
 
 static struct cli_proto debug_cmds[] = {
-        { "debug.persistent", "debug.persistent",
-                "Persistent debugging magic:\n"
-		"\tdebug.persistent [stevedore [cmd]]\n"
+	{ "debug.persistent", "debug.persistent",
+		"Persistent debugging magic:\n"
+		"\tdebug.persistent [<stevedore> [<cmd>]]\n"
 		"With no cmd arg, a summary of the silo is returned.\n"
 		"Possible commands:\n"
 		"\tsync\tClose current segment, open a new one\n"
-		"\tdump\tinclude objcores in silo summary\n"
-		"",
+		"\tdump\tinclude objcores in silo summary",
 		0, 2, "d", debug_persistent },
         { NULL }
 };

include/vcli.h

@@ -122,7 +122,7 @@
 #define CLI_SERVER_STOP							\
 	"stop",								\
 	"stop",								\
-	"\tStop the Varnish cache process",				\
+	"\tStop the Varnish cache process.",				\
 	0, 0
 
 #define CLI_SERVER_START						\
@@ -133,20 +133,20 @@
 
 #define CLI_PING							\
 	"ping",								\
-	"ping [timestamp]",						\
-	"\tKeep connection alive",					\
+	"ping [<timestamp>]",						\
+	"\tKeep connection alive.",					\
 	0, 1
 
 #define CLI_HELP							\
 	"help",								\
-	"help [command]",						\
-	"\tShow command/protocol help",					\
+	"help [<command>]",						\
+	"\tShow command/protocol help.",				\
 	0, 1
 
 #define CLI_QUIT							\
 	"quit",								\
 	"quit",								\
-	"\tClose connection",						\
+	"\tClose connection.",						\
 	0, 0
 
 #define CLI_SERVER_STATUS						\
@@ -163,7 +163,7 @@
 
 #define CLI_AUTH							\
 	"auth",								\
-	"auth response",						\
+	"auth <response>",						\
 	"\tAuthenticate.",						\
 	1, 1