From: Ben Pfaff <blp@nicira.com>
Date: Wed, 16 Jun 2010 21:41:22 +0000 (-0700)
Subject: vswitch: Improve documentation for datapath_id column.
X-Git-Tag: v1.1.0pre1~279
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=78c54bded9a5b88977ba3dbe1d5b877248ad34b2;p=sliver-openvswitch.git

vswitch: Improve documentation for datapath_id column.

It was insufficiently documented that the vswitch, not the user, sets the
datapath_id column, which confused people (including me).  This commit
fixes the problem.
---

diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 345744e6d..d17b0822d 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -112,7 +112,10 @@
       </column>
 
       <column name="datapath_id">
-        Reports the OpenFlow datapath ID in use.  Exactly 16 hex digits.
+        Reports the OpenFlow datapath ID in use.  Exactly 16 hex
+        digits.  (Setting this column will have no useful effect.  Set
+        <ref column="other_config"/>:<code>other-config</code>
+        instead.)
       </column>
     </group>