Fix typos in comments.
[sliver-openvswitch.git] / lib / ofp-util.h
index 64de2a0..83193e2 100644 (file)
@@ -90,7 +90,12 @@ void ntoh_ofp_phy_port(struct ofp_phy_port *);
 \f
 /* OpenFlow vendors.
  *
- * These functions map vendor */
+ * These functions map OpenFlow 32-bit vendor IDs (as used in struct
+ * ofp_vendor_header) into 4-bit values to embed in an "int".  The 4-bit values
+ * are only used internally in Open vSwitch and never appear on the wire, so
+ * particular codes used are not important.
+ */
+
 /* Vendor error numbers currently used in Open vSwitch. */
 #define OFPUTIL_VENDORS                                     \
     /*             vendor name              vendor value */ \
@@ -111,19 +116,19 @@ enum ofputil_vendor_codes {
  * error codes into a single 31-bit space using the following encoding.
  * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
  *
- *   31                                                   0
+ *   30                                                   0
  *  +------------------------------------------------------+
  *  |                           0                          |  success
  *  +------------------------------------------------------+
  *
  *   30 29                                                0
  *  +--+---------------------------------------------------+
- *  ||                    errno value                    |  errno value
+ *  | 0|                    errno value                    |  errno value
  *  +--+---------------------------------------------------+
  *
  *   30 29   26 25            16 15                       0
  *  +--+-------+----------------+--------------------------+
- *  ||   0   |      type      |           code           |  standard OpenFlow
+ *  | 1|   0   |      type      |           code           |  standard OpenFlow
  *  +--+-------+----------------+--------------------------+  error
  *
  *   30 29   26 25            16 15                       0