Skip to content

Commit f52c97d

Browse files
netoptimizerAlexei Starovoitov
authored andcommitted
bpf, doc: fix BTF docs reflow of bullet list
Section 2.2.1 BTF_KIND_INT a bullet list was collapsed due to text reflow in commit 9ab5305 ("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: 9ab5305 ("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@redhat.com> Acked-by: Andrii Nakryiko <andriin@fb.com> Signed-off-by: Alexei Starovoitov <ast@kernel.org>
1 parent 61777f3 commit f52c97d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Documentation/bpf/btf.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -148,16 +148,16 @@ The ``btf_type.size * 8`` must be equal to or greater than ``BTF_INT_BITS()``
148148
for the type. The maximum value of ``BTF_INT_BITS()`` is 128.
149149

150150
The ``BTF_INT_OFFSET()`` specifies the starting bit offset to calculate values
151-
for this int. For example, a bitfield struct member has: * btf member bit
152-
offset 100 from the start of the structure, * btf member pointing to an int
153-
type, * the int type has ``BTF_INT_OFFSET() = 2`` and ``BTF_INT_BITS() = 4``
151+
for this int. For example, a bitfield struct member has:
152+
* btf member bit offset 100 from the start of the structure,
153+
* btf member pointing to an int type,
154+
* the int type has ``BTF_INT_OFFSET() = 2`` and ``BTF_INT_BITS() = 4``
154155

155156
Then in the struct memory layout, this member will occupy ``4`` bits starting
156157
from bits ``100 + 2 = 102``.
157158

158159
Alternatively, the bitfield struct member can be the following to access the
159160
same bits as the above:
160-
161161
* btf member bit offset 102,
162162
* btf member pointing to an int type,
163163
* the int type has ``BTF_INT_OFFSET() = 0`` and ``BTF_INT_BITS() = 4``

0 commit comments

Comments
 (0)