[bpf-next,v3] docs/bpf: Update btf selftests program and add link

Message ID tencent_C597352AB3AF24A35A88CC06A3421E590B08@qq.com
State New
Headers
Series [bpf-next,v3] docs/bpf: Update btf selftests program and add link |

Commit Message

Rong Tao Nov. 21, 2022, 2:02 p.m. UTC
  From: Rong Tao <rongtao@cestc.cn>

commit c64779e24e88("selftests/bpf: Merge most of test_btf into
test_progs") rename selftests/bpf btf test from 'test_btf.c' to
'prog_tests/btf.c'.

Signed-off-by: Rong Tao <rongtao@cestc.cn>
---
v3: v2 -> v3
    s/Kernel bpf selftest/The kernel BPF selftest
    s/provides extensive/provides an extensive
v2: https://lore.kernel.org/lkml/tencent_114656E8259D0AEA2BDB6810E29241995006@qq.com/
v1: https://lore.kernel.org/lkml/tencent_7F84D04F96EBE594CAD5EBD12815A2B00106@qq.com/
---
 Documentation/bpf/btf.rst | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
  

Comments

David Vernet Nov. 21, 2022, 3:06 p.m. UTC | #1
On Mon, Nov 21, 2022 at 10:02:39PM +0800, Rong Tao wrote:
> From: Rong Tao <rongtao@cestc.cn>
> 
> commit c64779e24e88("selftests/bpf: Merge most of test_btf into
> test_progs") rename selftests/bpf btf test from 'test_btf.c' to
> 'prog_tests/btf.c'.
> 
> Signed-off-by: Rong Tao <rongtao@cestc.cn>
> ---
> v3: v2 -> v3
>     s/Kernel bpf selftest/The kernel BPF selftest
>     s/provides extensive/provides an extensive
> v2: https://lore.kernel.org/lkml/tencent_114656E8259D0AEA2BDB6810E29241995006@qq.com/
> v1: https://lore.kernel.org/lkml/tencent_7F84D04F96EBE594CAD5EBD12815A2B00106@qq.com/
> ---
>  Documentation/bpf/btf.rst | 7 ++++++-
>  1 file changed, 6 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/bpf/btf.rst b/Documentation/bpf/btf.rst
> index cf8722f96090..681416c86e81 100644
> --- a/Documentation/bpf/btf.rst
> +++ b/Documentation/bpf/btf.rst
> @@ -1062,4 +1062,9 @@ format.::
>  7. Testing
>  ==========
>  
> -Kernel bpf selftest `test_btf.c` provides extensive set of BTF-related tests.
> +The kernel bpf selftest `tools/testing/selftests/bpf/prog_tests/btf.c`_

s/bpf/BPF

> +provides an extensive set of BTF-related tests.
> +
> +.. Links
> +.. _tools/testing/selftests/bpf/prog_tests/btf.c:
> +   https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/tools/testing/selftests/bpf/prog_tests/btf.c
> -- 
> 2.38.1
>
  
Rong Tao Nov. 22, 2022, 12:54 a.m. UTC | #2
Thanks, David. I forgot to modify the case of the BPF, be sure to check
carefully next time, thanks.

Fix this problem in v4:
  https://lore.kernel.org/lkml/tencent_1FA6904156E8E599CAE4ABDBE80F22830106@qq.com/
  

Patch

diff --git a/Documentation/bpf/btf.rst b/Documentation/bpf/btf.rst
index cf8722f96090..681416c86e81 100644
--- a/Documentation/bpf/btf.rst
+++ b/Documentation/bpf/btf.rst
@@ -1062,4 +1062,9 @@  format.::
 7. Testing
 ==========
 
-Kernel bpf selftest `test_btf.c` provides extensive set of BTF-related tests.
+The kernel bpf selftest `tools/testing/selftests/bpf/prog_tests/btf.c`_
+provides an extensive set of BTF-related tests.
+
+.. Links
+.. _tools/testing/selftests/bpf/prog_tests/btf.c:
+   https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/tools/testing/selftests/bpf/prog_tests/btf.c