From: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
To: bpf@vger.kernel.org, ast@kernel.org, daniel@iogearbox.net,
martin.lau@kernel.org, andrii@kernel.org
Cc: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>,
linux-kernel-mentees@lists.linux.dev, shuah@kernel.org,
tj@kernel.org, kernel-team@meta.com, memxor@gmail.com
Subject: [PATCH bpf-next] docs: bpf: fix bullet point formatting warning
Date: Tue, 13 May 2025 04:58:59 +0300 [thread overview]
Message-ID: <20250513015901.475207-1-khaledelnaggarlinux@gmail.com> (raw)
Fix indentation for a bullet list item in bpf_iterators.rst.
According to reStructuredText rules, bullet list item bodies must be
consistently indented relative to the bullet. The indentation of the
first line after the bullet determines the alignment for the rest of
the item body.
Reported by smatch:
/linux/Documentation/bpf/bpf_iterators.rst:55: WARNING: Bullet list ends without a blank line; unexpected unindent. [docutils]
Fixes: 7220eabff8cb ("bpf, docs: document open-coded BPF iterators")
Signed-off-by: Khaled Elnaggar <khaledelnaggarlinux@gmail.com>
---
Hello, please let me know if you have any comments, thanks!
---
Documentation/bpf/bpf_iterators.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/bpf/bpf_iterators.rst b/Documentation/bpf/bpf_iterators.rst
index 8f0a4a91b77a..189e3ec1c6c8 100644
--- a/Documentation/bpf/bpf_iterators.rst
+++ b/Documentation/bpf/bpf_iterators.rst
@@ -52,14 +52,14 @@ a pointer to this `struct bpf_iter_<type>` as the very first argument.
Additionally:
- Constructor, i.e., `bpf_iter_<type>_new()`, can have arbitrary extra
- number of arguments. Return type is not enforced either.
+ number of arguments. Return type is not enforced either.
- Next method, i.e., `bpf_iter_<type>_next()`, has to return a pointer
- type and should have exactly one argument: `struct bpf_iter_<type> *`
- (const/volatile/restrict and typedefs are ignored).
+ type and should have exactly one argument: `struct bpf_iter_<type> *`
+ (const/volatile/restrict and typedefs are ignored).
- Destructor, i.e., `bpf_iter_<type>_destroy()`, should return void and
- should have exactly one argument, similar to the next method.
+ should have exactly one argument, similar to the next method.
- `struct bpf_iter_<type>` size is enforced to be positive and
- a multiple of 8 bytes (to fit stack slots correctly).
+ a multiple of 8 bytes (to fit stack slots correctly).
Such strictness and consistency allows to build generic helpers abstracting
important, but boilerplate, details to be able to use open-coded iterators
--
2.47.2
next reply other threads:[~2025-05-13 1:59 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-13 1:58 Khaled Elnaggar [this message]
2025-05-13 16:05 ` [PATCH bpf-next] docs: bpf: fix bullet point formatting warning Andrii Nakryiko
2025-05-13 16:10 ` 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=20250513015901.475207-1-khaledelnaggarlinux@gmail.com \
--to=khaledelnaggarlinux@gmail.com \
--cc=andrii@kernel.org \
--cc=ast@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=daniel@iogearbox.net \
--cc=kernel-team@meta.com \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=martin.lau@kernel.org \
--cc=memxor@gmail.com \
--cc=shuah@kernel.org \
--cc=tj@kernel.org \
/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