Skip to content

Commit

Permalink
ofp-msgs: Fix comments.
Browse files Browse the repository at this point in the history
ofpbuf used to have members named 'frame' and 'l3' but now they're 'header'
and 'msg'.

Signed-off-by: Ben Pfaff <[email protected]>
Acked-by: Jarno Rajahalme <[email protected]>
  • Loading branch information
blp committed Jan 20, 2016
1 parent afe8a6c commit 77a9bb3
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions lib/ofp-msgs.c
Original file line number Diff line number Diff line change
Expand Up @@ -381,9 +381,9 @@ ofpraw_decode_assert(const struct ofp_header *oh)
*
* In addition to setting '*rawp', this function pulls off the OpenFlow header
* (including the stats headers, vendor header, and any subtype header) with
* ofpbuf_pull(). It also sets 'msg->frame' to the start of the OpenFlow
* header and 'msg->msg' just beyond the headers (that is, to the final value of
* msg->data). */
* ofpbuf_pull(). It also sets 'msg->header' to the start of the OpenFlow
* header and 'msg->msg' just beyond the headers (that is, to the final value
* of msg->data). */
enum ofperr
ofpraw_pull(enum ofpraw *rawp, struct ofpbuf *msg)
{
Expand Down Expand Up @@ -512,8 +512,8 @@ static void ofpraw_put__(enum ofpraw, uint8_t version, ovs_be32 xid,
* Each 'raw' value is valid only for certain OpenFlow versions. The caller
* must specify a valid (raw, version) pair.
*
* In the returned ofpbuf, 'frame' points to the beginning of the
* OpenFlow header and 'l3' points just after it, to where the
* In the returned ofpbuf, 'header' points to the beginning of the
* OpenFlow header and 'msg' points just after it, to where the
* message's body will start. The caller must actually allocate the
* body into the space reserved for it, e.g. with ofpbuf_put_uninit().
*
Expand Down Expand Up @@ -559,8 +559,8 @@ ofpraw_alloc_reply(enum ofpraw raw, const struct ofp_header *request,
* value. Every stats request has a corresponding reply, so the (raw, version)
* pairing pitfalls of the other ofpraw_alloc_*() functions don't apply here.
*
* In the returned ofpbuf, 'frame' points to the beginning of the
* OpenFlow header and 'l3' points just after it, to where the
* In the returned ofpbuf, 'header' points to the beginning of the
* OpenFlow header and 'msg' points just after it, to where the
* message's body will start. The caller must actually allocate the
* body into the space reserved for it, e.g. with ofpbuf_put_uninit().
*
Expand Down Expand Up @@ -592,9 +592,9 @@ ofpraw_alloc_stats_reply(const struct ofp_header *request,
* Each 'raw' value is valid only for certain OpenFlow versions. The caller
* must specify a valid (raw, version) pair.
*
* Upon return, 'buf->frame' points to the beginning of the OpenFlow header and
* 'buf->msg' points just after it, to where the message's body will start. The
* caller must actually allocating the body into the space reserved for it,
* Upon return, 'buf->header' points to the beginning of the OpenFlow header
* and 'buf->msg' points just after it, to where the message's body will start.
* The caller must actually allocating the body into the space reserved for it,
* e.g. with ofpbuf_put_uninit(). */
void
ofpraw_put(enum ofpraw raw, uint8_t version, struct ofpbuf *buf)
Expand Down Expand Up @@ -632,8 +632,8 @@ ofpraw_put_reply(enum ofpraw raw, const struct ofp_header *request,
* value. Every stats request has a corresponding reply, so the (raw, version)
* pairing pitfalls of the other ofpraw_alloc_*() functions don't apply here.
*
* In the returned ofpbuf, 'frame' points to the beginning of the
* OpenFlow header and 'l3' points just after it, to where the
* In the returned ofpbuf, 'header' points to the beginning of the
* OpenFlow header and 'msg' points just after it, to where the
* message's body will start. The caller must actually allocate the
* body into the space reserved for it, e.g. with ofpbuf_put_uninit().
*
Expand Down Expand Up @@ -801,9 +801,9 @@ ofptype_decode(enum ofptype *typep, const struct ofp_header *oh)
*
* In addition to setting '*typep', this function pulls off the OpenFlow header
* (including the stats headers, vendor header, and any subtype header) with
* ofpbuf_pull(). It also sets 'msg->frame' to the start of the OpenFlow
* header and 'msg->msg' just beyond the headers (that is, to the final value of
* msg->data). */
* ofpbuf_pull(). It also sets 'msg->header' to the start of the OpenFlow
* header and 'msg->msg' just beyond the headers (that is, to the final value
* of msg->data). */
enum ofperr
ofptype_pull(enum ofptype *typep, struct ofpbuf *buf)
{
Expand Down

0 comments on commit 77a9bb3

Please sign in to comment.