BPF List
 help / color / mirror / Atom feed
From: Maryam Tahhan <mtahhan@redhat.com>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: jbrouer@redhat.com, thoiland@redhat.com, donhunte@redhat.com,
	bpf@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH bpf-next v1 0/2] docs: fix sphinx warnings for cpu+dev maps
Date: Wed, 23 Nov 2022 09:25:57 +0000	[thread overview]
Message-ID: <20278f74-ea4a-021f-d184-cb1c4439e65f@redhat.com> (raw)
In-Reply-To: <bf664150-a544-76f8-b61f-98e6472dbebb@gmail.com>

On 23/11/2022 03:13, Akira Yokosawa wrote:
> Hi,
> 
> On Tue, 22 Nov 2022 10:37:36 +0000, mtahhan@redhat.com wrote:
>> From: Maryam Tahhan <mtahhan@redhat.com>
>>
>> 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@gmail.com>
> 
>>
>> 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
>>
> 


      reply	other threads:[~2022-11-23  9:28 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-22 10:37 [PATCH bpf-next v1 0/2] docs: fix sphinx warnings for cpu+dev maps mtahhan
2022-11-22 10:37 ` [PATCH bpf-next v1 1/2] docs: fix sphinx warnings for cpumap mtahhan
2022-11-22 15:19   ` David Vernet
2022-11-22 10:37 ` [PATCH bpf-next v1 2/2] docs: fix sphinx warnings for devmap mtahhan
2022-11-22 15:23   ` David Vernet
2022-11-23  3:13 ` [PATCH bpf-next v1 0/2] docs: fix sphinx warnings for cpu+dev maps Akira Yokosawa
2022-11-23  9:25   ` Maryam Tahhan [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20278f74-ea4a-021f-d184-cb1c4439e65f@redhat.com \
    --to=mtahhan@redhat.com \
    --cc=akiyks@gmail.com \
    --cc=bpf@vger.kernel.org \
    --cc=donhunte@redhat.com \
    --cc=jbrouer@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=thoiland@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox