docs/bpf: Fix sphinx warnings for devmap
authorMaryam Tahhan <mtahhan@redhat.com>
Wed, 23 Nov 2022 09:23:21 +0000 (09:23 +0000)
committerDaniel Borkmann <daniel@iogearbox.net>
Wed, 23 Nov 2022 21:40:27 +0000 (22:40 +0100)
commitc645eee4d35b58bffc90ee086f7a087fa942fd52
treec444555dca1ccd3b926e7893bd2c9e4bbc21ffa6
parent3685b0dc0d02ad89a36893d9d6be1675dd40a5fd
docs/bpf: Fix sphinx warnings for devmap

Sphinx version >=3.1 warns about duplicate function declarations in the
DEVMAP 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-3-mtahhan@redhat.com
Documentation/bpf/map_devmap.rst