[4.1] 92a4bde vut clients: consistently mark all <non-literal options>
PÃ¥l Hermunn Johansen
hermunn at varnish-software.com
Fri Sep 9 13:01:03 CEST 2016
commit 92a4bde32376844f0c6f966d3825c2ffb9815033
Author: Nils Goroll <nils.goroll at uplex.de>
Date: Mon Jul 25 14:24:21 2016 +0200
vut clients: consistently mark all <non-literal options>
In usage/documentation, mark those options with <> which are not a
literal string, but rather a placeholder for some value.
Conflicts:
bin/varnishstat/varnishstat_options.h
diff --git a/bin/varnishlog/varnishlog_options.h b/bin/varnishlog/varnishlog_options.h
index 7b23a6c..197b8c2 100644
--- a/bin/varnishlog/varnishlog_options.h
+++ b/bin/varnishlog/varnishlog_options.h
@@ -43,7 +43,7 @@
)
#define LOG_OPT_w \
- VOPT("w:", "[-w filename]", "Output filename", \
+ VOPT("w:", "[-w <filename>]", "Output filename", \
"Redirect output to file. The file will be overwritten" \
" unless the -a option was specified. If the application" \
" receives a SIGHUP in daemon mode the file will be " \
diff --git a/bin/varnishncsa/varnishncsa_options.h b/bin/varnishncsa/varnishncsa_options.h
index 0f12e89..e47d696 100644
--- a/bin/varnishncsa/varnishncsa_options.h
+++ b/bin/varnishncsa/varnishncsa_options.h
@@ -36,12 +36,12 @@
)
#define NCSA_OPT_F \
- VOPT("F:", "[-F format]", "Set output format", \
+ VOPT("F:", "[-F <format>]", "Set output format", \
"Set the output log format string." \
)
#define NCSA_OPT_f \
- VOPT("f:", "[-f formatfile]", "Read output format from file", \
+ VOPT("f:", "[-f <formatfile>]", "Read output format from file", \
"Read output format from a file. Will read a single line" \
" from the specified file, and use that line as the" \
" format." \
@@ -55,7 +55,7 @@
)
#define NCSA_OPT_w \
- VOPT("w:", "[-w filename]", "Output filename", \
+ VOPT("w:", "[-w <filename>]", "Output filename", \
"Redirect output to file. The file will be overwritten" \
" unless the -a option was specified. If the application" \
" receives a SIGHUP in daemon mode the file will be" \
diff --git a/bin/varnishstat/varnishstat.c b/bin/varnishstat/varnishstat.c
index c7746d6..d9f996d 100644
--- a/bin/varnishstat/varnishstat.c
+++ b/bin/varnishstat/varnishstat.c
@@ -254,7 +254,7 @@ usage(void)
"[-1lV] [-f field] [-t seconds|<off>] "
VSC_n_USAGE "\n");
fprintf(stderr, FMT, "-1", "Print the statistics to stdout.");
- fprintf(stderr, FMT, "-f field", "Field inclusion glob");
+ fprintf(stderr, FMT, "-f <glob>", "Field inclusion glob");
fprintf(stderr, FMT, "",
"If it starts with '^' it is used as an exclusion list.");
fprintf(stderr, FMT, "-l",
diff --git a/bin/varnishtop/varnishtop_options.h b/bin/varnishtop/varnishtop_options.h
index b2fc39a..f87a5f4 100644
--- a/bin/varnishtop/varnishtop_options.h
+++ b/bin/varnishtop/varnishtop_options.h
@@ -45,7 +45,7 @@
)
#define TOP_OPT_p \
- VOPT("p:", "[-p period]", "Sampling period", \
+ VOPT("p:", "[-p <period>]", "Sampling period", \
"Specified the number of seconds to measure over, the" \
" default is 60 seconds. The first number in the list is" \
" the average number of requests seen over this time" \
diff --git a/include/vapi/vapi_options.h b/include/vapi/vapi_options.h
index 46f826f..98b838b 100644
--- a/include/vapi/vapi_options.h
+++ b/include/vapi/vapi_options.h
@@ -51,7 +51,7 @@
)
#define VSL_OPT_i \
- VOPT("i:", "[-i taglist]", "Include tags", \
+ VOPT("i:", "[-i <taglist>]", "Include tags", \
"Include log records of these tags in output. Taglist is" \
" a comma-separated list of tag globs. Multiple -i" \
" options may be given.\n" \
@@ -69,7 +69,7 @@
)
#define VSL_OPT_L \
- VOPT("L:", "[-L limit]", "Incomplete transaction limit", \
+ VOPT("L:", "[-L <limit>]", "Incomplete transaction limit", \
"Sets the upper limit of incomplete transactions kept" \
" before the oldest transaction is force completed. A" \
" warning record is synthesized when this happens. This" \
@@ -78,7 +78,7 @@
)
#define VSL_OPT_T \
- VOPT("T:", "[-T seconds]", "Transaction end timeout", \
+ VOPT("T:", "[-T <seconds>]", "Transaction end timeout", \
"Sets the transaction timeout in seconds. This defines the" \
" maximum number of seconds elapsed between a Begin tag" \
" and the End tag. If the timeout expires, a warning" \
@@ -94,7 +94,7 @@
)
#define VSL_OPT_x \
- VOPT("x:", "[-x taglist]", "Exclude tags", \
+ VOPT("x:", "[-x <taglist>]", "Exclude tags", \
"Exclude log records of these tags in output. Taglist is" \
" a comma-separated list of tag globs. Multiple -x" \
" options may be given.\n" \
diff --git a/include/vut_options.h b/include/vut_options.h
index 16258b8..50881cd 100644
--- a/include/vut_options.h
+++ b/include/vut_options.h
@@ -51,35 +51,35 @@
)
#define VUT_OPT_k \
- VOPT("k:", "[-k num]", "Limit transactions", \
+ VOPT("k:", "[-k <num>]", "Limit transactions", \
"Process this number of matching log transactions before" \
" exiting." \
)
#define VUT_OPT_n \
- VOPT("n:", "[-n name]", "Varnish instance name", \
+ VOPT("n:", "[-n <name>]", "Varnish instance name", \
"Specify the name of the varnishd instance to get logs" \
" from. If -n is not specified, the host name is used." \
)
#define VUT_OPT_N \
- VOPT("N:", "[-N filename]", "VSM filename", \
+ VOPT("N:", "[-N <filename>]", "VSM filename", \
"Specify the filename of a stale VSM instance. When using" \
" this option the abandonment checking is disabled." \
)
#define VUT_OPT_P \
- VOPT("P:", "[-P file]", "PID file", \
+ VOPT("P:", "[-P <file>]", "PID file", \
"Write the process' PID to the specified file." \
)
#define VUT_OPT_q \
- VOPT("q:", "[-q query]", "VSL query", \
+ VOPT("q:", "[-q <query>]", "VSL query", \
"Specifies the VSL query to use." \
)
#define VUT_OPT_r \
- VOPT("r:", "[-r filename]", "Binary file input", \
+ VOPT("r:", "[-r <filename>]", "Binary file input", \
"Read log in binary file format from this file. The file" \
" can be created with ``varnishlog -w filename``." \
)
More information about the varnish-commit
mailing list