datapath: Don't call genlmsg_reply() under rcu_read_lock().

[openvswitch] / vswitchd / ovs-brcompatd.8.in

diff --git a/vswitchd/ovs-brcompatd.8.in b/vswitchd/ovs-brcompatd.8.in
index f5dd62a716a2612e706bb1e3a564fcba50e2d840..2ce164c3a7ea33dcb79a462313729f2daa9fab82 100644 (file)
--- a/vswitchd/ovs-brcompatd.8.in
+++ b/vswitchd/ovs-brcompatd.8.in
@@ -9,10 +9,10 @@ ovs\-brcompatd \- Bridge compatibility front-end for ovs\-vswitchd
 [\fIoptions\fR] \fIdatabase\fR
 .
 .SH DESCRIPTION
-A daemon that provides a legacy bridge front-end for \fBovs\-vswitchd\fR.  It 
-does this by listening for bridge ioctl commands (e.g., those generated by 
-the \fBbrctl\fR program) to add or remove datapaths and the interfaces 
-that attach to them.  
+A daemon that provides a legacy bridge front-end for \fBovs\-vswitchd\fR.  It
+does this by listening for bridge ioctl commands (e.g., those generated by
+the \fBbrctl\fR program) to add or remove datapaths and the interfaces
+that attach to them.
 .PP
 The mandatory \fIdatabase\fR argument specifies the
 \fBovsdb\-server\fR from which \fBovs\-vswitchd\fR's configuration is
@@ -20,11 +20,11 @@ retrieved.  It should take the form \fBunix:\fIfile\fR, to connect to
 the Unix domain server socket named \fIfile\fR.
 .PP
 .SH OPTIONS
-.IP "\fB--appctl-command=\fIcommand\fR"
+.IP "\fB\-\-appctl\-command=\fIcommand\fR"
 Sets the command that \fBovs\-brcompatd\fR runs to communicate with
 \fBovs\-vswitchd\fR.  The command is run in \fB/bin/sh\fR as a shell
 command, so \fIcommand\fR may contain arbitrary shell metacharacters,
-etc.  The \fB--help\fR option displays the default command.
+etc.  The \fB\-\-help\fR option displays the default command.
 .IP
 \fIcommand\fR must contain exactly one instance of \fB%s\fR, which
 \fBovs\-brcompatd\fR replaces by a command from the set understood by
@@ -40,10 +40,10 @@ can be listed by passing \fBhelp\fR to \fBovs\-appctl\fR with
 standard error streams, because \fBovs\-brcompatd\fR expects to read
 both of these streams separately.
 .TP
-\fB--prune-timeout=\fIsecs\fR
+\fB\-\-prune\-timeout=\fIsecs\fR
 .
 Sets the maximum time between pruning port entries to \fIsecs\fR seconds.
-Pruning ports is the process of removing port entries from \fIdatabase\fR 
+Pruning ports is the process of removing port entries from \fIdatabase\fR
 that no longer exist.  If \fIsecs\fR is zero, then entries are never
 pruned.  The default prune timeout is 5 seconds.
 .
@@ -52,6 +52,12 @@ pruned.  The default prune timeout is 5 seconds.
 .so lib/common.man
 .so lib/leak-checker.man
 .
+.SH BUGS
+.
+\fBovs\-brcompatd\fR requires the bridges that it manages to initially
+have no ports listed in their database records when it starts up.
+Otherwise, it may add duplicate ports to bridges.
+.
 .SH NOTES
 \fBovs\-brcompatd\fR requires the \fBbrcompat_mod.ko\fR kernel module to be
 loaded.