ovs-vsctl: Add details to documentation for "emer-reset" command.
authorBen Pfaff <blp@nicira.com>
Wed, 23 Jun 2010 16:59:49 +0000 (09:59 -0700)
committerBen Pfaff <blp@nicira.com>
Thu, 24 Jun 2010 20:05:13 +0000 (13:05 -0700)
Someone asked me what emer-reset really does and I had to look in the
source code to find out.  It's kinder just to document it.

utilities/ovs-vsctl.8.in

index ab487ad..cde912d 100644 (file)
@@ -140,9 +140,12 @@ Open vSwitch database if it is empty.  This command is provided to
 initialize the database without executing any other command.
 .
 .IP "\fBemer\-reset\fR"
-Reset the configuration into a clean state.  This will clear the
-configuration of items likely to have been configured by a manager.
-The core networking configuration will be left as is.
+Reset the configuration into a clean state.  It deconfigures OpenFlow
+controllers, OVSDB servers, and SSL, and deletes port mirroring,
+NetFlow, and sFlow configuration.  This command also removes all
+\fBother\-config\fR keys from all database records, except that
+\fBother-config:hwaddr\fR is preserved if it is present in a Bridge
+record.  Other networking configuration is left as-is.
 .
 .SS "Bridge Commands"
 These commands examine and manipulate Open vSwitch bridges.