mirror of
https://github.com/systemd/systemd.git
synced 2024-12-14 20:54:02 +08:00
cmdline: for new tools avoid introduce new negative switches, and properly align --help texts
Negative switches are a bad un-normalized thing. We alerady have some,
but we should try harder to avoid intrdoucing new ones.
Hence, instead of adding two switches:
--foobar
--no-foobar
Let's instead use the syntax
--foobar
--foobar=yes
--foobar=no
Where the first two are equivalent. The boolean argument is parsed
following the usual rules.
Change all new negative switches this way.
This patch also properly aligns the --help table, so that single char
switches always get a column separate of the long switches.
This commit is contained in:
Lennart Poettering
parent
f9ffbca2fb
commit
dad29dff19
@ -1202,7 +1202,7 @@ static void help(void) {
|
||||
" services, which finished TIMESPAN earlier, than the\n"
|
||||
" latest in the branch. The unit of TIMESPAN is seconds\n"
|
||||
" unless specified with a different unit, i.e. 50ms\n"
|
||||
" --no-man Do not check for existence of man pages\n\n"
|
||||
" --man[=BOOL] Do [not] check for existence of man pages\n\n"
|
||||
"Commands:\n"
|
||||
" time Print time spent in the kernel before reaching userspace\n"
|
||||
" blame Print list of running units ordered by time to init\n"
|
||||
@ -1230,7 +1230,7 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
ARG_DOT_TO_PATTERN,
|
||||
ARG_FUZZ,
|
||||
ARG_NO_PAGER,
|
||||
ARG_NO_MAN,
|
||||
ARG_MAN,
|
||||
};
|
||||
|
||||
static const struct option options[] = {
|
||||
@ -1244,7 +1244,7 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
{ "to-pattern", required_argument, NULL, ARG_DOT_TO_PATTERN },
|
||||
{ "fuzz", required_argument, NULL, ARG_FUZZ },
|
||||
{ "no-pager", no_argument, NULL, ARG_NO_PAGER },
|
||||
{ "no-man", no_argument, NULL, ARG_NO_MAN },
|
||||
{ "man", optional_argument, NULL, ARG_MAN },
|
||||
{ "host", required_argument, NULL, 'H' },
|
||||
{ "machine", required_argument, NULL, 'M' },
|
||||
{}
|
||||
@ -1315,8 +1315,18 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
arg_host = optarg;
|
||||
break;
|
||||
|
||||
case ARG_NO_MAN:
|
||||
arg_man = false;
|
||||
case ARG_MAN:
|
||||
if (optarg) {
|
||||
r = parse_boolean(optarg);
|
||||
if (r < 0) {
|
||||
log_error("Failed to parse --man= argument.");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
arg_man = !!r;
|
||||
} else
|
||||
arg_man = true;
|
||||
|
||||
break;
|
||||
|
||||
case '?':
|
||||
|
||||
@ -1134,15 +1134,16 @@ static int parse_config(void) {
|
||||
static void help(void) {
|
||||
printf("%s [OPTIONS...] {FILE|-}...\n\n"
|
||||
"Write external journal events to journal file(s).\n\n"
|
||||
"Options:\n"
|
||||
" -h --help Show this help\n"
|
||||
" --version Show package version\n"
|
||||
" --url=URL Read events from systemd-journal-gatewayd at URL\n"
|
||||
" --getter=COMMAND Read events from the output of COMMAND\n"
|
||||
" --listen-raw=ADDR Listen for connections at ADDR\n"
|
||||
" --listen-http=ADDR Listen for HTTP connections at ADDR\n"
|
||||
" --listen-https=ADDR Listen for HTTPS connections at ADDR\n"
|
||||
" -o --output=FILE|DIR Write output to FILE or DIR/external-*.journal\n"
|
||||
" --[no-]compress Use XZ-compression in the output journal (default: yes)\n"
|
||||
" --[no-]seal Use Event sealing in the output journal (default: no)\n"
|
||||
" --compress[=BOOL] Use XZ-compression in the output journal (default: yes)\n"
|
||||
" --seal[=BOOL] Use Event sealing in the output journal (default: no)\n"
|
||||
" --key=FILENAME Specify key in PEM format (default:\n"
|
||||
" \"" PRIV_KEY_FILE "\")\n"
|
||||
" --cert=FILENAME Specify certificate in PEM format (default:\n"
|
||||
@ -1151,8 +1152,6 @@ static void help(void) {
|
||||
" \"" TRUST_FILE "\")\n"
|
||||
" --gnutls-log=CATEGORY...\n"
|
||||
" Specify a list of gnutls logging categories\n"
|
||||
" -h --help Show this help and exit\n"
|
||||
" --version Print version string and exit\n"
|
||||
"\n"
|
||||
"Note: file descriptors from sd_listen_fds() will be consumed, too.\n"
|
||||
, program_invocation_short_name);
|
||||
@ -1168,9 +1167,7 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
ARG_GETTER,
|
||||
ARG_SPLIT_MODE,
|
||||
ARG_COMPRESS,
|
||||
ARG_NO_COMPRESS,
|
||||
ARG_SEAL,
|
||||
ARG_NO_SEAL,
|
||||
ARG_KEY,
|
||||
ARG_CERT,
|
||||
ARG_TRUST,
|
||||
@ -1187,10 +1184,8 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
{ "listen-https", required_argument, NULL, ARG_LISTEN_HTTPS },
|
||||
{ "output", required_argument, NULL, 'o' },
|
||||
{ "split-mode", required_argument, NULL, ARG_SPLIT_MODE },
|
||||
{ "compress", no_argument, NULL, ARG_COMPRESS },
|
||||
{ "no-compress", no_argument, NULL, ARG_NO_COMPRESS },
|
||||
{ "seal", no_argument, NULL, ARG_SEAL },
|
||||
{ "no-seal", no_argument, NULL, ARG_NO_SEAL },
|
||||
{ "compress", optional_argument, NULL, ARG_COMPRESS },
|
||||
{ "seal", optional_argument, NULL, ARG_SEAL },
|
||||
{ "key", required_argument, NULL, ARG_KEY },
|
||||
{ "cert", required_argument, NULL, ARG_CERT },
|
||||
{ "trust", required_argument, NULL, ARG_TRUST },
|
||||
@ -1332,16 +1327,31 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
break;
|
||||
|
||||
case ARG_COMPRESS:
|
||||
if (optarg) {
|
||||
r = parse_boolean(optarg);
|
||||
if (r < 0) {
|
||||
log_error("Failed to parse --compress= parameter.");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
arg_compress = !!r;
|
||||
} else
|
||||
arg_compress = true;
|
||||
|
||||
break;
|
||||
case ARG_NO_COMPRESS:
|
||||
arg_compress = false;
|
||||
break;
|
||||
|
||||
case ARG_SEAL:
|
||||
if (optarg) {
|
||||
r = parse_boolean(optarg);
|
||||
if (r < 0) {
|
||||
log_error("Failed to parse --seal= parameter.");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
arg_seal = !!r;
|
||||
} else
|
||||
arg_seal = true;
|
||||
break;
|
||||
case ARG_NO_SEAL:
|
||||
arg_seal = false;
|
||||
|
||||
break;
|
||||
|
||||
case ARG_GNUTLS_LOG: {
|
||||
|
||||
@ -505,7 +505,8 @@ static int parse_config(void) {
|
||||
static void help(void) {
|
||||
printf("%s -u URL {FILE|-}...\n\n"
|
||||
"Upload journal events to a remote server.\n\n"
|
||||
"Options:\n"
|
||||
" -h --help Show this help\n"
|
||||
" --version Show package version\n"
|
||||
" -u --url=URL Upload to this address\n"
|
||||
" --key=FILENAME Specify key in PEM format\n"
|
||||
" --cert=FILENAME Specify certificate in PEM format\n"
|
||||
@ -518,7 +519,7 @@ static void help(void) {
|
||||
" --file=PATH Use this journal file\n"
|
||||
" --cursor=CURSOR Start at the specified cursor\n"
|
||||
" --after-cursor=CURSOR Start after the specified cursor\n"
|
||||
" --[no-]follow Do [not] wait for input\n"
|
||||
" --follow[=BOOL] Do [not] wait for input\n"
|
||||
" --save-state[=FILE] Save uploaded cursors (default \n"
|
||||
" " STATE_FILE ")\n"
|
||||
" -h --help Show this help and exit\n"
|
||||
@ -538,7 +539,6 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
ARG_CURSOR,
|
||||
ARG_AFTER_CURSOR,
|
||||
ARG_FOLLOW,
|
||||
ARG_NO_FOLLOW,
|
||||
ARG_SAVE_STATE,
|
||||
};
|
||||
|
||||
@ -557,8 +557,7 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
{ "file", required_argument, NULL, ARG_FILE },
|
||||
{ "cursor", required_argument, NULL, ARG_CURSOR },
|
||||
{ "after-cursor", required_argument, NULL, ARG_AFTER_CURSOR },
|
||||
{ "follow", no_argument, NULL, ARG_FOLLOW },
|
||||
{ "no-follow", no_argument, NULL, ARG_NO_FOLLOW },
|
||||
{ "follow", optional_argument, NULL, ARG_FOLLOW },
|
||||
{ "save-state", optional_argument, NULL, ARG_SAVE_STATE },
|
||||
{}
|
||||
};
|
||||
@ -675,11 +674,17 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
break;
|
||||
|
||||
case ARG_FOLLOW:
|
||||
arg_follow = true;
|
||||
break;
|
||||
if (optarg) {
|
||||
r = parse_boolean(optarg);
|
||||
if (r < 0) {
|
||||
log_error("Failed to parse --follow= parameter.");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
arg_follow = !!r;
|
||||
} else
|
||||
arg_follow = true;
|
||||
|
||||
case ARG_NO_FOLLOW:
|
||||
arg_follow = false;
|
||||
break;
|
||||
|
||||
case ARG_SAVE_STATE:
|
||||
|
||||
@ -466,14 +466,14 @@ static void help(void) {
|
||||
" -p --protocol=PROTOCOL Look via protocol\n"
|
||||
" -t --type=TYPE Query RR with DNS type\n"
|
||||
" -c --class=CLASS Query RR with DNS class\n"
|
||||
" --no-legend Do not print column headers\n"
|
||||
" --legend[=BOOL] Do [not] print column headers\n"
|
||||
, program_invocation_short_name);
|
||||
}
|
||||
|
||||
static int parse_argv(int argc, char *argv[]) {
|
||||
enum {
|
||||
ARG_VERSION = 0x100,
|
||||
ARG_NO_LEGEND,
|
||||
ARG_LEGEND,
|
||||
};
|
||||
|
||||
static const struct option options[] = {
|
||||
@ -481,7 +481,7 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
{ "version", no_argument, NULL, ARG_VERSION },
|
||||
{ "type", required_argument, NULL, 't' },
|
||||
{ "class", required_argument, NULL, 'c' },
|
||||
{ "no-legend", no_argument, NULL, ARG_NO_LEGEND },
|
||||
{ "legend", optional_argument, NULL, ARG_LEGEND },
|
||||
{ "protocol", required_argument, NULL, 'p' },
|
||||
{}
|
||||
};
|
||||
@ -548,7 +548,16 @@ static int parse_argv(int argc, char *argv[]) {
|
||||
|
||||
break;
|
||||
|
||||
case ARG_NO_LEGEND:
|
||||
case ARG_LEGEND:
|
||||
if (optarg) {
|
||||
r = parse_boolean(optarg);
|
||||
if (r < 0) {
|
||||
log_error("Failed to parse --legend= argument");
|
||||
return r;
|
||||
}
|
||||
|
||||
arg_legend = !!r;
|
||||
} else
|
||||
arg_legend = false;
|
||||
break;
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user