diff mbox series

[bpf-next,v1,1/1] docs: fixup cpumap sphinx >= 3.1 warning

Message ID 20221113103327.3287482-1-mtahhan@redhat.com (mailing list archive)
State Accepted
Commit e662c7753668bbfb95e25043c6064088cc3a996d
Delegated to: BPF
Headers show
Series [bpf-next,v1,1/1] docs: fixup cpumap sphinx >= 3.1 warning | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for bpf-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Single patches do not need cover letters
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers warning 12 maintainers not CCed: sdf@google.com kpsingh@kernel.org haoluo@google.com corbet@lwn.net yhs@fb.com daniel@iogearbox.net jolsa@kernel.org martin.lau@linux.dev ast@kernel.org andrii@kernel.org song@kernel.org john.fastabend@gmail.com
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 9 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
bpf/vmtest-bpf-next-VM_Test-4 success Logs for build for s390x with gcc
bpf/vmtest-bpf-next-VM_Test-35 success Logs for test_verifier on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-38 success Logs for test_verifier on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-9 success Logs for test_maps on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-10 success Logs for test_maps on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-12 success Logs for test_maps on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-13 success Logs for test_maps on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-14 fail Logs for test_progs on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-15 fail Logs for test_progs on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-17 success Logs for test_progs on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-18 success Logs for test_progs on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-19 success Logs for test_progs_no_alu32 on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-20 success Logs for test_progs_no_alu32 on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-21 success Logs for test_progs_no_alu32 on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-22 success Logs for test_progs_no_alu32 on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-23 success Logs for test_progs_no_alu32 on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-24 success Logs for test_progs_no_alu32_parallel on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-25 success Logs for test_progs_no_alu32_parallel on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-26 success Logs for test_progs_no_alu32_parallel on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-27 success Logs for test_progs_no_alu32_parallel on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-28 success Logs for test_progs_no_alu32_parallel on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-29 success Logs for test_progs_parallel on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-30 success Logs for test_progs_parallel on aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-31 success Logs for test_progs_parallel on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-32 success Logs for test_progs_parallel on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-33 success Logs for test_progs_parallel on x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-34 success Logs for test_verifier on aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-36 success Logs for test_verifier on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-37 success Logs for test_verifier on x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-16 fail Logs for test_progs on s390x with gcc
bpf/vmtest-bpf-next-VM_Test-11 success Logs for test_maps on s390x with gcc
bpf/vmtest-bpf-next-PR success PR summary
bpf/vmtest-bpf-next-VM_Test-7 success Logs for llvm-toolchain
bpf/vmtest-bpf-next-VM_Test-8 success Logs for set-matrix
bpf/vmtest-bpf-next-VM_Test-2 success Logs for build for aarch64 with gcc
bpf/vmtest-bpf-next-VM_Test-3 success Logs for build for aarch64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-5 success Logs for build for x86_64 with gcc
bpf/vmtest-bpf-next-VM_Test-6 success Logs for build for x86_64 with llvm-16
bpf/vmtest-bpf-next-VM_Test-1 success Logs for ShellCheck

Commit Message

Maryam Tahhan Nov. 13, 2022, 10:33 a.m. UTC
From: Maryam Tahhan <mtahhan@redhat.com>

Fixup bpf_map_update_elem() declaration to use a single line.

Signed-off-by: Maryam Tahhan <mtahhan@redhat.com>
Reported-by: Akira Yokosawa <akiyks@gmail.com>
---
 Documentation/bpf/map_cpumap.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

Comments

Akira Yokosawa Nov. 13, 2022, 11:21 p.m. UTC | #1
On Sun, 13 Nov 2022 05:33:27 -0500, mtahhan@redhat.com wrote:
> From: Maryam Tahhan <mtahhan@redhat.com>
> 
> Fixup bpf_map_update_elem() declaration to use a single line.
> 
> Signed-off-by: Maryam Tahhan <mtahhan@redhat.com>
> Reported-by: Akira Yokosawa <akiyks@gmail.com>
Tested-by: Akira Yokosawa <akiyks@gmail.com>

        Thanks, Akira
