* [PATCH bpf-next] bpftool: Add missing blank lines in bpftool-net doc example
@ 2024-09-01 21:07 Quentin Monnet
2024-09-02 16:30 ` patchwork-bot+netdevbpf
0 siblings, 1 reply; 2+ messages in thread
From: Quentin Monnet @ 2024-09-01 21:07 UTC (permalink / raw)
To: Alexei Starovoitov, Daniel Borkmann, Andrii Nakryiko
Cc: Martin KaFai Lau, Eduard Zingerman, Song Liu, Yonghong Song,
John Fastabend, KP Singh, Stanislav Fomichev, Hao Luo, Jiri Olsa,
bpf, Quentin Monnet
In bpftool-net documentation, two blank lines are missing in a
recently added example, causing docutils to complain:
$ cd tools/bpf/bpftool
$ make doc
DESCEND Documentation
GEN bpftool-btf.8
GEN bpftool-cgroup.8
GEN bpftool-feature.8
GEN bpftool-gen.8
GEN bpftool-iter.8
GEN bpftool-link.8
GEN bpftool-map.8
GEN bpftool-net.8
<stdin>:189: (INFO/1) Possible incomplete section title.
Treating the overline as ordinary text because it's so short.
<stdin>:192: (INFO/1) Blank line missing before literal block (after the "::")? Interpreted as a definition list item.
<stdin>:199: (INFO/1) Possible incomplete section title.
Treating the overline as ordinary text because it's so short.
<stdin>:201: (INFO/1) Blank line missing before literal block (after the "::")? Interpreted as a definition list item.
GEN bpftool-perf.8
GEN bpftool-prog.8
GEN bpftool.8
GEN bpftool-struct_ops.8
Add the missing blank lines.
Fixes: 0d7c06125cea ("bpftool: Add document for net attach/detach on tcx subcommand")
Signed-off-by: Quentin Monnet <qmo@kernel.org>
---
tools/bpf/bpftool/Documentation/bpftool-net.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/tools/bpf/bpftool/Documentation/bpftool-net.rst b/tools/bpf/bpftool/Documentation/bpftool-net.rst
index 4a8cb5e0d94b..a9ed8992800f 100644
--- a/tools/bpf/bpftool/Documentation/bpftool-net.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-net.rst
@@ -187,6 +187,7 @@ EXAMPLES
|
::
+
tc:
lo(1) tcx/ingress tc_prog prog_id 29
@@ -197,4 +198,5 @@ EXAMPLES
|
::
+
tc:
--
2.43.0
^ permalink raw reply related [flat|nested] 2+ messages in thread* Re: [PATCH bpf-next] bpftool: Add missing blank lines in bpftool-net doc example
2024-09-01 21:07 [PATCH bpf-next] bpftool: Add missing blank lines in bpftool-net doc example Quentin Monnet
@ 2024-09-02 16:30 ` patchwork-bot+netdevbpf
0 siblings, 0 replies; 2+ messages in thread
From: patchwork-bot+netdevbpf @ 2024-09-02 16:30 UTC (permalink / raw)
To: Quentin Monnet
Cc: ast, daniel, andrii, martin.lau, eddyz87, song, yonghong.song,
john.fastabend, kpsingh, sdf, haoluo, jolsa, bpf
Hello:
This patch was applied to bpf/bpf-next.git (master)
by Daniel Borkmann <daniel@iogearbox.net>:
On Sun, 1 Sep 2024 22:07:42 +0100 you wrote:
> In bpftool-net documentation, two blank lines are missing in a
> recently added example, causing docutils to complain:
>
> $ cd tools/bpf/bpftool
> $ make doc
> DESCEND Documentation
> GEN bpftool-btf.8
> GEN bpftool-cgroup.8
> GEN bpftool-feature.8
> GEN bpftool-gen.8
> GEN bpftool-iter.8
> GEN bpftool-link.8
> GEN bpftool-map.8
> GEN bpftool-net.8
> <stdin>:189: (INFO/1) Possible incomplete section title.
> Treating the overline as ordinary text because it's so short.
> <stdin>:192: (INFO/1) Blank line missing before literal block (after the "::")? Interpreted as a definition list item.
> <stdin>:199: (INFO/1) Possible incomplete section title.
> Treating the overline as ordinary text because it's so short.
> <stdin>:201: (INFO/1) Blank line missing before literal block (after the "::")? Interpreted as a definition list item.
> GEN bpftool-perf.8
> GEN bpftool-prog.8
> GEN bpftool.8
> GEN bpftool-struct_ops.8
>
> [...]
Here is the summary with links:
- [bpf-next] bpftool: Add missing blank lines in bpftool-net doc example
https://git.kernel.org/bpf/bpf-next/c/5d2784e25d7a
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2024-09-02 16:30 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-09-01 21:07 [PATCH bpf-next] bpftool: Add missing blank lines in bpftool-net doc example Quentin Monnet
2024-09-02 16:30 ` patchwork-bot+netdevbpf
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox