diff options
| author | Sean Robinson <seankrobinson@gmail.com> | 2011-03-17 23:42:47 +0100 |
|---|---|---|
| committer | Pablo Neira Ayuso <pablo@gnumonks.org> | 2011-03-17 23:42:55 +0100 |
| commit | b9f9a7e96fa52f287ddf7f8433ad02b3a245dcf6 (patch) | |
| tree | bc5782cc5dbcad4155575f6384891803c97c4cea | |
| parent | 612770e6488bf1e7bfeb1e75abe27b41c19c3213 (diff) | |
| download | libmnl-b9f9a7e96fa52f287ddf7f8433ad02b3a245dcf6.tar.gz libmnl-b9f9a7e96fa52f287ddf7f8433ad02b3a245dcf6.zip | |
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 <seankrobinson@gmail.com>
Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
| -rw-r--r-- | src/nlmsg.c | 6 |
1 files 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. |