netdev - Re: [PATCH bpf-next] bpf, doc: fix BTF docs reflow of bullet list

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <3fb99ad7-80ea-b821-757e-1837778bd94b@fb.com>
Date:   Mon, 25 Mar 2019 16:08:48 +0000
From:   Andrii Nakryiko <andriin@...com>
To:     Jesper Dangaard Brouer <brouer@...hat.com>,
        "netdev@...r.kernel.org" <netdev@...r.kernel.org>
CC:     Daniel Borkmann <borkmann@...earbox.net>,
        Alexei Starovoitov <ast@...com>
Subject: Re: [PATCH bpf-next] bpf, doc: fix BTF docs reflow of bullet list

On 3/25/19 7:12 AM, Jesper Dangaard Brouer wrote:
> Section 2.2.1 BTF_KIND_INT a bullet list was collapsed due to
> text reflow in commit 9ab5305dbe3f ("docs/btf: reflow text to
> fill up to 78 characters").
>
> This patch correct the mistake. Also adjust next bullet list,
> which is used for comparison, to get rendered the same way.
>
> Fixes: 9ab5305dbe3f ("docs/btf: reflow text to fill up to 78 characters")
> Link: https://www.kernel.org/doc/html/latest/bpf/btf.html#btf-kind-int
> Signed-off-by: Jesper Dangaard Brouer <brouer@...hat.com>
> ---
>  Documentation/bpf/btf.rst |    8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/bpf/btf.rst b/Documentation/bpf/btf.rst
> index 9a60a5d60e38..7313d354f20e 100644
> --- a/Documentation/bpf/btf.rst
> +++ b/Documentation/bpf/btf.rst
> @@ -148,16 +148,16 @@ The ``btf_type.size * 8`` must be equal to or greater than ``BTF_INT_BITS()``
>  for the type. The maximum value of ``BTF_INT_BITS()`` is 128.
>  
>  The ``BTF_INT_OFFSET()`` specifies the starting bit offset to calculate values
> -for this int. For example, a bitfield struct member has: * btf member bit
> -offset 100 from the start of the structure, * btf member pointing to an int
> -type, * the int type has ``BTF_INT_OFFSET() = 2`` and ``BTF_INT_BITS() = 4``
> +for this int. For example, a bitfield struct member has:
> + * btf member bit offset 100 from the start of the structure,
> + * btf member pointing to an int type,
> + * the int type has ``BTF_INT_OFFSET() = 2`` and ``BTF_INT_BITS() = 4``

Oh, missed this one, thanks for fixing!

Acked-by: Andrii Nakryiko <andriin@...com>

>  
>  Then in the struct memory layout, this member will occupy ``4`` bits starting
>  from bits ``100 + 2 = 102``.
>  
>  Alternatively, the bitfield struct member can be the following to access the
>  same bits as the above:
> -
>   * btf member bit offset 102,
>   * btf member pointing to an int type,
>   * the int type has ``BTF_INT_OFFSET() = 0`` and ``BTF_INT_BITS() = 4``
>