[PATCH v2] samples/bpf: Add more instructions to build dependencies and, configuration in README.rst

From: Anh Tuan Phan <tuananhlfc@gmail.com>
To: bpf@vger.kernel.org, ast@kernel.org, daniel@iogearbox.net,
	andrii@kernel.org, martin.lau@linux.dev,
	linux-kernel-mentees@lists.linuxfoundation.org
Subject: [PATCH v2] samples/bpf: Add more instructions to build dependencies and, configuration in README.rst
Date: Thu, 6 Jul 2023 23:00:06 +0700	[thread overview]
Message-ID: <bd1477f2-a51e-a795-4f25-a32d6ab46530@gmail.com> (raw)

Update the Documentation to mention that some samples require pahole
v1.16 and kernel built with CONFIG_DEBUG_INFO_BTF=y

Signed-off-by: Anh Tuan Phan <tuananhlfc@gmail.com>
---
 samples/bpf/README.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/samples/bpf/README.rst b/samples/bpf/README.rst
index 57f93edd1957..631592b83d60 100644
--- a/samples/bpf/README.rst
+++ b/samples/bpf/README.rst
@@ -14,6 +14,9 @@ Compiling requires having installed:
 Note that LLVM's tool 'llc' must support target 'bpf', list version
 and supported targets with command: ``llc --version``

+Some samples require pahole version 1.16 as a dependency. See
+https://docs.kernel.org/bpf/bpf_devel_QA.html for reference.
+
 Clean and configuration
 -----------------------

@@ -28,6 +31,10 @@ Configure kernel, defconfig for instance::

  make defconfig

+Some samples require support for BPF Type Format (BTF). To enable it,
open the
+generated config file, or use menuconfig (by "make menuconfig") to
enable the
+following configs: CONFIG_BPF_SYSCALL and CONFIG_DEBUG_INFO_BTF.
+
 Kernel headers
 --------------

-- 
2.34.1
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
