docs: bpf: add minimal markup to address doc warning
Subsystems (5)
PATCH 1/1 docs: bpf: add minimal markup to address doc warning
Commit 91c960b00566 ("bpf: Rename BPF_XADD and prepare to encode other atomics in .imm") modified the BPF documentation, but missed some ReST markup.
Hence, make htmldocs warns on Documentation/networking/filter.rst:1053:
WARNING: Inline emphasis start-string without end-string.
Add some minimal markup to address this warning.
---
applies cleanly on next-20210118
Brendan, please ack.
Alexei, please pick this minor cleanup patch on your bpf-next.
Documentation/networking/filter.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/networking/filter.rst +2 -2
@@ -1048,12 +1048,12 @@ Unlike classic BPF instruction set, eBPF has generic load/store operations:: Where size is one of: BPF_B or BPF_H or BPF_W or BPF_DW. It also includes atomic operations, which use the immediate field for extra -encoding. +encoding:: .imm = BPF_ADD, .code = BPF_ATOMIC | BPF_W | BPF_STX: lock xadd *(u32 *)(dst_reg + off16) += src_reg .imm = BPF_ADD, .code = BPF_ATOMIC | BPF_DW | BPF_STX: lock xadd *(u64 *)(dst_reg + off16) += src_reg -The basic atomic operations supported are: +The basic atomic operations supported are:: BPF_ADD BPF_AND
Signature · 1 line
2.17.1
Thanks Lukas. Sorry I didn't get around to fixing it so far.
Quoted 5 lines · Lukas Bulwahn
Commit
91c960b00566("bpf: RenameBPF_XADDand prepare to encode other atomics in .imm") modified the BPF documentation, but missed some ReST markup.
Quoted 7 lines
Hence, make htmldocs warns on
Documentation/networking/filter.rst:1053:WARNING: Inline emphasis start-string without end-string.
Add some minimal markup to address this warning.
Signed-off-by Lukas Bulwahn <[email protected]>
Quoted 33 lines
---
applies cleanly on next-20210118Brendan, please ack.
Alexei, please pick this minor cleanup patch on your bpf-next.
Documentation/networking/filter.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)Documentation/networking/filter.rst +2
-3@@ -1048,12 +1048,12 @@ Unlike classic BPF instruction set, eBPF has generic load/store operations:: Where size is one of: BPF_B or BPF_H or BPF_W or BPF_DW. It also includes atomic operations, which use the immediate field for extra -encoding. +encoding:: .imm = BPF_ADD, .code = BPF_ATOMIC | BPF_W | BPF_STX: lock xadd *(u32 *)(dst_reg + off16) += src_reg .imm = BPF_ADD, .code = BPF_ATOMIC | BPF_DW | BPF_STX: lock xadd *(u64 *)(dst_reg + off16) += src_reg -The basic atomic operations supported are: +The basic atomic operations supported are:: BPF_ADD BPF_AND --2.17.1
This patch was applied to bpf/bpf-next.git (refs/heads/master):
Hello:
This patch was applied to bpf/bpf-next.git (refs/heads/master):
Quoted 9 lines · On Mon, 18 Jan 2021 09:00:04 +0100 you wrote:
Commit
91c960b00566("bpf: RenameBPF_XADDand prepare to encode other atomics in .imm") modified the BPF documentation, but missed some ReST markup.Hence, make htmldocs warns on
Documentation/networking/filter.rst:1053:WARNING: Inline emphasis start-string without end-string.
[...]
Here is the summary with links:
- [for,bpf-next] docs: bpf: add minimal markup to address doc warning
https://git.kernel.org/bpf/bpf-next/c/95204c9bfa48
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html