diff options
author | Alex Wang <alexw@nicira.com> | 2014-10-17 11:11:36 -0700 |
---|---|---|
committer | Alex Wang <alexw@nicira.com> | 2014-10-28 18:35:23 -0700 |
commit | 91a11f5b19a370958d9f7b1827f2861d9dae16d8 (patch) | |
tree | 61bf58d6b498f4ee2331b10111a7f896b59ffefb | |
parent | 66fa2c884fe9aee48217a76189a148bf215e0f5d (diff) | |
download | openvswitch-91a11f5b19a370958d9f7b1827f2861d9dae16d8.tar.gz |
ovs-appctl: Rename 'help' to 'list-commands'.
Having 'ovs-appctl help' and 'ovs-appctl --help' print different
output is confusing. This commit renames the 'help' to 'list-commands'.
Also, future patches will add the 'list-commands' to other ovs-*
commands, and the output will be used by bash command-line completion
script.
Signed-off-by: Alex Wang <alexw@nicira.com>
Acked-by: Ben Pfaff <blp@nicira.com>
-rw-r--r-- | lib/unixctl.c | 9 | ||||
-rw-r--r-- | tests/unixctl-py.at | 6 | ||||
-rw-r--r-- | utilities/ovs-appctl.8.in | 2 | ||||
-rw-r--r-- | utilities/ovs-appctl.c | 2 |
4 files changed, 10 insertions, 9 deletions
diff --git a/lib/unixctl.c b/lib/unixctl.c index 876c22627..76dc933f8 100644 --- a/lib/unixctl.c +++ b/lib/unixctl.c @@ -63,8 +63,8 @@ static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 5); static struct shash commands = SHASH_INITIALIZER(&commands); static void -unixctl_help(struct unixctl_conn *conn, int argc OVS_UNUSED, - const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED) +unixctl_list_commands(struct unixctl_conn *conn, int argc OVS_UNUSED, + const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED) { struct ds ds = DS_EMPTY_INITIALIZER; const struct shash_node **nodes = shash_sort(&commands); @@ -93,7 +93,7 @@ unixctl_version(struct unixctl_conn *conn, int argc OVS_UNUSED, /* Registers a unixctl command with the given 'name'. 'usage' describes the * arguments to the command; it is used only for presentation to the user in - * "help" output. + * "list-commands" output. * * 'cb' is called when the command is received. It is passed an array * containing the command name and arguments, plus a copy of 'aux'. Normally @@ -243,7 +243,8 @@ unixctl_server_create(const char *path, struct unixctl_server **serverp) goto exit; } - unixctl_command_register("help", "", 0, 0, unixctl_help, NULL); + unixctl_command_register("list-commands", "", 0, 0, unixctl_list_commands, + NULL); unixctl_command_register("version", "", 0, 0, unixctl_version, NULL); server = xmalloc(sizeof *server); diff --git a/tests/unixctl-py.at b/tests/unixctl-py.at index b54d4091f..2fb7ee902 100644 --- a/tests/unixctl-py.at +++ b/tests/unixctl-py.at @@ -14,16 +14,16 @@ AT_CHECK([PYAPPCTL -t ovsdb-server exit], [0], []) OVS_WAIT_WHILE([test -s ovsdb-server.pid]) AT_CLEANUP -AT_SETUP([unixctl ovs-vswitchd help - Python]) +AT_SETUP([unixctl ovs-vswitchd list-commands - Python]) AT_SKIP_IF([test $HAVE_PYTHON = no]) OVS_VSWITCHD_START -AT_CHECK([APPCTL help], [0], [stdout]) +AT_CHECK([APPCTL list-commands], [0], [stdout]) AT_CHECK([head -1 stdout], [0], [dnl The available commands are: ]) mv stdout expout -AT_CHECK([PYAPPCTL help], [0], [expout]) +AT_CHECK([PYAPPCTL list-commands], [0], [expout]) OVS_VSWITCHD_STOP AT_CLEANUP diff --git a/utilities/ovs-appctl.8.in b/utilities/ovs-appctl.8.in index 440853aef..247300b3f 100644 --- a/utilities/ovs-appctl.8.in +++ b/utilities/ovs-appctl.8.in @@ -73,7 +73,7 @@ Note that these commands are different from the \fB\-\-help\fR and \fB\-\-version\fR options that return information about the \fBovs\-appctl\fR utility itself. . -.IP "\fBhelp\fR" +.IP "\fBlist-commands\fR" Lists the commands supported by the target. . .IP "\fBversion\fR" diff --git a/utilities/ovs-appctl.c b/utilities/ovs-appctl.c index 3d32cbd61..943efc3b1 100644 --- a/utilities/ovs-appctl.c +++ b/utilities/ovs-appctl.c @@ -89,7 +89,7 @@ usage: %s [TARGET] COMMAND [ARG...]\n\ Targets:\n\ -t, --target=TARGET pidfile or socket to contact\n\ Common commands:\n\ - help List commands supported by the target\n\ + list-commands List commands supported by the target\n\ version Print version of the target\n\ vlog/list List current logging levels\n\ vlog/set [SPEC]\n\ |