[PATCH bpf-next] bpf, docs: Clarify call local offset

[PATCH bpf-next] bpf, docs: Clarify call local offset

[Dave Thaler]

In the Jump instructions section it explains that the offset is
"relative to the instruction following the jump instruction".
But the program-local section confusingly said "referenced by
offset from the call instruction, similar to JA".

This patch updates that sentence with consistent wording, saying
it's relative to the instruction following the call instruction.

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>
---
 Documentation/bpf/standardization/instruction-set.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/bpf/standardization/instruction-set.rst b/Documentation/bpf/standardization/instruction-set.rst
index 00c93eb42..6bb5ae7e4 100644
--- a/Documentation/bpf/standardization/instruction-set.rst
+++ b/Documentation/bpf/standardization/instruction-set.rst
@@ -520,7 +520,7 @@ identifies the helper name and type.
 Program-local functions
 ~~~~~~~~~~~~~~~~~~~~~~~
 Program-local functions are functions exposed by the same BPF program as the
-caller, and are referenced by offset from the call instruction, similar to
+caller, and are referenced by offset from the instruction following the call instruction, similar to
 ``JA``.  The offset is encoded in the 'imm' field of the call instruction.
 An ``EXIT`` within the program-local function will return to the caller.
 
-- 
2.40.1

[Bpf] [PATCH bpf-next] bpf, docs: Clarify call local offset

[Dave Thaler]

In the Jump instructions section it explains that the offset is
"relative to the instruction following the jump instruction".
But the program-local section confusingly said "referenced by
offset from the call instruction, similar to JA".

This patch updates that sentence with consistent wording, saying
it's relative to the instruction following the call instruction.

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>
---
 Documentation/bpf/standardization/instruction-set.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/bpf/standardization/instruction-set.rst b/Documentation/bpf/standardization/instruction-set.rst
index 00c93eb42..6bb5ae7e4 100644
--- a/Documentation/bpf/standardization/instruction-set.rst
+++ b/Documentation/bpf/standardization/instruction-set.rst
@@ -520,7 +520,7 @@ identifies the helper name and type.
 Program-local functions
 ~~~~~~~~~~~~~~~~~~~~~~~
 Program-local functions are functions exposed by the same BPF program as the
-caller, and are referenced by offset from the call instruction, similar to
+caller, and are referenced by offset from the instruction following the call instruction, similar to
 ``JA``.  The offset is encoded in the 'imm' field of the call instruction.
 An ``EXIT`` within the program-local function will return to the caller.
 
-- 
2.40.1

-- 
Bpf mailing list -- bpf@ietf.org
To unsubscribe send an email to bpf-leave@ietf.org

Re: [PATCH bpf-next] bpf, docs: Clarify call local offset

[Yonghong Song]

On 5/25/24 9:33 AM, Dave Thaler wrote:
> In the Jump instructions section it explains that the offset is
> "relative to the instruction following the jump instruction".
> But the program-local section confusingly said "referenced by
> offset from the call instruction, similar to JA".
>
> This patch updates that sentence with consistent wording, saying
> it's relative to the instruction following the call instruction.
>
> Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

Acked-by: Yonghong Song <yonghong.song@linux.dev>

[Bpf] Re: [PATCH bpf-next] bpf, docs: Clarify call local offset

[Yonghong Song]

On 5/25/24 9:33 AM, Dave Thaler wrote:
> In the Jump instructions section it explains that the offset is
> "relative to the instruction following the jump instruction".
> But the program-local section confusingly said "referenced by
> offset from the call instruction, similar to JA".
>
> This patch updates that sentence with consistent wording, saying
> it's relative to the instruction following the call instruction.
>
> Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

Acked-by: Yonghong Song <yonghong.song@linux.dev>

-- 
Bpf mailing list -- bpf@ietf.org
To unsubscribe send an email to bpf-leave@ietf.org

Re: [PATCH bpf-next] bpf, docs: Clarify call local offset

