vswitch: Improve documentation for datapath_id column.
authorBen Pfaff <blp@nicira.com>
Wed, 16 Jun 2010 21:41:22 +0000 (14:41 -0700)
committerBen Pfaff <blp@nicira.com>
Thu, 17 Jun 2010 17:26:13 +0000 (10:26 -0700)
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.

vswitchd/vswitch.xml

index 345744e..d17b082 100644 (file)
       </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>