[PATCH bpf-next] selftests/bpf: Document vmtest dependencies

[PATCH bpf-next] selftests/bpf: Document vmtest dependencies

[Evgeniy Litvinenko]

Add a list of vmtest script dependencies to make it easier for new
contributors to get going (I discovered those by trial and error).

Signed-off-by: Evgeniy Litvinenko <evgeniyl@fb.com>
---
 tools/testing/selftests/bpf/README.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/tools/testing/selftests/bpf/README.rst b/tools/testing/selftests/bpf/README.rst
index 8deec1ca9150..e47786e93159 100644
--- a/tools/testing/selftests/bpf/README.rst
+++ b/tools/testing/selftests/bpf/README.rst
@@ -19,6 +19,13 @@ the CI. It builds the kernel (without overwriting your existing Kconfig), recomp
 bpf selftests, runs them (by default ``tools/testing/selftests/bpf/test_progs``) and
 saves the resulting output (by default in ``~/.bpf_selftests``).
 
+Script dependencies:
+- clang
+- qemu
+- pahole
+- docutils (for ``rst2man``)
+- libcap-devel
+
 For more information on about using the script, run:
 
 .. code-block:: console
-- 
2.30.2

Re: [PATCH bpf-next] selftests/bpf: Document vmtest dependencies

[Andrii Nakryiko]

On Fri, Jul 23, 2021 at 3:37 PM Evgeniy Litvinenko <evgeniyl@fb.com> wrote:
>
> Add a list of vmtest script dependencies to make it easier for new
> contributors to get going (I discovered those by trial and error).
>
> Signed-off-by: Evgeniy Litvinenko <evgeniyl@fb.com>
> ---

I've also added links to clang and pahole source code and adjusted
punctuation and the commit message a bit. Pushed to bpf-next, thanks!

>  tools/testing/selftests/bpf/README.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/tools/testing/selftests/bpf/README.rst b/tools/testing/selftests/bpf/README.rst
> index 8deec1ca9150..e47786e93159 100644
> --- a/tools/testing/selftests/bpf/README.rst
> +++ b/tools/testing/selftests/bpf/README.rst
> @@ -19,6 +19,13 @@ the CI. It builds the kernel (without overwriting your existing Kconfig), recomp
>  bpf selftests, runs them (by default ``tools/testing/selftests/bpf/test_progs``) and
>  saves the resulting output (by default in ``~/.bpf_selftests``).
>
> +Script dependencies:
> +- clang
> +- qemu
> +- pahole
> +- docutils (for ``rst2man``)
> +- libcap-devel
> +
>  For more information on about using the script, run:
>
>  .. code-block:: console
> --
> 2.30.2
>