diff options
| author | Lance Richardson <lrichard@redhat.com> | 2016-12-22 14:45:50 -0500 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2016-12-22 16:13:13 -0800 |
| commit | c4817da780613cf4bfd77694bf859ad96d99b93c (patch) | |
| tree | cda654db83bc744158c2b316bf725fc671086388 /lib | |
| parent | ddf3352e03b409c3f5c16cbdb914e6453f36bebd (diff) | |
| download | openvswitch-c4817da780613cf4bfd77694bf859ad96d99b93c.tar.gz | |
table: correct documented default format in man pages
There are currently five users of the table formatting library,
all of which default to "list" except for ovsdb-client which
defaults to "table". The library current default is "table",
and the table.man man page fragment only considers ovs-vsctl
to use something other than "table" as a default.As a result,
the man pages for ovn-sbctl and vtep-ctl are currently incorrect
(these options aren't documented in the ovn-nbctl man page, which
will need to be addressed in a future patch).
Fix by making the library default format "list" and handling
ovsdb-client as the exception.
Signed-off-by: Lance Richardson <lrichard@redhat.com>
Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/table.h | 2 | ||||
| -rw-r--r-- | lib/table.man | 8 |
2 files changed, 5 insertions, 5 deletions
diff --git a/lib/table.h b/lib/table.h index 85b815645..7330a33c1 100644 --- a/lib/table.h +++ b/lib/table.h @@ -80,7 +80,7 @@ struct table_style { int json_flags; /* CF_JSON: Flags for json_to_string(). */ }; -#define TABLE_STYLE_DEFAULT { TF_TABLE, CF_STRING, true, JSSF_SORT } +#define TABLE_STYLE_DEFAULT { TF_LIST, CF_STRING, true, JSSF_SORT } #define TABLE_OPTION_ENUMS \ OPT_NO_HEADINGS, \ diff --git a/lib/table.man b/lib/table.man index a8f109465..62efa9a2a 100644 --- a/lib/table.man +++ b/lib/table.man @@ -3,11 +3,11 @@ Sets the type of table formatting. The following types of \fIformat\fR are available: .RS -.ie '\*(PN'ovs\-vsctl' .IP "\fBtable\fR" -.el .IP "\fBtable\fR (default)" +.ie '\*(PN'ovsdb\-client' .IP "\fBtable\fR (default)" +.el .IP "\fBtable\fR" 2-D text tables with aligned columns. -.ie '\*(PN'ovs\-vsctl' .IP "\fBlist\fR (default)" -.el .IP "\fBlist\fR" +.ie '\*(PN'ovsdb\-client' .IP "\fBlist\fR" +.el .IP "\fBlist\fR (default)" A list with one column per line and rows separated by a blank line. .IP "\fBhtml\fR" HTML tables. |