ovsdb-doc: Add support for references to specific keys.
authorBen Pfaff <blp@nicira.com>
Mon, 20 Jun 2011 21:14:27 +0000 (14:14 -0700)
committerBen Pfaff <blp@nicira.com>
Tue, 21 Jun 2011 22:18:10 +0000 (15:18 -0700)
Now a specific key can be referenced with syntax like
<ref table="Bridge" column="other-config" key="datapath-id"/>.

Also fixes up an existing place that needed this feature already (and had
a typo, too).

ovsdb/ovsdb-doc.in
vswitchd/vswitch.xml

index 5ba4e71..83643c3 100755 (executable)
@@ -52,6 +52,8 @@ def inlineXmlToNroff(node, font):
             s = r'\fB'
             if node.hasAttribute('column'):
                 s += node.attributes['column'].nodeValue
+                if node.hasAttribute('key'):
+                    s += ':' + node.attributes['key'].nodeValue
             elif node.hasAttribute('table'):
                 s += node.attributes['table'].nodeValue
             elif node.hasAttribute('group'):
index ad1bffa..2b12e29 100644 (file)
       </column>
 
       <column name="datapath_id">
-        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.)
+        Reports the OpenFlow datapath ID in use.  Exactly 16 hex digits.
+        (Setting this column has no useful effect.  Set <ref
+        column="other-config" key="datapath-id"/> instead.)
       </column>
     </group>