Netdev Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH] bpf: core: fix kernel-doc notation
@ 2021-08-09 21:52 Randy Dunlap
  2021-08-10 11:20 ` patchwork-bot+netdevbpf
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2021-08-09 21:52 UTC (permalink / raw)
  To: netdev
  Cc: Randy Dunlap, Alexei Starovoitov, Daniel Borkmann, Andrii Nakryiko, bpf

Fix kernel-doc warnings in kernel/bpf/core.c (found by
scripts/kernel-doc and W=1 builds).

Correct a function name in a comment and add return descriptions
for 2 functions.

Fixes these kernel-doc warnings:

kernel/bpf/core.c:1372: warning: expecting prototype for __bpf_prog_run(). Prototype was for ___bpf_prog_run() instead
kernel/bpf/core.c:1372: warning: No description found for return value of '___bpf_prog_run'
kernel/bpf/core.c:1883: warning: No description found for return value of 'bpf_prog_select_runtime'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Alexei Starovoitov <ast@kernel.org>
Cc: Daniel Borkmann <daniel@iogearbox.net>
Cc: Andrii Nakryiko <andrii@kernel.org>
Cc: bpf@vger.kernel.org
---
 kernel/bpf/core.c |    7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

--- linux-next-20210806.orig/kernel/bpf/core.c
+++ linux-next-20210806/kernel/bpf/core.c
@@ -1362,11 +1362,13 @@ u64 __weak bpf_probe_read_kernel(void *d
 }
 
 /**
- *	__bpf_prog_run - run eBPF program on a given context
+ *	___bpf_prog_run - run eBPF program on a given context
  *	@regs: is the array of MAX_BPF_EXT_REG eBPF pseudo-registers
  *	@insn: is the array of eBPF instructions
  *
  * Decode and execute eBPF instructions.
+ *
+ * Return: whatever value is in %BPF_R0 at program exit
  */
 static u64 ___bpf_prog_run(u64 *regs, const struct bpf_insn *insn)
 {
@@ -1878,6 +1880,9 @@ static void bpf_prog_select_func(struct
  *
  * Try to JIT eBPF program, if JIT is not available, use interpreter.
  * The BPF program will be executed via BPF_PROG_RUN() macro.
+ *
+ * Return: the &fp argument along with &err set to 0 for success or
+ * a negative errno code on failure
  */
 struct bpf_prog *bpf_prog_select_runtime(struct bpf_prog *fp, int *err)
 {

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] bpf: core: fix kernel-doc notation
  2021-08-09 21:52 [PATCH] bpf: core: fix kernel-doc notation Randy Dunlap
@ 2021-08-10 11:20 ` patchwork-bot+netdevbpf
  0 siblings, 0 replies; 2+ messages in thread
From: patchwork-bot+netdevbpf @ 2021-08-10 11:20 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: netdev, ast, daniel, andrii, bpf

Hello:

This patch was applied to bpf/bpf.git (refs/heads/master):

On Mon,  9 Aug 2021 14:52:29 -0700 you wrote:
> Fix kernel-doc warnings in kernel/bpf/core.c (found by
> scripts/kernel-doc and W=1 builds).
> 
> Correct a function name in a comment and add return descriptions
> for 2 functions.
> 
> Fixes these kernel-doc warnings:
> 
> [...]

Here is the summary with links:
  - bpf: core: fix kernel-doc notation
    https://git.kernel.org/bpf/bpf/c/019d0454c617

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



^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2021-08-10 11:20 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-08-09 21:52 [PATCH] bpf: core: fix kernel-doc notation Randy Dunlap
2021-08-10 11:20 ` patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).