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 <pkrempa@xxxxxxxxxx>
---
docs/compiling.rst | 21 ++++++++++++++++++++-
1 file changed, 20 insertions(+), 1 deletion(-)
diff --git a/docs/compiling.rst b/docs/compiling.rst
index 1969b9b0b0..1d06136ca6 100644
--- a/docs/compiling.rst
+++ b/docs/compiling.rst
@@ -81,11 +81,30 @@ 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.
-**Note:** Please ensure that you have the appropriate minimal ``meson`` version
+Please also ensure that you have the appropriate minimal ``meson`` version
installed in your build environment. The minimal version for a specific package
can be checked in the top level ``meson.build`` file in the ``meson_version``
field.
--
2.37.1
