From f3f4f0fb8342a72bbb9da0797e7c259e9bad8cba Mon Sep 17 00:00:00 2001 From: Karol Herbst Date: Tue, 17 Sep 2024 11:17:11 +0200 Subject: [PATCH] docs: document gallium-rusticl-enable-drivers Reviewed-by: David Heidelberg Acked-by: Eric Engestrom Reviewed-by: Alyssa Rosenzweig Part-of: --- docs/rusticl.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/rusticl.rst b/docs/rusticl.rst index 1697780dd5a..99475b72acc 100644 --- a/docs/rusticl.rst +++ b/docs/rusticl.rst @@ -11,6 +11,23 @@ In order to use Rusticl on any platform the environment variable for any driver by default yet as doing so can impact system stability until remaining core issues are ironed out. +Enabling drivers by default +--------------------------- + +Distributions and everybody building rusticl themselves can opt-in or opt-out +certain drivers from being enabled by default. The +``gallium-rusticl-enable-drivers`` takes a list of drivers to enable by +default. The environment variable :envvar:`RUSTICL_ENABLE` will overwrite this +list at runtime. + +Not all drivers are supported to be enabled by default, because that should +require opt-in by the driver maintainers. Check out the meson option +documentation to see for which drivers this option is supported. + +The ``auto`` option might not enable all drivers supported by this flag, but +for distribution it's recommended to use that one unless they get an ack from +driver maintainers to expand the list. + Building --------