public inbox for bpf@vger.kernel.org
 help / color / mirror / Atom feed
From: mtahhan@redhat.com
To: bpf@vger.kernel.org, linux-doc@vger.kernel.org
Cc: jbrouer@redhat.com, thoiland@redhat.com, donhunte@redhat.com,
	akiyks@gmail.com, Maryam Tahhan <mtahhan@redhat.com>
Subject: [PATCH bpf-next v3 0/2] docs: fix sphinx warnings for cpu+dev maps
Date: Wed, 23 Nov 2022 09:23:19 +0000	[thread overview]
Message-ID: <20221123092321.88558-1-mtahhan@redhat.com> (raw)

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


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

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-23  9:23 mtahhan [this message]
2022-11-23  9:23 ` [PATCH bpf-next v3 1/2] docs: fix sphinx warnings for cpumap mtahhan
2022-11-23  9:23 ` [PATCH bpf-next v3 2/2] docs: fix sphinx warnings for devmap mtahhan
2022-11-23 21:40 ` [PATCH bpf-next v3 0/2] docs: fix sphinx warnings for cpu+dev maps patchwork-bot+netdevbpf
2022-11-23 21:50 ` patchwork-bot+netdevbpf

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=20221123092321.88558-1-mtahhan@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