| Message ID | 20221123092321.88558-1-mtahhan@redhat.com (mailing list archive) |
|---|---|
| Headers | show |
| Series | docs: fix sphinx warnings for cpu+dev maps | expand |
Hello: This series was applied to bpf/bpf-next.git (master) by Daniel Borkmann <daniel@iogearbox.net>: On Wed, 23 Nov 2022 09:23:19 +0000 you wrote: > From: Maryam Tahhan <mtahhan@redhat.com> > > 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. > > [...] Here is the summary with links: - [bpf-next,v3,1/2] docs: fix sphinx warnings for cpumap https://git.kernel.org/bpf/bpf-next/c/3685b0dc0d02 - [bpf-next,v3,2/2] docs: fix sphinx warnings for devmap (no matching commit) You are awesome, thank you!
Hello: This series was applied to bpf/bpf-next.git (master) by Daniel Borkmann <daniel@iogearbox.net>: On Wed, 23 Nov 2022 09:23:19 +0000 you wrote: > From: Maryam Tahhan <mtahhan@redhat.com> > > 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. > > [...] Here is the summary with links: - [bpf-next,v3,1/2] docs: fix sphinx warnings for cpumap (no matching commit) - [bpf-next,v3,2/2] docs: fix sphinx warnings for devmap https://git.kernel.org/bpf/bpf-next/c/c645eee4d35b You are awesome, thank you!
From: Maryam Tahhan <mtahhan@redhat.com> 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