diff options
| author | Bagas Sanjaya <bagasdotme@gmail.com> | 2022-11-04 19:39:14 +0700 |
|---|---|---|
| committer | Andrii Nakryiko <andrii@kernel.org> | 2022-11-04 16:10:07 -0700 |
| commit | 25906092edb4bcf94cb669bd1ed03a0ef2f4120c (patch) | |
| tree | 1c44a5d180b94538521a83162fef8dbbf1dffdb4 /Documentation/bpf/bpf_design_QA.rst | |
| parent | 61fc5e66f755db24d27ba37ce1ee4873def1a074 (diff) | |
| download | linux-25906092edb4bcf94cb669bd1ed03a0ef2f4120c.tar.gz linux-25906092edb4bcf94cb669bd1ed03a0ef2f4120c.tar.bz2 linux-25906092edb4bcf94cb669bd1ed03a0ef2f4120c.zip | |
Documentation: bpf: Escape underscore in BPF type name prefix
Sphinx reported unknown target warning:
Documentation/bpf/bpf_design_QA.rst:329: WARNING: Unknown target name: "bpf".
The warning is caused by BPF type name prefix ("bpf_") which is written
without escaping the trailing underscore.
Escape the underscore to fix the warning. While at it, wrap the
containing paragraph in less than 80 characters.
Fixes: 9805af8d8a5b17 ("bpf: Document UAPI details for special BPF types")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Acked-by: KP Singh <kpsingh@kernel.org>
Acked-by: David Vernet <void@manifault.com>
Link: https://lore.kernel.org/bpf/20221104123913.50610-1-bagasdotme@gmail.com
Diffstat (limited to 'Documentation/bpf/bpf_design_QA.rst')
| -rw-r--r-- | Documentation/bpf/bpf_design_QA.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/bpf/bpf_design_QA.rst b/Documentation/bpf/bpf_design_QA.rst index 4e4af398607b..17e774d96c5e 100644 --- a/Documentation/bpf/bpf_design_QA.rst +++ b/Documentation/bpf/bpf_design_QA.rst @@ -326,11 +326,11 @@ size, type, and alignment, or any other user visible API or ABI detail across kernel releases. The users must adapt their BPF programs to the new changes and update them to make sure their programs continue to work correctly. -NOTE: BPF subsystem specially reserves the 'bpf_' prefix for type names, in +NOTE: BPF subsystem specially reserves the 'bpf\_' prefix for type names, in order to introduce more special fields in the future. Hence, user programs must -avoid defining types with 'bpf_' prefix to not be broken in future releases. In -other words, no backwards compatibility is guaranteed if one using a type in BTF -with 'bpf_' prefix. +avoid defining types with 'bpf\_' prefix to not be broken in future releases. +In other words, no backwards compatibility is guaranteed if one using a type +in BTF with 'bpf\_' prefix. Q: What is the compatibility story for special BPF types in local kptrs? ------------------------------------------------------------------------ |