From 444f5eb4c8f54323c9f98db79844906ba8bc9cdc Mon Sep 17 00:00:00 2001 From: Chris P Date: Wed, 3 Apr 2024 05:34:36 -0400 Subject: [PATCH] doc: Add information about rapid hotplug detection This commit appends information about the WLR_RAPID_HOTPLUG_PREVENT enviroment variable from the previous commit to the documentation page on envrionment variables, namely what its purpose is and that the user should be aware of a delay in the event that a rapid hotplug occurs. --- docs/env_vars.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/env_vars.md b/docs/env_vars.md index e36cdc781..c371ebd64 100644 --- a/docs/env_vars.md +++ b/docs/env_vars.md @@ -14,6 +14,10 @@ wlroots reads these environment variables hardware-accelerated renderers. * *WLR_EGL_NO_MODIFIERS*: set to 1 to disable format modifiers in EGL, this can be used to understand and work around driver bugs. +* *WLR_RAPID_HOTPLUG_PREVENT*: set to 1 to wait after an output device hotplug + in case another occurs immediately after, and if so, ignore both. This is to + work around monitors that implement DisplayPort's "deep sleep" feature, but + causes a second delay for each change event due to waiting. ## DRM backend