Re: [PATCH] bpf, docs: Add note about type convention

[David Vernet <void@manifault.com>]

On Wed, Jan 25, 2023 at 06:48:27PM +0000, dthaler1968@googlemail.com wrote:
> From: Dave Thaler <dthaler@microsoft.com>
> 
> Add note about type convention

Could you please provide a slightly more descriptive commit summary?

> 
> Signed-off-by: Dave Thaler <dthaler@microsoft.com>
> ---
>  Documentation/bpf/instruction-set.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/Documentation/bpf/instruction-set.rst b/Documentation/bpf/instruction-set.rst
> index 2d3fe59bd26..77990c97b5e 100644
> --- a/Documentation/bpf/instruction-set.rst
> +++ b/Documentation/bpf/instruction-set.rst
> @@ -7,6 +7,11 @@ eBPF Instruction Set Specification, v1.0
>  
>  This document specifies version 1.0 of the eBPF instruction set.
>  
> +Documentation conventions
> +=========================
> +
> +For brevity, this document uses the type notion "u64", "u32", etc.
> +to mean an unsigned integer whose width is the specified number of bits.

Can you use single quotes here to match the convention in the rest of
the file?

>  
>  Registers and calling convention
>  ================================
> @@ -123,6 +128,8 @@ the destination register is unchanged whereas for ``BPF_ALU`` the upper
>  
>    dst_reg = (u32) dst_reg + (u32) src_reg;
>  
> +where '(u32)' indicates that the upper 32 bits are zeroed.
> +
>  ``BPF_ADD | BPF_X | BPF_ALU64`` means::
>  
>    dst_reg = dst_reg + src_reg
> -- 
> 2.33.4
>