[PATCH net-next 0/2] net: minor kdoc fixes

[PATCH net-next 0/2] net: minor kdoc fixes

[Simon Horman]

Hi,

this short series fixes two kdoc errors that were noticed
during development.

Bijie Xu (2):
  net: flow_offload: correct comments mismatch with code
  net: sched: provide missing kdoc for tcf_pkt_info and tcf_ematch_ops

 include/net/flow_offload.h | 2 +-
 include/net/pkt_cls.h      | 4 ++++
 2 files changed, 5 insertions(+), 1 deletion(-)

-- 
2.20.1

[PATCH net-next 1/2] net: flow_offload: correct comments mismatch with code

[Simon Horman]

From: Bijie Xu <bijie.xu@corigine.com>

Correct mismatch between the name of flow_offload_has_one_action()
and its kdoc entry.

Found using ./scripts/kernel-doc -Werror -none include/net/flow_offload.h

Signed-off-by: Bijie Xu <bijie.xu@corigine.com>
Signed-off-by: Simon Horman <simon.horman@corigine.com>
---
 include/net/flow_offload.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/net/flow_offload.h b/include/net/flow_offload.h
index 69c9eabf8325..f3c2841566a0 100644
--- a/include/net/flow_offload.h
+++ b/include/net/flow_offload.h
@@ -293,7 +293,7 @@ static inline bool flow_action_has_entries(const struct flow_action *action)
 }
 
 /**
- * flow_action_has_one_action() - check if exactly one action is present
+ * flow_offload_has_one_action() - check if exactly one action is present
  * @action: tc filter flow offload action
  *
  * Returns true if exactly one action is present.
-- 
2.20.1

[PATCH net-next 2/2] net: sched: provide missing kdoc for tcf_pkt_info and tcf_ematch_ops

[Simon Horman]

From: Bijie Xu <bijie.xu@corigine.com>

Provide missing kdoc of fields of struct tcf_pkt_info and tcf_ematch_ops.

Found using ./scripts/kernel-doc -none -Werror include/net/pkt_cls.h

Signed-off-by: Bijie Xu <bijie.xu@corigine.com>
Signed-off-by: Simon Horman <simon.horman@corigine.com>
---
 include/net/pkt_cls.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/net/pkt_cls.h b/include/net/pkt_cls.h
index dc28fcb6f0a2..1b5100f5e660 100644
--- a/include/net/pkt_cls.h
+++ b/include/net/pkt_cls.h
@@ -329,6 +329,9 @@ int tcf_exts_dump_stats(struct sk_buff *skb, struct tcf_exts *exts);
 
 /**
  * struct tcf_pkt_info - packet information
+ *
+ * @ptr: start of the pkt data
+ * @nexthdr: offset of the next header
  */
 struct tcf_pkt_info {
 	unsigned char *		ptr;
@@ -347,6 +350,7 @@ struct tcf_ematch_ops;
  * @ops: the operations lookup table of the corresponding ematch module
  * @datalen: length of the ematch specific configuration data
  * @data: ematch specific data
+ * @net: the network namespace
  */
 struct tcf_ematch {
 	struct tcf_ematch_ops * ops;
-- 
2.20.1

Re: [PATCH net-next 0/2] net: minor kdoc fixes

[patchwork-bot+netdevbpf]

Hello:

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

On Tue,  3 Aug 2021 11:40:17 +0200 you wrote:
> Hi,
> 
> this short series fixes two kdoc errors that were noticed
> during development.
> 
> Bijie Xu (2):
>   net: flow_offload: correct comments mismatch with code
>   net: sched: provide missing kdoc for tcf_pkt_info and tcf_ematch_ops
> 
> [...]

Here is the summary with links:
  - [net-next,1/2] net: flow_offload: correct comments mismatch with code
    https://git.kernel.org/netdev/net/c/c87a4c542b5a
  - [net-next,2/2] net: sched: provide missing kdoc for tcf_pkt_info and tcf_ematch_ops
    https://git.kernel.org/netdev/net/c/0161d151f3e3

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