mbox series

[bpf-next,v2,0/2] docs: fix sphinx warnings for cpu+dev maps

Message ID 20221123091520.87289-1-mtahhan@redhat.com (mailing list archive)
Headers show
Series docs: fix sphinx warnings for cpu+dev maps | expand

Message

Maryam Tahhan Nov. 23, 2022, 9:15 a.m. UTC 
From: Maryam Tahhan <mtahhan@redhat.com>

Sphinx version >=3.3 warns about duplicate function declarations in the
CPUMAP and 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.
---
v2:
- Fix references to user space.

---
Maryam Tahhan (2):
  docs: fix sphinx warnings for cpumap
  docs: fix sphinx warnings for devmap

 Documentation/bpf/map_cpumap.rst | 56 +++++++++++++++-----------
 Documentation/bpf/map_devmap.rst | 68 ++++++++++++++++++++------------
 2 files changed, 76 insertions(+), 48 deletions(-)

--
2.34.1