tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

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

authored by

Bagas Sanjaya and committed by
Andrii Nakryiko 25906092 61fc5e66

+4 -4
+4 -4
Documentation/bpf/bpf_design_QA.rst
··· 326 326 kernel releases. The users must adapt their BPF programs to the new changes and 327 327 update them to make sure their programs continue to work correctly. 328 328 329 - NOTE: BPF subsystem specially reserves the 'bpf_' prefix for type names, in 329 + NOTE: BPF subsystem specially reserves the 'bpf\_' prefix for type names, in 330 330 order to introduce more special fields in the future. Hence, user programs must 331 - avoid defining types with 'bpf_' prefix to not be broken in future releases. In 332 - other words, no backwards compatibility is guaranteed if one using a type in BTF 333 - with 'bpf_' prefix. 331 + avoid defining types with 'bpf\_' prefix to not be broken in future releases. 332 + In other words, no backwards compatibility is guaranteed if one using a type 333 + in BTF with 'bpf\_' prefix. 334 334 335 335 Q: What is the compatibility story for special BPF types in local kptrs? 336 336 ------------------------------------------------------------------------