2016-03-19 21:31:51

by Luis de Bethencourt

Subject: [PATCH] net: sched: Add description for cpu_bstats argument

Commit 22e0f8b9322c ("net: sched: make bstats per cpu and estimator RCU safe")
added the argument cpu_bstats to functions gen_new_estimator and
gen_replace_estimator and now the descriptions of these are missing for the
documentation. Adding them.

Signed-off-by: Luis de Bethencourt <[email protected]>
---
Hi,

Noticed these missing descriptions when running make htmldocs.

Got the following warnings:
.//net/core/gen_estimator.c:212: warning: No description found for parameter 'cpu_bstats'
.//net/core/gen_estimator.c:303: warning: No description found for parameter 'cpu_bstats'

Thanks :)
Luis

net/core/gen_estimator.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/net/core/gen_estimator.c b/net/core/gen_estimator.c
index 92d886f..4573d81 100644
--- a/net/core/gen_estimator.c
+++ b/net/core/gen_estimator.c
@@ -191,6 +191,7 @@ struct gen_estimator *gen_find_node(const struct gnet_stats_basic_packed *bstats
/**
* gen_new_estimator - create a new rate estimator
* @bstats: basic statistics
+ * @cpu_bstats: bstats per cpu
* @rate_est: rate estimator statistics
* @stats_lock: statistics lock
* @opt: rate estimator configuration TLV
@@ -287,6 +288,7 @@ EXPORT_SYMBOL(gen_kill_estimator);
/**
* gen_replace_estimator - replace rate estimator configuration
* @bstats: basic statistics
+ * @cpu_bstats: bstats per cpu
* @rate_est: rate estimator statistics
* @stats_lock: statistics lock
* @opt: rate estimator configuration TLV
--
2.5.1

2016-03-20 20:49:26

by David Miller

Subject: Re: [PATCH] net: sched: Add description for cpu_bstats argument

From: Luis de Bethencourt <[email protected]>
Date: Sat, 19 Mar 2016 21:31:38 +0000

> Commit 22e0f8b9322c ("net: sched: make bstats per cpu and estimator RCU safe")
> added the argument cpu_bstats to functions gen_new_estimator and
> gen_replace_estimator and now the descriptions of these are missing for the
> documentation. Adding them.
>
> Signed-off-by: Luis de Bethencourt <[email protected]>

Applied.