Commit 5a867134 authored by Yonghong Song's avatar Yonghong Song Committed by Alexei Starovoitov
Browse files

docs/bpf: Update documentation for BTF_KIND_DECL_TAG typedef support 



Add BTF_KIND_DECL_TAG typedef support in btf.rst.

Signed-off-by: default avatarYonghong Song <yhs@fb.com>
Signed-off-by: default avatarAlexei Starovoitov <ast@kernel.org>
Link: https://lore.kernel.org/bpf/20211021195649.4020514-1-yhs@fb.com
parent 8c18ea2d

Documentation/bpf/btf.rst

+3 −3
Original line number Diff line number Diff line
@@ -474,7 +474,7 @@ No additional type data follow ``btf_type``. 
 * ``info.kind_flag``: 0

 * ``info.kind``: BTF_KIND_DECL_TAG

 * ``info.vlen``: 0

 * ``type``: ``struct``, ``union``, ``func`` or ``var``

 * ``type``: ``struct``, ``union``, ``func``, ``var`` or ``typedef``



``btf_type`` is followed by ``struct btf_decl_tag``.::
@@ -483,8 +483,8 @@ No additional type data follow ``btf_type``. 
    };



The ``name_off`` encodes btf_decl_tag attribute string.

The ``type`` should be ``struct``, ``union``, ``func`` or ``var``.

For ``var`` type, ``btf_decl_tag.component_idx`` must be ``-1``.

The ``type`` should be ``struct``, ``union``, ``func``, ``var`` or ``typedef``.

For ``var`` or ``typedef`` type, ``btf_decl_tag.component_idx`` must be ``-1``.

For the other three types, if the btf_decl_tag attribute is

applied to the ``struct``, ``union`` or ``func`` itself,

``btf_decl_tag.component_idx`` must be ``-1``. Otherwise,