ofproto-provider: Update documentation.
authorJoe Stringer <joestringer@nicira.com>
Tue, 18 Feb 2014 17:39:12 +0000 (09:39 -0800)
committerBen Pfaff <blp@nicira.com>
Wed, 19 Feb 2014 22:48:26 +0000 (14:48 -0800)
This wording was in ofproto.c, but missing from ofproto-provider.h.

Signed-off-by: Joe Stringer <joestringer@nicira.com>
Signed-off-by: Ben Pfaff <blp@nicira.com>
ofproto/ofproto-provider.h

index d05adbc..2c72fbc 100644 (file)
@@ -937,8 +937,9 @@ struct ofproto_class {
     void (*port_reconfigured)(struct ofport *ofport,
                               enum ofputil_port_config old_config);
 
-    /* Looks up a port named 'devname' in 'ofproto'.  On success, initializes
-     * '*port' appropriately.
+    /* Looks up a port named 'devname' in 'ofproto'.  On success, returns 0 and
+     * initializes '*port' appropriately. Otherwise, returns a positive errno
+     * value.
      *
      * The caller owns the data in 'port' and must free it with
      * ofproto_port_destroy() when it is no longer needed. */