diff mbox series

bpf: core: fix kernel-doc notation

Message ID 20210809215229.7556-1-rdunlap@infradead.org
State New
Headers show
Series bpf: core: fix kernel-doc notation | expand

Commit Message

Randy Dunlap Aug. 9, 2021, 9:52 p.m. UTC 
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(-)

Comments

patchwork-bot+netdevbpf@kernel.org Aug. 10, 2021, 11:20 a.m. UTC | #1 
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
diff mbox series

Patch

--- 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)
 {