docs/bpf: Update documentation for BTF_KIND_DECL_TAG typedef support
authorYonghong Song <yhs@fb.com>
Thu, 21 Oct 2021 19:56:49 +0000 (12:56 -0700)
committerAlexei Starovoitov <ast@kernel.org>
Sat, 23 Oct 2021 00:04:44 +0000 (17:04 -0700)
Add BTF_KIND_DECL_TAG typedef support in btf.rst.

Signed-off-by: Yonghong Song <yhs@fb.com>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Link: https://lore.kernel.org/bpf/20211021195649.4020514-1-yhs@fb.com
Documentation/bpf/btf.rst

index 9e5b4a98af76bc55e45773d93404a75bb301cd01..9ad4218a751f569c2741fb5c6228fc8889a8a597 100644 (file)
@@ -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,