From: Ben Pfaff Date: Thu, 8 Sep 2011 23:22:38 +0000 (-0700) Subject: ofproto: Fix documentation for calls to ->rule_destruct(). X-Git-Tag: v1.3.0~346 X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=dc12d1c3de75773b4c6cef6aa85d12c7dbb5570a;p=sliver-openvswitch.git 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 --- 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()