> ---
>  Documentation/bpf/map_cpumap.rst | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/Documentation/bpf/map_cpumap.rst b/Documentation/bpf/map_cpumap.rst
> index eaf57b38cafd..61a797a86342 100644
> --- a/Documentation/bpf/map_cpumap.rst
> +++ b/Documentation/bpf/map_cpumap.rst
> @@ -48,8 +48,7 @@ Userspace
>      program will result in the program failing to load and a verifier warning.
>  
>  .. c:function::
> -    int bpf_map_update_elem(int fd, const void *key, const void *value,
> -                   __u64 flags);
> +    int bpf_map_update_elem(int fd, const void *key, const void *value, __u64 flags);
>  
>   CPU entries can be added or updated using the ``bpf_map_update_elem()``
>   helper. This helper replaces existing elements atomically. The ``value`` parameter
Stanislav Fomichev Nov. 14, 2022, 5:22 p.m. UTC | #2
On 11/13, mtahhan@redhat.com wrote:
> From: Maryam Tahhan <mtahhan@redhat.com>

> Fixup bpf_map_update_elem() declaration to use a single line.

> Signed-off-by: Maryam Tahhan <mtahhan@redhat.com>
> Reported-by: Akira Yokosawa <akiyks@gmail.com>

Acked-by: Stanislav Fomichev <sdf@google.com>

> ---
>   Documentation/bpf/map_cpumap.rst | 3 +--
>   1 file changed, 1 insertion(+), 2 deletions(-)

> diff --git a/Documentation/bpf/map_cpumap.rst  
> b/Documentation/bpf/map_cpumap.rst
> index eaf57b38cafd..61a797a86342 100644
> --- a/Documentation/bpf/map_cpumap.rst
> +++ b/Documentation/bpf/map_cpumap.rst
> @@ -48,8 +48,7 @@ Userspace
>       program will result in the program failing to load and a verifier  
> warning.

>   .. c:function::
> -    int bpf_map_update_elem(int fd, const void *key, const void *value,
> -                   __u64 flags);
> +    int bpf_map_update_elem(int fd, const void *key, const void *value,  
> __u64 flags);

>    CPU entries can be added or updated using the ``bpf_map_update_elem()``
>    helper. This helper replaces existing elements atomically. The  
> ``value`` parameter
> --
> 2.35.3
patchwork-bot+netdevbpf@kernel.org Nov. 14, 2022, 6:20 p.m. UTC | #3
Hello:

This patch was applied to bpf/bpf-next.git (master)
by Daniel Borkmann <daniel@iogearbox.net>:

On Sun, 13 Nov 2022 05:33:27 -0500 you wrote:
> From: Maryam Tahhan <mtahhan@redhat.com>
> 
> Fixup bpf_map_update_elem() declaration to use a single line.
> 
> Signed-off-by: Maryam Tahhan <mtahhan@redhat.com>
> Reported-by: Akira Yokosawa <akiyks@gmail.com>
> 
> [...]

Here is the summary with links:
  - [bpf-next,v1,1/1] docs: fixup cpumap sphinx >= 3.1 warning
    https://git.kernel.org/bpf/bpf-next/c/e662c7753668

You are awesome, thank you!
diff mbox series

Patch

diff --git a/Documentation/bpf/map_cpumap.rst b/Documentation/bpf/map_cpumap.rst
index eaf57b38cafd..61a797a86342 100644
--- a/Documentation/bpf/map_cpumap.rst
+++ b/Documentation/bpf/map_cpumap.rst
@@ -48,8 +48,7 @@  Userspace
     program will result in the program failing to load and a verifier warning.
 
 .. c:function::
-    int bpf_map_update_elem(int fd, const void *key, const void *value,
-                   __u64 flags);
+    int bpf_map_update_elem(int fd, const void *key, const void *value, __u64 flags);
 
  CPU entries can be added or updated using the ``bpf_map_update_elem()``
  helper. This helper replaces existing elements atomically. The ``value`` parameter