[Alexei Starovoitov]

On Sat, May 25, 2024 at 8:33 AM Dave Thaler <dthaler1968@googlemail.com> wrote:
>
> In the Jump instructions section it explains that the offset is
> "relative to the instruction following the jump instruction".
> But the program-local section confusingly said "referenced by
> offset from the call instruction, similar to JA".
>
> This patch updates that sentence with consistent wording, saying
> it's relative to the instruction following the call instruction.
>
> Signed-off-by: Dave Thaler <dthaler1968@gmail.com>
> ---
>  Documentation/bpf/standardization/instruction-set.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/bpf/standardization/instruction-set.rst b/Documentation/bpf/standardization/instruction-set.rst
> index 00c93eb42..6bb5ae7e4 100644
> --- a/Documentation/bpf/standardization/instruction-set.rst
> +++ b/Documentation/bpf/standardization/instruction-set.rst
> @@ -520,7 +520,7 @@ identifies the helper name and type.
>  Program-local functions
>  ~~~~~~~~~~~~~~~~~~~~~~~
>  Program-local functions are functions exposed by the same BPF program as the
> -caller, and are referenced by offset from the call instruction, similar to
> +caller, and are referenced by offset from the instruction following the call instruction, similar to
>  ``JA``.  The offset is encoded in the 'imm' field of the call instruction.
>  An ``EXIT`` within the program-local function will return to the caller.

I reformatted a few following lines to make it fit into 80 col while
applying. Thanks!

[Bpf] Re: [PATCH bpf-next] bpf, docs: Clarify call local offset

[Alexei Starovoitov]

On Sat, May 25, 2024 at 8:33 AM Dave Thaler <dthaler1968@googlemail.com> wrote:
>
> In the Jump instructions section it explains that the offset is
> "relative to the instruction following the jump instruction".
> But the program-local section confusingly said "referenced by
> offset from the call instruction, similar to JA".
>
> This patch updates that sentence with consistent wording, saying
> it's relative to the instruction following the call instruction.
>
> Signed-off-by: Dave Thaler <dthaler1968@gmail.com>
> ---
>  Documentation/bpf/standardization/instruction-set.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/bpf/standardization/instruction-set.rst b/Documentation/bpf/standardization/instruction-set.rst
> index 00c93eb42..6bb5ae7e4 100644
> --- a/Documentation/bpf/standardization/instruction-set.rst
> +++ b/Documentation/bpf/standardization/instruction-set.rst
> @@ -520,7 +520,7 @@ identifies the helper name and type.
>  Program-local functions
>  ~~~~~~~~~~~~~~~~~~~~~~~
>  Program-local functions are functions exposed by the same BPF program as the
> -caller, and are referenced by offset from the call instruction, similar to
> +caller, and are referenced by offset from the instruction following the call instruction, similar to
>  ``JA``.  The offset is encoded in the 'imm' field of the call instruction.
>  An ``EXIT`` within the program-local function will return to the caller.

I reformatted a few following lines to make it fit into 80 col while
applying. Thanks!

-- 
Bpf mailing list -- bpf@ietf.org
To unsubscribe send an email to bpf-leave@ietf.org

Re: [PATCH bpf-next] bpf, docs: Clarify call local offset

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to bpf/bpf-next.git (master)
by Alexei Starovoitov <ast@kernel.org>:

On Sat, 25 May 2024 08:33:32 -0700 you wrote:
> In the Jump instructions section it explains that the offset is
> "relative to the instruction following the jump instruction".
> But the program-local section confusingly said "referenced by
> offset from the call instruction, similar to JA".
> 
> This patch updates that sentence with consistent wording, saying
> it's relative to the instruction following the call instruction.
> 
> [...]

Here is the summary with links:
  - [bpf-next] bpf, docs: Clarify call local offset
    https://git.kernel.org/bpf/bpf-next/c/f980f13e4eb2

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html