docs: fix sphinx warnings for cpu+dev maps
Get series with b4
b4 am [email protected]Versions newest first · linked by author and title
- v3 Latest2 patches 0 repliesApplied 2/2
- v22 patches 0 repliesSuperseded
- v12 patches 4 repliesSuperseded
Changes in v3 from the cover letter
- Update Sphinx version to 3.1.
- Add note about namespacing.
Patches in v3 All 2 applied
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/2 | docs: fix sphinx warnings for cpumapDocumentation/ | +34 | 0 replies | Applied |
| 2/2 | docs: fix sphinx warnings for devmapDocumentation/ | +42 | 0 replies | Applied |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v3 yet.
Cover letter [PATCH bpf-next v3 0/2] docs: fix sphinx warnings for cpu+dev maps
From: Maryam Tahhan <[email protected]>
Sphinx version >=3.1 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. 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.
---
v3:
- Update Sphinx version to 3.1.
- Add note about namespacing.
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