Commit 25906092 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Andrii Nakryiko
Browse files

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: 9805af8d ("bpf: Document UAPI details for special BPF types")
Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: default avatarAndrii Nakryiko <andrii@kernel.org>
Acked-by: default avatarKP Singh <kpsingh@kernel.org>
Acked-by: default avatarDavid Vernet <void@manifault.com>
Link: https://lore.kernel.org/bpf/20221104123913.50610-1-bagasdotme@gmail.com
parent 61fc5e66

Documentation/bpf/bpf_design_QA.rst

+4 −4
Original line number Diff line number Diff line
@@ -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?

------------------------------------------------------------------------