Re: [PATCH bpf-next v1 0/2] docs: fix sphinx warnings for cpu+dev maps

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 23/11/2022 03:13, Akira Yokosawa wrote:
Hi,

On Tue, 22 Nov 2022 10:37:36 +0000, mtahhan@xxxxxxxxxx wrote:
From: Maryam Tahhan <mtahhan@xxxxxxxxxx>

Sphinx version >=3.3 warns about duplicate function delcarations in the

As far as I see, Sphinx >=3.1 complains of these duplicates.

I will update


CPUMAP and DEVMAP documentation. This is because the function name is the
same for Kernel and Userspace 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.
I would mention that the missing support of c:namespace-push:: and
c:namespace-pop:: directives by helper scripts for kernel documentation
prevented you from using the c:function:: directive with proper namespacing.

I will add the note. Thank you.


Either way, for the series,

Reviewed-by: Akira Yokosawa <akiyks@xxxxxxxxx>


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

  Documentation/bpf/map_cpumap.rst | 41 +++++++++++++-----------
  Documentation/bpf/map_devmap.rst | 54 +++++++++++++++++---------------
  2 files changed, 52 insertions(+), 43 deletions(-)

--
2.34.1






[Index of Archives]     [Linux Samsung SoC]     [Linux Rockchip SoC]     [Linux Actions SoC]     [Linux for Synopsys ARC Processors]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]


  Powered by Linux