From b9f9a7e96fa52f287ddf7f8433ad02b3a245dcf6 Mon Sep 17 00:00:00 2001 From: Sean Robinson Date: Thu, 17 Mar 2011 23:42:47 +0100 Subject: doc: fix wrong comment describing mnl_nlmsg_batch_stop() Sean says: "I did find a discrepancy in the comments versus practice in one function and I have attached a patch fixing those comments to this message." Sligtly mangled by myself. Signed-off-by: Sean Robinson Signed-off-by: Pablo Neira Ayuso --- src/nlmsg.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/nlmsg.c b/src/nlmsg.c index b398474..cb2cbb8 100644 --- a/src/nlmsg.c +++ b/src/nlmsg.c @@ -473,9 +473,9 @@ EXPORT_SYMBOL(mnl_nlmsg_batch_stop); * mnl_nlmsg_batch_next - get room for the next message in the batch * \param b pointer to batch * - * This function returns a pointer to the beginning of the new Netlink message - * in the batch. It returns false if the last message did not fit into the - * batch. + * This function returns false if the last message did not fit into the + * batch. Otherwise, it prepares the batch to provide room for the new + * Netlink message in the batch and returns true. * * You have to put at least one message in the batch before calling this * function, otherwise your application is likely to crash. -- cgit v1.2.3