Skip to content

Commit 019d045

Browse files
rddunlapborkmann
authored andcommitted
bpf, core: Fix kernel-doc notation
Fix kernel-doc warnings in kernel/bpf/core.c (found by scripts/kernel-doc and W=1 builds). That is, 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 <[email protected]> Signed-off-by: Daniel Borkmann <[email protected]> Link: https://lore.kernel.org/bpf/[email protected]
1 parent a2baf4e commit 019d045

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

kernel/bpf/core.c

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1362,11 +1362,13 @@ u64 __weak bpf_probe_read_kernel(void *dst, u32 size, const void *unsafe_ptr)
13621362
}
13631363

13641364
/**
1365-
* __bpf_prog_run - run eBPF program on a given context
1365+
* ___bpf_prog_run - run eBPF program on a given context
13661366
* @regs: is the array of MAX_BPF_EXT_REG eBPF pseudo-registers
13671367
* @insn: is the array of eBPF instructions
13681368
*
13691369
* Decode and execute eBPF instructions.
1370+
*
1371+
* Return: whatever value is in %BPF_R0 at program exit
13701372
*/
13711373
static u64 ___bpf_prog_run(u64 *regs, const struct bpf_insn *insn)
13721374
{
@@ -1878,6 +1880,9 @@ static void bpf_prog_select_func(struct bpf_prog *fp)
18781880
*
18791881
* Try to JIT eBPF program, if JIT is not available, use interpreter.
18801882
* The BPF program will be executed via BPF_PROG_RUN() macro.
1883+
*
1884+
* Return: the &fp argument along with &err set to 0 for success or
1885+
* a negative errno code on failure
18811886
*/
18821887
struct bpf_prog *bpf_prog_select_runtime(struct bpf_prog *fp, int *err)
18831888
{

0 commit comments

Comments
 (0)