diff options
| author | Mark Michelson <mmichels@redhat.com> | 2018-02-26 14:04:02 -0600 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2018-02-26 14:19:56 -0800 |
| commit | 8519ea87d7b84166a02d8f3f25c91a2ff7d5fe57 (patch) | |
| tree | c9f42eb8bdac4cbff8ed4d774646076190fb6018 /lib/db-ctl-base.h | |
| parent | 2696bcb1205837b50cdf4f5402926efa8753f7f6 (diff) | |
| download | openvswitch-8519ea87d7b84166a02d8f3f25c91a2ff7d5fe57.tar.gz | |
Refer to database manpages in *ctl manpages
The ovn-nbctl, ovn-sbctl, and ovs-vsctl manpages are inconsistent in
their "Database Commands" section when it comes to referring to what
database tables exist. This commit amends this by making each *ctl
manpage reference the corresponding database manpage instead.
To aid in having a more handy list, the --help text of ovn-nbctl,
ovn-sbctl, and ovs-vsctl have been modified to list the available
tables. This is also referenced in the manpages for those applications.
Signed-off-by: Mark Michelson <mmichels@redhat.com>
Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'lib/db-ctl-base.h')
| -rw-r--r-- | lib/db-ctl-base.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/lib/db-ctl-base.h b/lib/db-ctl-base.h index 81f0d0b27..a2f91abfb 100644 --- a/lib/db-ctl-base.h +++ b/lib/db-ctl-base.h @@ -51,13 +51,11 @@ struct cmd_show_table; /* ctl_init() figures out the number of tables on its own and flags an error if * 'ctl_classes' was defined with the wrong number of elements. */ -#define ctl_init(idl_classes, ctl_classes, cmd_show_table, ctl_exit_func) \ - (BUILD_ASSERT(ARRAY_SIZE(idl_classes) == ARRAY_SIZE(ctl_classes)), \ - ctl_init__(idl_classes, ctl_classes, ARRAY_SIZE(idl_classes), \ - cmd_show_table, ctl_exit_func)) -void ctl_init__(const struct ovsdb_idl_table_class *idl_classes, - const struct ctl_table_class *ctl_classes, - size_t n_classes, +#define ctl_init(idl_class, table_classes, ctl_classes, cmd_show_table, \ + ctl_exit_func) \ + (BUILD_ASSERT(ARRAY_SIZE(table_classes) == ARRAY_SIZE(ctl_classes)), \ + ctl_init__(idl_class, ctl_classes, cmd_show_table, ctl_exit_func)) +void ctl_init__(const struct ovsdb_idl_class *, const struct ctl_table_class *, const struct cmd_show_table *cmd_show_tables, void (*ctl_exit_func)(int status)); char *ctl_default_db(void); @@ -159,6 +157,8 @@ struct ctl_command { bool ctl_might_write_to_db(char **argv); const char *ctl_get_db_cmd_usage(void); + +const char *ctl_list_db_tables_usage(void); void ctl_print_commands(void); void ctl_print_options(const struct option *); void ctl_add_cmd_options(struct option **, size_t *n_options_p, |