From db1fc2103d73ae0451f569200e70e808a7d7d79f Mon Sep 17 00:00:00 2001 From: Joe Stringer Date: Mon, 13 Jan 2014 13:50:22 -0800 Subject: [PATCH] netlink: Update comment for nl_dump_start(). The function comment still referred to a 'msg' variable, which has been renamed. Signed-off-by: Joe Stringer [blp@nicira.com did further proofreading] Signed-off-by: Ben Pfaff --- lib/netlink-socket.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/lib/netlink-socket.c b/lib/netlink-socket.c index 4bd6d366c..1463ff008 100644 --- a/lib/netlink-socket.c +++ b/lib/netlink-socket.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc. + * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -675,16 +675,17 @@ nl_sock_drain(struct nl_sock *sock) * Netlink socket created with the given 'protocol', and initializes 'dump' to * reflect the state of the operation. * - * nlmsg_len in 'msg' will be finalized to match msg->size, and nlmsg_pid will - * be set to the Netlink socket's pid, before the message is sent. NLM_F_DUMP - * and NLM_F_ACK will be set in nlmsg_flags. + * 'request' must contain a Netlink message. Before sending the message, + * nlmsg_len will be finalized to match request->size, and nlmsg_pid will be + * set to the Netlink socket's pid. NLM_F_DUMP and NLM_F_ACK will be set in + * nlmsg_flags. * * The design of this Netlink socket library ensures that the dump is reliable. * - * This function provides no status indication. An error status for the entire - * dump operation is provided when it is completed by calling nl_dump_done(). + * This function provides no status indication. nl_dump_done() provides an + * error status for the entire dump operation. * - * The caller is responsible for destroying 'request'. + * The caller must eventually destroy 'request'. */ void nl_dump_start(struct nl_dump *dump, int protocol, const struct ofpbuf *request) -- 2.43.0