summaryrefslogtreecommitdiff
path: root/ofproto
diff options
context:
space:
mode:
authorBen Pfaff <blp@nicira.com>2011-09-08 16:22:38 -0700
committerBen Pfaff <blp@nicira.com>2011-09-09 09:17:04 -0700
commitdc12d1c3de75773b4c6cef6aa85d12c7dbb5570a (patch)
treed075cb80e318d5a6bcf6918cd36a346afad420cd /ofproto
parentb6e001b699d9affb558278ec90950f9960fe1826 (diff)
downloadopenvswitch-dc12d1c3de75773b4c6cef6aa85d12c7dbb5570a.tar.gz
ofproto: Fix documentation for calls to ->rule_destruct().
This documented what I intended to implement and what I thought I had implemented, but not what the code actually did. It is a little easier to fix the documentation to match the implementation than vice versa, so this commit does so. Reported-by: Hao Zheng <hzheng@nicira.com>
Diffstat (limited to 'ofproto')
-rw-r--r--ofproto/ofproto-provider.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/ofproto/ofproto-provider.h b/ofproto/ofproto-provider.h
index 037dbae5b..c9d74eeb7 100644
--- a/ofproto/ofproto-provider.h
+++ b/ofproto/ofproto-provider.h
@@ -721,8 +721,8 @@ struct ofproto_class {
* * Return an OpenFlow error code (as returned by ofp_mkerr()). (Do
* not call ofoperation_complete() in this case.)
*
- * In the former case, ->rule_destruct() will be called; in the latter
- * case, it will not. ->rule_dealloc() will be called in either case.
+ * Either way, ->rule_destruct() will not be called for 'rule', but
+ * ->rule_dealloc() will be.
*
* - If the operation is only partially complete, then it must return 0.
* Later, when the operation is complete, the ->run() or ->destruct()