All of lore.kernel.org
 help / color / mirror / Atom feed
From: David Vernet <void@manifault.com>
To: Dave Thaler <dthaler1968=40googlemail.com@dmarc.ietf.org>
Cc: bpf@vger.kernel.org, bpf@ietf.org, Dave Thaler <dthaler1968@gmail.com>
Subject: Re: [Bpf] [PATCH bpf-next] bpf, docs: Fix typos in instruction-set.rst
Date: Wed, 21 Feb 2024 12:04:48 -0600	[thread overview]
Message-ID: <20240221180448.GC57258@maniforge> (raw)
In-Reply-To: <20240221173535.16601-1-dthaler1968@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 1625 bytes --]

On Wed, Feb 21, 2024 at 09:35:35AM -0800, Dave Thaler wrote:
> * "BPF ADD" should be "BPF_ADD".
> * "src" should be "src_reg" in several places.  The latter is the field name
>   in the instruction.  The former refers to the value of the register, or the
>   immediate.
> * Add '' around field names in one sentence, for consistency with the rest
>   of the document.
> 
> Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

Thanks for the cleanup.

Acked-by: David Vernet <void@manifault.com>

> ---
>  .../bpf/standardization/instruction-set.rst   | 72 +++++++++----------
>  1 file changed, 36 insertions(+), 36 deletions(-)
> 
> diff --git a/Documentation/bpf/standardization/instruction-set.rst b/Documentation/bpf/standardization/instruction-set.rst
> index 868d9f617..56b5e7dad 100644
> --- a/Documentation/bpf/standardization/instruction-set.rst
> +++ b/Documentation/bpf/standardization/instruction-set.rst
> @@ -178,7 +178,7 @@ Unused fields shall be cleared to zero.
>  As discussed below in `64-bit immediate instructions`_, a 64-bit immediate
>  instruction uses two 32-bit immediate values that are constructed as follows.
>  The 64 bits following the basic instruction contain a pseudo instruction
> -using the same format but with opcode, dst_reg, src_reg, and offset all set to zero,
> +using the same format but with 'opcode', 'dst_reg', 'src_reg', and 'offset' all set to zero,
>  and imm containing the high 32 bits of the immediate value.

nit: Can we make sure these columns are all wrapped to 80 characters?
This can be done in a follow-up for the whole document later.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

WARNING: multiple messages have this Message-ID (diff)
From: David Vernet <void@manifault.com>
To: Dave Thaler <dthaler1968=40googlemail.com@dmarc.ietf.org>
Cc: bpf@vger.kernel.org, bpf@ietf.org, Dave Thaler <dthaler1968@gmail.com>
Subject: Re: [Bpf] [PATCH bpf-next] bpf, docs: Fix typos in instruction-set.rst
Date: Wed, 21 Feb 2024 12:04:48 -0600	[thread overview]
Message-ID: <20240221180448.GC57258@maniforge> (raw)
Message-ID: <20240221180448.wrhySUh9DYFZXpXrXK_YX4HkfU-msxPj7lPoWoc-Eu8@z> (raw)
In-Reply-To: <20240221173535.16601-1-dthaler1968@gmail.com>


[-- Attachment #1.1: Type: text/plain, Size: 1625 bytes --]

On Wed, Feb 21, 2024 at 09:35:35AM -0800, Dave Thaler wrote:
> * "BPF ADD" should be "BPF_ADD".
> * "src" should be "src_reg" in several places.  The latter is the field name
>   in the instruction.  The former refers to the value of the register, or the
>   immediate.
> * Add '' around field names in one sentence, for consistency with the rest
>   of the document.
> 
> Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

Thanks for the cleanup.

Acked-by: David Vernet <void@manifault.com>

> ---
>  .../bpf/standardization/instruction-set.rst   | 72 +++++++++----------
>  1 file changed, 36 insertions(+), 36 deletions(-)
> 
> diff --git a/Documentation/bpf/standardization/instruction-set.rst b/Documentation/bpf/standardization/instruction-set.rst
> index 868d9f617..56b5e7dad 100644
> --- a/Documentation/bpf/standardization/instruction-set.rst
> +++ b/Documentation/bpf/standardization/instruction-set.rst
> @@ -178,7 +178,7 @@ Unused fields shall be cleared to zero.
>  As discussed below in `64-bit immediate instructions`_, a 64-bit immediate
>  instruction uses two 32-bit immediate values that are constructed as follows.
>  The 64 bits following the basic instruction contain a pseudo instruction
> -using the same format but with opcode, dst_reg, src_reg, and offset all set to zero,
> +using the same format but with 'opcode', 'dst_reg', 'src_reg', and 'offset' all set to zero,
>  and imm containing the high 32 bits of the immediate value.

nit: Can we make sure these columns are all wrapped to 80 characters?
This can be done in a follow-up for the whole document later.

[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

[-- Attachment #2: Type: text/plain, Size: 76 bytes --]

-- 
Bpf mailing list
Bpf@ietf.org
https://www.ietf.org/mailman/listinfo/bpf

  reply	other threads:[~2024-02-21 18:04 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-21 17:35 [PATCH bpf-next] bpf, docs: Fix typos in instruction-set.rst Dave Thaler
2024-02-21 17:35 ` [Bpf] " Dave Thaler
2024-02-21 18:04 ` David Vernet [this message]
2024-02-21 18:04   ` David Vernet
2024-02-22 17:09   ` Alexei Starovoitov
2024-02-22 17:09     ` Alexei Starovoitov
2024-02-22 17: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=20240221180448.GC57258@maniforge \
    --to=void@manifault.com \
    --cc=bpf@ietf.org \
    --cc=bpf@vger.kernel.org \
    --cc=dthaler1968=40googlemail.com@dmarc.ietf.org \
    --cc=dthaler1968@gmail.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.