Skip to contentSkip to conversation

selftests/bpf: Document vmtest dependencies

PATCH In review Evgeniy Litvinenko 2 participants 2 messages Jul 23, 2021 – Jul 24, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 selftests/bpf: Document vmtest dependencies

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

---
 tools/testing/selftests/bpf/README.rst | 7 +++++++
 1 file changed, 7 insertions(+)
tools/testing/selftests/bpf/README.rst +7 -0
index 8deec1ca9150..e47786e93159 100644
@@ -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
Signature · 1 line
2.30.2
#1 lore raw
Quoted 6 lines · 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).

---

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!

Quoted 24 lines
 tools/testing/selftests/bpf/README.rst | 7 +++++++
 1 file changed, 7 insertions(+)
tools/testing/selftests/bpf/README.rst +7 -1
index 8deec1ca9150..e47786e93159 100644
@@ -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