From 4cb0cdd7ff62ac1c6e5305c24efa9911475b564d Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Fri, 9 Sep 2022 15:45:47 +0200 Subject: [PATCH] docs: compiling: Encourage force-enabling required functionality MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit To prevent surprises when a build doesn't in fact contain the required functionality suggest that users force-enable required modules. Signed-off-by: Peter Krempa Reviewed-by: Ján Tomko --- docs/compiling.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/compiling.rst b/docs/compiling.rst index e9d055914f..8560d4ba7a 100644 --- a/docs/compiling.rst +++ b/docs/compiling.rst @@ -81,6 +81,25 @@ normal OS vendor prefixes, use $ meson build -Dsystem=true +Explicitly enabling required functionality +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +By default each module of functionality of libvirtd is optionally enabled, +meaning it will be enabled if the build environment contains the required +dependencies. + +To ensure that your build contains the required functionality it's recommended +to explicitly enable given modules, in which case the configure step will end +with an error if dependencies are not present. **Example:** to build the +libvirt project with support for the **qemu** driver use the following options: + +:: + + $ meson build -Dsystem=true -Ddriver_qemu=enabled + +Notes: +~~~~~~ + By default when the ``meson`` is run from within a GIT checkout, it will turn on -Werror for builds. This can be disabled with --werror=false, but this is not recommended. -- 2.39.5