Skip to contentSkip to conversation

docs/bpf: Fix an incorrect statement in verifier.rst

PATCH Applied Yonghong Song 4 participants 4 messages Jan 11, 2024 – Jan 13, 2024

Subsystems (2)
lore
Share & tools
lore

Yonghong Song

author reviewer
#0 lore raw

PATCH 1/1 docs/bpf: Fix an incorrect statement in verifier.rst

In verifier.rst, I found an incorrect statement (maybe a typo) in section 'Liveness marks tracking'. Basically, the wrong register is attributed to have a read mark. This may confuse the user.

---
 Documentation/bpf/verifier.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/bpf/verifier.rst +1 -1
index f0ec19db301c..356894399fbf 100644
@@ -562,7 +562,7 @@ works::
   * ``checkpoint[0].r1`` is marked as read;
 
 * At instruction #5 exit is reached and ``checkpoint[0]`` can now be processed
-  by ``clean_live_states()``. After this processing ``checkpoint[0].r0`` has a
+  by ``clean_live_states()``. After this processing ``checkpoint[0].r1`` has a
   read mark and all other registers and stack slots are marked as ``NOT_INIT``
   or ``STACK_INVALID``
 
Signature · 1 line
2.34.1
#1 lore raw
Quoted 15 lines · Yonghong Song

In verifier.rst, I found an incorrect statement (maybe a typo) in section 'Liveness marks tracking'. Basically, the wrong register is attributed to have a read mark. This may confuse the user.

---
 Documentation/bpf/verifier.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/bpf/verifier.rst +0 -0
index f0ec19db301c..356894399fbf 100644

Documentation/bpf/verifier.rst works:: · line 567

Quoted 7 lines
Documentation/bpf/verifier.rst +1 -1
@@ -562,7 +562,7 @@ works::
   * ``checkpoint[0].r1`` is marked as read;
 
 * At instruction #5 exit is reached and ``checkpoint[0]`` can now be processed
-  by ``clean_live_states()``. After this processing ``checkpoint[0].r0`` has a
+  by ``clean_live_states()``. After this processing ``checkpoint[0].r1`` has a
   read mark and all other registers and stack slots are marked as ``NOT_INIT``
   or ``STACK_INVALID``

The typo fix looks correct to me.

Eduard,
since you're the author of this line. Pls double check.

maintainer Acked-by
#2 lore raw

On Sat, 2024-01-13 at 14:39 -0800, Alexei Starovoitov wrote:
[...]

Quoted 15 lines

Documentation/bpf/verifier.rst works:: · line 567

Quoted 12 lines
Documentation/bpf/verifier.rst +1 -1
index f0ec19db301c..356894399fbf 100644
@@ -562,7 +562,7 @@ works::
   * ``checkpoint[0].r1`` is marked as read;
 
 * At instruction #5 exit is reached and ``checkpoint[0]`` can now be processed
-  by ``clean_live_states()``. After this processing ``checkpoint[0].r0`` has a
+  by ``clean_live_states()``. After this processing ``checkpoint[0].r1`` has a
   read mark and all other registers and stack slots are marked as ``NOT_INIT``
   or ``STACK_INVALID``

The typo fix looks correct to me.

Quoted 2 lines

Eduard,
since you're the author of this line. Pls double check.

Right, it should be r1, my mistake.

#3 lore raw
In reply to Yonghong Song
This patch was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:

Hello:

This patch was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:

Quoted 8 lines · On Wed, 10 Jan 2024 21:21:36 -0800 you wrote:

In verifier.rst, I found an incorrect statement (maybe a typo) in section 'Liveness marks tracking'. Basically, the wrong register is attributed to have a read mark. This may confuse the user.

---
 Documentation/bpf/verifier.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Here is the summary with links:
- [bpf-next] docs/bpf: Fix an incorrect statement in verifier.rst

    https://git.kernel.org/bpf/bpf-next/c/90bde89658fb

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html