xfif, wdp: Clarify comment.
authorBen Pfaff <blp@nicira.com>
Thu, 8 Apr 2010 17:30:11 +0000 (10:30 -0700)
committerBen Pfaff <blp@nicira.com>
Thu, 8 Apr 2010 17:30:11 +0000 (10:30 -0700)
Suggested by partner.

lib/xfif-provider.h
ofproto/wdp-provider.h

index d469269..8730c53 100644 (file)
@@ -54,10 +54,11 @@ static inline void xfif_assert_class(const struct xfif *xfif,
  * These functions return 0 if successful or a positive errno value on failure,
  * except where otherwise noted.
  *
- * These functions are expected to execute synchronously, that is, to block as
- * necessary to obtain a result.  Thus, they may not return EAGAIN or
- * EWOULDBLOCK or EINPROGRESS.  We may relax this requirement in the future if
- * and when we encounter performance problems. */
+ * Most of these functions are expected to execute synchronously, that is, to
+ * block as necessary to obtain a result.  Thus, these functions may return
+ * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
+ * explicitly say those errors are a possibility.  We may relax this
+ * requirement in the future if and when we encounter performance problems. */
 struct xfif_class {
     /* Type of xfif in this class, e.g. "system", "netdev", etc.
      *
index 9e7d229..8c52295 100644 (file)
@@ -61,10 +61,11 @@ static inline void wdp_assert_class(const struct wdp *wdp,
  * These functions return 0 if successful or a positive errno value on failure,
  * except where otherwise noted.
  *
- * These functions are expected to execute synchronously, that is, to block as
- * necessary to obtain a result.  Thus, they may not return EAGAIN or
- * EWOULDBLOCK or EINPROGRESS.  We may relax this requirement in the future if
- * and when we encounter performance problems. */
+ * Most of these functions are expected to execute synchronously, that is, to
+ * block as necessary to obtain a result.  Thus, these functions may return
+ * EAGAIN (or EWOULDBLOCK or EINPROGRESS) only where the function descriptions
+ * explicitly say those errors are a possibility.  We may relax this
+ * requirement in the future if and when we encounter performance problems. */
 struct wdp_class {
     /* Type of wdp in this class, e.g. "system", "netdev", etc.
      *