bpf: Fix doxygen comments for dynptr slice kfuncs
Subsystems (2)
PATCH 1/2 bpf: Fix doxygen comments for dynptr slice kfuncs
In commit 66e3a13e7c2c ("bpf: Add bpf_dynptr_slice and bpf_dynptr_slice_rdwr"), the bpf_dynptr_slice() and bpf_dynptr_slice_rdwr() kfuncs were added to BPF. These kfuncs included doxygen headers, but unfortunately those headers are not properly formatted according to [0], and causes the following warnings during the docs build:
./kernel/bpf/helpers.c:2225: warning: \
Excess function parameter 'returns' description in 'bpf_dynptr_slice'./kernel/bpf/helpers.c:2303: warning: \
Excess function parameter 'returns' description in 'bpf_dynptr_slice_rdwr'
...
This patch fixes those doxygen comments.
[0]: https://docs.kernel.org/doc-guide/kernel-doc.html#function-documentation
--- kernel/bpf/helpers.c | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-)
kernel/bpf/helpers.c +14 -16
@@ -2194,7 +2194,12 @@ __bpf_kfunc struct task_struct *bpf_task_from_pid(s32 pid) }/** -* bpf_dynptr_slice - Obtain a read-only pointer to the dynptr data. +* bpf_dynptr_slice() - Obtain a read-only pointer to the dynptr data. +* @ptr: The dynptr whose data slice to retrieve +* @offset: Offset into the dynptr +* @buffer: User-provided buffer to copy contents into +* @buffer__szk: Size (in bytes) of the buffer. This is the length of the +* requested slice. This must be a constant. * * For non-skb and non-xdp type dynptrs, there is no difference between * bpf_dynptr_slice and bpf_dynptr_data.
@@ -2209,13 +2214,7 @@ __bpf_kfunc struct task_struct *bpf_task_from_pid(s32 pid)* bpf_dynptr_slice will not invalidate any ctx->data/data_end pointers in * the bpf program. * -* @ptr: The dynptr whose data slice to retrieve -* @offset: Offset into the dynptr -* @buffer: User-provided buffer to copy contents into -* @buffer__szk: Size (in bytes) of the buffer. This is the length of the -* requested slice. This must be a constant. -* -* @returns: NULL if the call failed (eg invalid dynptr), pointer to a read-only +* Return: NULL if the call failed (eg invalid dynptr), pointer to a read-only * data slice (can be either direct pointer to the data or a pointer to the user * provided buffer, with its contents containing the data, if unable to obtain * direct pointer)
@@ -2258,7 +2257,12 @@ __bpf_kfunc void *bpf_dynptr_slice(const struct bpf_dynptr_kern *ptr, u32 offset }/** -* bpf_dynptr_slice_rdwr - Obtain a writable pointer to the dynptr data. +* bpf_dynptr_slice_rdwr() - Obtain a writable pointer to the dynptr data. +* @ptr: The dynptr whose data slice to retrieve +* @offset: Offset into the dynptr +* @buffer: User-provided buffer to copy contents into +* @buffer__szk: Size (in bytes) of the buffer. This is the length of the +* requested slice. This must be a constant. * * For non-skb and non-xdp type dynptrs, there is no difference between * bpf_dynptr_slice and bpf_dynptr_data.
@@ -2287,13 +2291,7 @@ __bpf_kfunc void *bpf_dynptr_slice(const struct bpf_dynptr_kern *ptr, u32 offset* bpf_dynptr_slice_rdwr will not invalidate any ctx->data/data_end pointers in * the bpf program. * -* @ptr: The dynptr whose data slice to retrieve -* @offset: Offset into the dynptr -* @buffer: User-provided buffer to copy contents into -* @buffer__szk: Size (in bytes) of the buffer. This is the length of the -* requested slice. This must be a constant. -* -* @returns: NULL if the call failed (eg invalid dynptr), pointer to a +* Return: NULL if the call failed (eg invalid dynptr), pointer to a * data slice (can be either direct pointer to the data or a pointer to the user * provided buffer, with its contents containing the data, if unable to obtain * direct pointer)
Signature · 1 line
2.39.0
PATCH 2/2 bpf, docs: Fix __uninit kfunc doc section
In commit d96d937d7c5c ("bpf: Add __uninit kfunc annotation"), the __uninit kfunc annotation was documented in kfuncs.rst. You have to fully underline a section in rst, or the build will issue a warning that the title underline is too short:
./Documentation/bpf/kfuncs.rst:104: WARNING: Title underline too short.
2.2.2 __uninit Annotation
--------------------
This patch fixes that title underline.
--- Documentation/bpf/kfuncs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/bpf/kfuncs.rst +1 -1
@@ -101,7 +101,7 @@ size parameter, and the value of the constant matters for program safety, __k suffix should be used. 2.2.2 __uninit Annotation --------------------- +------------------------- This annotation is used to indicate that the argument will be treated as uninitialized.
Signature · 1 line
2.39.0
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Hello:
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Quoted 8 lines · On Wed, 1 Mar 2023 13:49:09 -0600 you wrote:
In commit
66e3a13e7c2c("bpf: Addbpf_dynptr_sliceandbpf_dynptr_slice_rdwr"), thebpf_dynptr_slice()andbpf_dynptr_slice_rdwr()kfuncs were added to BPF. These kfuncs included doxygen headers, but unfortunately those headers are not properly formatted according to [0], and causes the following warnings during the docs build:[...]
Here is the summary with links:
- [bpf-next,1/2] bpf: Fix doxygen comments for dynptr slice kfuncs
https://git.kernel.org/bpf/bpf-next/c/7ce60b110eec - [bpf-next,2/2] bpf, docs: Fix __uninit kfunc doc section https://git.kernel.org/bpf/bpf-next/c/db52b587c67f
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html