From 41668f0d58b47fffd048b35fbdf5f87bf4424f52 Mon Sep 17 00:00:00 2001 From: Douglas Raillard Date: Tue, 15 Aug 2023 10:29:22 +0100 Subject: [PATCH] doc/setup.rst: Add a note on kernel module build prerequisite. Since having build dependencies missing can lead to non-obvious issues, add the requirement to the documentation. --- doc/setup.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/setup.rst b/doc/setup.rst index f828e5243..15a10c777 100644 --- a/doc/setup.rst +++ b/doc/setup.rst @@ -266,6 +266,12 @@ way to configure LISA for building the module is: # system depending on config), this should do the trick. # overlay-backend: copy +.. note:: If ``build-env: host`` is used (default), ensure that your setup is + ready to compile a kernel. Notably, ensure that you have kernel build + dependencies installed. This can be achieved with + ``install_base.sh --install-kernel-build-dependencies`` (included in + ``--install-all``) + Automatic route ............... -- GitLab