[PATCH 00/13] fix dox warning in net/sched/sch_htb.c

[PATCH 00/13] fix dox warning in net/sched/sch_htb.c

[Yu Kuai]

Yu Kuai (13):
  sch_htb: fix doc warning in htb_add_to_wait_tree()
  sch_htb: fix doc warning in htb_next_rb_node()
  sch_htb: fix doc warning in htb_add_class_to_row()
  sch_htb: fix doc warning in htb_remove_class_from_row()
  sch_htb: fix doc warning in htb_activate_prios()
  sch_htb: fix doc warning in htb_deactivate_prios()
  sch_htb: fix doc warning in htb_class_mode()
  sch_htb: fix doc warning in htb_change_class_mode()
  sch_htb: fix doc warning in htb_activate()
  sch_htb: fix doc warning in htb_deactivate()
  sch_htb: fix doc warning in htb_charge_class()
  sch_htb: fix doc warning in htb_do_events()
  sch_htb: fix doc warning in htb_lookup_leaf()

 net/sched/sch_htb.c | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

-- 
2.31.1

[PATCH 01/13] sch_htb: fix doc warning in htb_add_to_wait_tree()

[Yu Kuai]

Add description for parameters of htb_add_to_wait_tree() to fix
gcc W=1 warnings:

net/sched/sch_htb.c:308: warning: Function parameter or member 'q' not described in 'htb_add_to_wait_tree'
net/sched/sch_htb.c:308: warning: Function parameter or member 'cl' not described in 'htb_add_to_wait_tree'
net/sched/sch_htb.c:308: warning: Function parameter or member 'delay' not described in 'htb_add_to_wait_tree'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 4f9304567dcc..4eeef342c3c6 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -301,6 +301,9 @@ static void htb_add_to_id_tree(struct rb_root *root,
 
 /**
  * htb_add_to_wait_tree - adds class to the event queue with delay
+ * @q: the priority event queue
+ * @cl: the class to add
+ * @delay: delay in microseconds
  *
  * The class is added to priority event queue to indicate that class will
  * change its mode in cl->pq_key microseconds. Make sure that class is not
-- 
2.31.1

[PATCH 02/13] sch_htb: fix doc warning in htb_next_rb_node()

[Yu Kuai]

Add description for parameters of htb_next_rb_node() to fix
gcc W=1 warnings:

net/sched/sch_htb.c:339: warning: Function parameter or member 'n' not described in 'htb_next_rb_node'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 4eeef342c3c6..5ad28df6b18c 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -337,6 +337,7 @@ static void htb_add_to_wait_tree(struct htb_sched *q,
 
 /**
  * htb_next_rb_node - finds next node in binary tree
+ * @n: the current node in binary tree
  *
  * When we are past last key we return NULL.
  * Average complexity is 2 steps per call.
-- 
2.31.1

[PATCH 03/13] sch_htb: fix doc warning in htb_add_class_to_row()

[Yu Kuai]

Add description for parameters of htb_add_class_to_row() to fix
gcc W=1 warnings:

net/sched/sch_htb.c:351: warning: Function parameter or member 'q' not described in 'htb_add_class_to_row'
net/sched/sch_htb.c:351: warning: Function parameter or member 'cl' not described in 'htb_add_class_to_row'
net/sched/sch_htb.c:351: warning: Function parameter or member 'mask' not described in 'htb_add_class_to_row'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 5ad28df6b18c..97a9df42849e 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -349,6 +349,9 @@ static inline void htb_next_rb_node(struct rb_node **n)
 
 /**
  * htb_add_class_to_row - add class to its row
+ * @q: the priority event queue
+ * @cl: the class to add
+ * @mask: the given priorities in class in bitmap
  *
  * The class is added to row at priorities marked in mask.
  * It does nothing if mask == 0.
-- 
2.31.1

[PATCH 04/13] sch_htb: fix doc warning in htb_remove_class_from_row()

[Yu Kuai]

Add description for parameters of htb_remove_class_from_row()
to fix gcc W=1 warnings:

net/sched/sch_htb.c:380: warning: Function parameter or member 'q' not described in 'htb_remove_class_from_row'
net/sched/sch_htb.c:380: warning: Function parameter or member 'cl' not described in 'htb_remove_class_from_row'
net/sched/sch_htb.c:380: warning: Function parameter or member 'mask' not described in 'htb_remove_class_from_row'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 97a9df42849e..30a53db7eeb6 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -381,6 +381,9 @@ static void htb_safe_rb_erase(struct rb_node *rb, struct rb_root *root)
 
 /**
  * htb_remove_class_from_row - removes class from its row
+ * @q: the priority event queue
+ * @cl: the class to add
+ * @mask: the given priorities in class in bitmap
  *
  * The class is removed from row at priorities marked in mask.
  * It does nothing if mask == 0.
-- 
2.31.1

[PATCH 05/13] sch_htb: fix doc warning in htb_activate_prios()

[Yu Kuai]

Add description for parameters of htb_activate_prios()
to fix gcc W=1 warnings:

net/sched/sch_htb.c:407: warning: Function parameter or member 'q' not described in 'htb_activate_prios'
net/sched/sch_htb.c:407: warning: Function parameter or member 'cl' not described in 'htb_activate_prios'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 30a53db7eeb6..06f1b4ee88e2 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -411,6 +411,8 @@ static inline void htb_remove_class_from_row(struct htb_sched *q,
 
 /**
  * htb_activate_prios - creates active classe's feed chain
+ * @q: the priority event queue
+ * @cl: the class to activate
  *
  * The class is connected to ancestors and/or appropriate rows
  * for priorities it is participating on. cl->cmode must be new
-- 
2.31.1

[PATCH 06/13] sch_htb: fix doc warning in htb_deactivate_prios()

[Yu Kuai]

Add description for parameters of htb_deactivate_prios()
to fix gcc W=1 warnings:

net/sched/sch_htb.c:442: warning: Function parameter or member 'q' not described in 'htb_deactivate_prios'
net/sched/sch_htb.c:442: warning: Function parameter or member 'cl' not described in 'htb_deactivate_prios'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 06f1b4ee88e2..869e59be0993 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -448,6 +448,8 @@ static void htb_activate_prios(struct htb_sched *q, struct htb_class *cl)
 
 /**
  * htb_deactivate_prios - remove class from feed chain
+ * @q: the priority event queue
+ * @cl: the class to deactivate
  *
  * cl->cmode must represent old mode (before deactivation). It does
  * nothing if cl->prio_activity == 0. Class is removed from all feed
-- 
2.31.1

[PATCH 07/13] sch_htb: fix doc warning in htb_class_mode()

[Yu Kuai]

Add description for parameters of htb_class_mode()
to fix gcc W=1 warnings:

net/sched/sch_htb.c:507: warning: Function parameter or member 'cl' not described in 'htb_class_mode'
net/sched/sch_htb.c:507: warning: Function parameter or member 'diff' not described in 'htb_class_mode'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 869e59be0993..062ddf88ce22 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -510,6 +510,8 @@ static inline s64 htb_hiwater(const struct htb_class *cl)
 
 /**
  * htb_class_mode - computes and returns current class mode
+ * @cl: the target class
+ * @diff: diff time in microseconds
  *
  * It computes cl's mode at time cl->t_c+diff and returns it. If mode
  * is not HTB_CAN_SEND then cl->pq_key is updated to time difference
-- 
2.31.1

[PATCH 08/13] sch_htb: fix doc warning in htb_change_class_mode()

[Yu Kuai]

Add description for parameters of htb_change_class_mode()
to fix gcc W=1 warnings:

net/sched/sch_htb.c:533: warning: Function parameter or member 'q' not described in 'htb_change_class_mode'
net/sched/sch_htb.c:533: warning: Function parameter or member 'cl' not described in 'htb_change_class_mode'
net/sched/sch_htb.c:533: warning: Function parameter or member 'diff' not described in 'htb_change_class_mode'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 062ddf88ce22..875ef6cd2ce0 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -540,6 +540,9 @@ htb_class_mode(struct htb_class *cl, s64 *diff)
 
 /**
  * htb_change_class_mode - changes classe's mode
+ * @q: the priority event queue
+ * @cl: the target class
+ * @diff: diff time in microseconds
  *
  * This should be the only way how to change classe's mode under normal
  * circumstances. Routine will update feed lists linkage, change mode
-- 
2.31.1

[PATCH 09/13] sch_htb: fix doc warning in htb_activate()

[Yu Kuai]

Add description for parameters of htb_activate()
to fix gcc W=1 warnings:

net/sched/sch_htb.c:562: warning: Function parameter or member 'q' not described in 'htb_activate'
net/sched/sch_htb.c:562: warning: Function parameter or member 'cl' not described in 'htb_activate'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 875ef6cd2ce0..1ee47de6f72c 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -575,6 +575,8 @@ htb_change_class_mode(struct htb_sched *q, struct htb_class *cl, s64 *diff)
 
 /**
  * htb_activate - inserts leaf cl into appropriate active feeds
+ * @q: the priority event queue
+ * @cl: the target class
  *
  * Routine learns (new) priority of leaf and activates feed chain
  * for the prio. It can be called on already active leaf safely.
-- 
2.31.1

[PATCH 10/13] sch_htb: fix doc warning in htb_deactivate()

[Yu Kuai]

Add description for parameters of htb_deactivate()
to fix gcc W=1 warnings:

net/sched/sch_htb.c:578: warning: Function parameter or member 'q' not described in 'htb_deactivate'
net/sched/sch_htb.c:578: warning: Function parameter or member 'cl' not described in 'htb_deactivate'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 1ee47de6f72c..9d4c5370257d 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -594,6 +594,8 @@ static inline void htb_activate(struct htb_sched *q, struct htb_class *cl)
 
 /**
  * htb_deactivate - remove leaf cl from active feeds
+ * @q: the priority event queue
+ * @cl: the target class
  *
  * Make sure that leaf is active. In the other words it can't be called
  * with non-active leaf. It also removes class from the drop list.
-- 
2.31.1

[PATCH 11/13] sch_htb: fix doc warning in htb_charge_class()

[Yu Kuai]

Add description for parameters of htb_charge_class()
to fix gcc W=1 warnings:

net/sched/sch_htb.c:663: warning: Function parameter or member 'q' not described in 'htb_charge_class'
net/sched/sch_htb.c:663: warning: Function parameter or member 'cl' not described in 'htb_charge_class'
net/sched/sch_htb.c:663: warning: Function parameter or member 'level' not described in 'htb_charge_class'
net/sched/sch_htb.c:663: warning: Function parameter or member 'skb' not described in 'htb_charge_class'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 9d4c5370257d..a6cd3f18ff87 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -675,6 +675,10 @@ static inline void htb_accnt_ctokens(struct htb_class *cl, int bytes, s64 diff)
 
 /**
  * htb_charge_class - charges amount "bytes" to leaf and ancestors
+ * @q: the priority event queue
+ * @cl: the class to start iterate
+ * @level: the minimum level to account
+ * @skb: the socket buffer
  *
  * Routine assumes that packet "bytes" long was dequeued from leaf cl
  * borrowing from "level". It accounts bytes to ceil leaky bucket for
-- 
2.31.1

[PATCH 12/13] sch_htb: fix doc warning in htb_do_events()

[Yu Kuai]

Add description for parameters of htb_do_events()
to fix gcc W=1 warnings:

net/sched/sch_htb.c:708: warning: Function parameter or member 'q' not described in 'htb_do_events'
net/sched/sch_htb.c:708: warning: Function parameter or member 'level' not described in 'htb_do_events'
net/sched/sch_htb.c:708: warning: Function parameter or member 'start' not described in 'htb_do_events'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index a6cd3f18ff87..66c330244b9d 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -728,6 +728,9 @@ static void htb_charge_class(struct htb_sched *q, struct htb_class *cl,
 
 /**
  * htb_do_events - make mode changes to classes at the level
+ * @q: the priority event queue
+ * @level: which wait_pq in 'q->hlevel'
+ * @start: start jiffies
  *
  * Scans event queue for pending events and applies them. Returns time of
  * next pending event (0 for no event in pq, q->now for too many events).
-- 
2.31.1

[PATCH 13/13] sch_htb: fix doc warning in htb_lookup_leaf()

[Yu Kuai]

Add description for parameters of htb_lookup_leaf()
to fix gcc W=1 warnings:

net/sched/sch_htb.c:773: warning: Function parameter or member 'hprio' not described in 'htb_lookup_leaf'
net/sched/sch_htb.c:773: warning: Function parameter or member 'prio' not described in 'htb_lookup_leaf'

Signed-off-by: Yu Kuai <yukuai3@huawei.com>
---
 net/sched/sch_htb.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/net/sched/sch_htb.c b/net/sched/sch_htb.c
index 66c330244b9d..7a69e4e608c3 100644
--- a/net/sched/sch_htb.c
+++ b/net/sched/sch_htb.c
@@ -799,6 +799,8 @@ static struct rb_node *htb_id_find_next_upper(int prio, struct rb_node *n,
 
 /**
  * htb_lookup_leaf - returns next leaf class in DRR order
+ * @hprio: the current one
+ * @prio: which prio in class
  *
  * Find leaf where current feed pointers points to.
  */
-- 
2.31.1

Re: [PATCH 00/13] fix dox warning in net/sched/sch_htb.c

[patchwork-bot+netdevbpf]

Hello:

This series was applied to netdev/net-next.git (refs/heads/master):

On Sat, 5 Jun 2021 18:18:32 +0800 you wrote:
> Yu Kuai (13):
>   sch_htb: fix doc warning in htb_add_to_wait_tree()
>   sch_htb: fix doc warning in htb_next_rb_node()
>   sch_htb: fix doc warning in htb_add_class_to_row()
>   sch_htb: fix doc warning in htb_remove_class_from_row()
>   sch_htb: fix doc warning in htb_activate_prios()
>   sch_htb: fix doc warning in htb_deactivate_prios()
>   sch_htb: fix doc warning in htb_class_mode()
>   sch_htb: fix doc warning in htb_change_class_mode()
>   sch_htb: fix doc warning in htb_activate()
>   sch_htb: fix doc warning in htb_deactivate()
>   sch_htb: fix doc warning in htb_charge_class()
>   sch_htb: fix doc warning in htb_do_events()
>   sch_htb: fix doc warning in htb_lookup_leaf()
> 
> [...]

Here is the summary with links:
  - [01/13] sch_htb: fix doc warning in htb_add_to_wait_tree()
    https://git.kernel.org/netdev/net-next/c/4d7efa73fa26
  - [02/13] sch_htb: fix doc warning in htb_next_rb_node()
    https://git.kernel.org/netdev/net-next/c/274e5d0e55aa
  - [03/13] sch_htb: fix doc warning in htb_add_class_to_row()
    https://git.kernel.org/netdev/net-next/c/996bccc39afb
  - [04/13] sch_htb: fix doc warning in htb_remove_class_from_row()
    https://git.kernel.org/netdev/net-next/c/5f8c6d05f390
  - [05/13] sch_htb: fix doc warning in htb_activate_prios()
    https://git.kernel.org/netdev/net-next/c/876b5fc0c0fb
  - [06/13] sch_htb: fix doc warning in htb_deactivate_prios()
    https://git.kernel.org/netdev/net-next/c/4113be2020a8
  - [07/13] sch_htb: fix doc warning in htb_class_mode()
    https://git.kernel.org/netdev/net-next/c/1e9559527a9d
  - [08/13] sch_htb: fix doc warning in htb_change_class_mode()
    https://git.kernel.org/netdev/net-next/c/4b479e9883ce
  - [09/13] sch_htb: fix doc warning in htb_activate()
    https://git.kernel.org/netdev/net-next/c/8df7e8fff8da
  - [10/13] sch_htb: fix doc warning in htb_deactivate()
    https://git.kernel.org/netdev/net-next/c/9a034f25e472
  - [11/13] sch_htb: fix doc warning in htb_charge_class()
    https://git.kernel.org/netdev/net-next/c/0e5c90848a28
  - [12/13] sch_htb: fix doc warning in htb_do_events()
    https://git.kernel.org/netdev/net-next/c/2c3ee53ea663
  - [13/13] sch_htb: fix doc warning in htb_lookup_leaf()
    https://git.kernel.org/netdev/net-next/c/9977d6f56bac

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html