[master] d6ef2cd Normalise help output
Federico G. Schwindt
fgsch at lodoss.net
Mon Jan 12 19:34:53 CET 2015
commit d6ef2cdbe63e730829012689d62b8b9b62c66437
Author: Federico G. Schwindt <fgsch at lodoss.net>
Date: Mon Jan 12 10:47:18 2015 +0000
Normalise help output
Remove extra newlines, add tabs and ending punctuation.
diff --git a/bin/varnishd/cache/cache_acceptor.c b/bin/varnishd/cache/cache_acceptor.c
index f178d10..d67ed8f 100644
--- a/bin/varnishd/cache/cache_acceptor.c
+++ b/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 }
};
diff --git a/bin/varnishd/cache/cache_backend_poll.c b/bin/varnishd/cache/cache_backend_poll.c
index 4773785..479872b 100644
--- a/bin/varnishd/cache/cache_backend_poll.c
+++ b/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 }
};
diff --git a/bin/varnishd/cache/cache_cli.c b/bin/varnishd/cache/cache_cli.c
index 9e1fa4e..c53d360 100644
--- a/bin/varnishd/cache/cache_cli.c
+++ b/bin/varnishd/cache/cache_cli.c
@@ -201,10 +201,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 }
};
diff --git a/bin/varnishd/cache/cache_fetch_proc.c b/bin/varnishd/cache/cache_fetch_proc.c
index 91bf0e1..fad6a2d 100644
--- a/bin/varnishd/cache/cache_fetch_proc.c
+++ b/bin/varnishd/cache/cache_fetch_proc.c
@@ -230,7 +230,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 }
};
diff --git a/bin/varnishd/cache/cache_main.c b/bin/varnishd/cache/cache_main.c
index 10bf5e9..cfce5cc 100644
--- a/bin/varnishd/cache/cache_main.c
+++ b/bin/varnishd/cache/cache_main.c
@@ -176,9 +176,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 }
};
diff --git a/bin/varnishd/cache/cache_vrt_vmod.c b/bin/varnishd/cache/cache_vrt_vmod.c
index 2c393b7..9d08437 100644
--- a/bin/varnishd/cache/cache_vrt_vmod.c
+++ b/bin/varnishd/cache/cache_vrt_vmod.c
@@ -183,7 +183,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 }
};
diff --git a/bin/varnishd/hash/hash_critbit.c b/bin/varnishd/hash/hash_critbit.c
index 78d5576..c4239b6 100644
--- a/bin/varnishd/hash/hash_critbit.c
+++ b/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 }
};
diff --git a/bin/varnishd/mgt/mgt_cli.c b/bin/varnishd/mgt/mgt_cli.c
index 21fecfb..8c16692 100644
--- a/bin/varnishd/mgt/mgt_cli.c
+++ b/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 }
};
diff --git a/bin/varnishd/storage/stevedore_mgt.c b/bin/varnishd/storage/stevedore_mgt.c
index 7a38171..109290f 100644
--- a/bin/varnishd/storage/stevedore_mgt.c
+++ b/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}
};
diff --git a/bin/varnishd/storage/storage_persistent.c b/bin/varnishd/storage/storage_persistent.c
index a4648fc..491ed62 100644
--- a/bin/varnishd/storage/storage_persistent.c
+++ b/bin/varnishd/storage/storage_persistent.c
@@ -668,12 +668,11 @@ 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"
+ "\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 }
};
diff --git a/include/vcli.h b/include/vcli.h
index 4a18c82..e6762f0 100644
--- a/include/vcli.h
+++ b/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
More information about the varnish-commit
mailing list