docs/bpf: Fix sphinx warnings for cpumap
authorMaryam Tahhan <mtahhan@redhat.com>
Wed, 23 Nov 2022 09:23:20 +0000 (09:23 +0000)
committerDaniel Borkmann <daniel@iogearbox.net>
Wed, 23 Nov 2022 21:38:53 +0000 (22:38 +0100)
commit3685b0dc0d02ad89a36893d9d6be1675dd40a5fd
tree17b4c09e2e4879d0f9aeff82129d23f19cfeebf0
parentc742cb7c3ebdeb358794b9c76d93d8be7b631b9a
docs/bpf: Fix sphinx warnings for cpumap

Sphinx version >=3.1 warns about duplicate function declarations in the
CPUMAP documentation. This is because the function name is the same for
kernel and user space BPF progs but the parameters and return types
they take is what differs. This patch moves from using the ``c:function::``
directive to using the ``code-block:: c`` directive. The patches also fix
the indentation for the text associated with the "new" code block delcarations.
The missing support of c:namespace-push:: and c:namespace-pop:: directives by
helper scripts for kernel documentation prevents using the ``c:function::``
directive with proper namespacing.

Signed-off-by: Maryam Tahhan <mtahhan@redhat.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
Link: https://lore.kernel.org/bpf/20221123092321.88558-2-mtahhan@redhat.com
Documentation/bpf/map_cpumap.rst